michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve Package Detection (#8306)

Browse source
This commit is contained in:
Jacob Lamb 2023-09-06 02:15:10 -07:00 committed by GitHub
parent eb8c4cc2fc
commit d2f2a11cdb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 60 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.changeset/friendly-clocks-act.md Normal file
View file

@ -0,0 +1,6 @@
---
'create-astro': patch
'astro': patch
---
Support detecting Bun when logging messages with package manager information.

4
packages/astro/package.json
View file

@ -156,7 +156,7 @@
"ora": "^7.0.1",
"p-limit": "^4.0.0",
"path-to-regexp": "^6.2.1",
"preferred-pm": "^3.0.3",
"preferred-pm": "^3.1.2",
"prompts": "^2.4.2",
"rehype": "^12.0.1",
"resolve": "^1.22.4",
@ -172,7 +172,7 @@
"vfile": "^5.3.7",
"vite": "^4.4.9",
"vitefu": "^0.2.4",
"which-pm": "^2.0.0",
"which-pm": "^2.1.1",
"yargs-parser": "^21.1.1",
"zod": "3.21.1"
},

2
packages/astro/src/cli/add/index.ts
View file

@ -620,6 +620,8 @@ async function getInstallIntegrationsCommand({
return { pm: 'yarn', command: 'add', flags: [], dependencies };
case 'pnpm':
return { pm: 'pnpm', command: 'add', flags: [], dependencies };
case 'bun':
return { pm: 'bun', command: 'add', flags: [], dependencies };
default:
return null;
}

2
packages/astro/src/cli/install-package.ts
View file

@ -67,6 +67,8 @@ function getInstallCommand(packages: string[], packageManager: string) {
return { pm: 'yarn', command: 'add', flags: [], dependencies: packages };
case 'pnpm':
return { pm: 'pnpm', command: 'add', flags: [], dependencies: packages };
case 'bun':
return { pm: 'bun', command: 'add', flags: [], dependencies: packages };
default:
return null;
}

5
packages/astro/src/cli/telemetry/index.ts
View file

@ -2,14 +2,17 @@
import type yargs from 'yargs-parser';
import * as msg from '../../core/messages.js';
import { telemetry } from '../../events/index.js';
import whichPm from 'which-pm';
interface TelemetryOptions {
flags: yargs.Arguments;
}
export async function notify() {
const packageManager = (await whichPm(process.cwd())).name ?? 'npm';
await telemetry.notify(() => {
console.log(msg.telemetryNotice() + '\n');
console.log(msg.telemetryNotice(packageManager) + '\n');
return true;
});
}

4
packages/astro/src/core/messages.ts
View file

@ -105,10 +105,10 @@ export function serverStart({
.join('\n');
}
export function telemetryNotice() {
export function telemetryNotice(packageManager = 'npm') {
const headline = `${cyan('◆')} Astro collects completely anonymous usage data.`;
const why = dim(' This optional program helps shape our roadmap.');
const disable = dim(' Run `npm run astro telemetry disable` to opt-out.');
const disable = dim(` Run \`${packageManager} run astro telemetry disable\` to opt-out.`);
const details = ` Details: ${underline('https://astro.build/telemetry')}`;
return [headline, why, disable, details].map((v) => ' ' + v).join('\n');
}

6
packages/create-astro/src/actions/context.ts
View file

@ -9,7 +9,7 @@ export interface Context {
help: boolean;
prompt: typeof prompt;
cwd: string;
pkgManager: string;
packageManager: string;
username: string;
version: string;
skipHouston: boolean;
@ -51,7 +51,7 @@ export async function getContext(argv: string[]): Promise<Context> {
{ argv, permissive: true }
);
const pkgManager = detectPackageManager()?.name ?? 'npm';
const packageManager = detectPackageManager()?.name ?? 'npm';
const [username, version] = await Promise.all([getName(), getVersion()]);
let cwd = flags['_'][0];
let {
@ -85,7 +85,7 @@ export async function getContext(argv: string[]): Promise<Context> {
const context: Context = {
help,
prompt,
pkgManager,
packageManager,
username,
version,
skipHouston,

14
packages/create-astro/src/actions/dependencies.ts
View file

@ -6,7 +6,7 @@ import { shell } from '../shell.js';
import type { Context } from './context';
export async function dependencies(
ctx: Pick<Context, 'install' | 'yes' | 'prompt' | 'pkgManager' | 'cwd' | 'dryRun'>
ctx: Pick<Context, 'install' | 'yes' | 'prompt' | 'packageManager' | 'cwd' | 'dryRun'>
) {
let deps = ctx.install ?? ctx.yes;
if (deps === undefined) {
@ -25,15 +25,15 @@ export async function dependencies(
await info('--dry-run', `Skipping dependency installation`);
} else if (deps) {
await spinner({
start: `Installing dependencies with ${ctx.pkgManager}...`,
start: `Installing dependencies with ${ctx.packageManager}...`,
end: 'Dependencies installed',
while: () => {
return install({ pkgManager: ctx.pkgManager, cwd: ctx.cwd }).catch((e) => {
return install({ packageManager: ctx.packageManager, cwd: ctx.cwd }).catch((e) => {
error('error', e);
error(
'error',
`Dependencies failed to install, please run ${color.bold(
ctx.pkgManager + ' install'
ctx.packageManager + ' install'
)} to install them manually after setup.`
);
});
@ -47,9 +47,9 @@ export async function dependencies(
}
}
async function install({ pkgManager, cwd }: { pkgManager: string; cwd: string }) {
if (pkgManager === 'yarn') await ensureYarnLock({ cwd });
return shell(pkgManager, ['install'], { cwd, timeout: 90_000, stdio: 'ignore' });
async function install({ packageManager, cwd }: { packageManager: string; cwd: string }) {
if (packageManager === 'yarn') await ensureYarnLock({ cwd });
return shell(packageManager, ['install'], { cwd, timeout: 90_000, stdio: 'ignore' });
}
async function ensureYarnLock({ cwd }: { cwd: string }) {

17
packages/create-astro/src/actions/next-steps.ts
View file

@ -3,14 +3,17 @@ import type { Context } from './context';
import { nextSteps, say } from '../messages.js';
export async function next(ctx: Pick<Context, 'cwd' | 'pkgManager' | 'skipHouston'>) {
export async function next(ctx: Pick<Context, 'cwd' | 'packageManager' | 'skipHouston'>) {
let projectDir = path.relative(process.cwd(), ctx.cwd);
const devCmd =
ctx.pkgManager === 'npm'
? 'npm run dev'
: ctx.pkgManager === 'bun'
? 'bun run dev'
: `${ctx.pkgManager} dev`;
const commandMap: { [key: string]: string } = {
npm: 'npm run dev',
bun: 'bun run dev',
yarn: 'yarn dev',
pnpm: 'pnpm dev',
};
const devCmd = commandMap[ctx.packageManager as keyof typeof commandMap] || 'npm run dev';
await nextSteps({ projectDir, devCmd });
if (!ctx.skipHouston) {

10
packages/create-astro/test/dependencies.test.js
View file

@ -10,7 +10,7 @@ describe('dependencies', () => {
const context = {
cwd: '',
yes: true,
pkgManager: 'npm',
packageManager: 'npm',
dryRun: true,
prompt: () => ({ deps: true }),
};
@ -21,7 +21,7 @@ describe('dependencies', () => {
it('prompt yes', async () => {
const context = {
cwd: '',
pkgManager: 'npm',
packageManager: 'npm',
dryRun: true,
prompt: () => ({ deps: true }),
install: undefined,
@ -34,7 +34,7 @@ describe('dependencies', () => {
it('prompt no', async () => {
const context = {
cwd: '',
pkgManager: 'npm',
packageManager: 'npm',
dryRun: true,
prompt: () => ({ deps: false }),
install: undefined,
@ -48,7 +48,7 @@ describe('dependencies', () => {
const context = {
cwd: '',
install: true,
pkgManager: 'npm',
packageManager: 'npm',
dryRun: true,
prompt: () => ({ deps: false }),
};
@ -61,7 +61,7 @@ describe('dependencies', () => {
const context = {
cwd: '',
install: false,
pkgManager: 'npm',
packageManager: 'npm',
dryRun: true,
prompt: () => ({ deps: false }),
};

4
packages/create-astro/test/next.test.js
View file

@ -7,14 +7,14 @@ describe('next steps', () => {
const fixture = setup();
it('no arguments', async () => {
await next({ skipHouston: false, cwd: './it/fixtures/not-empty', pkgManager: 'npm' });
await next({ skipHouston: false, cwd: './it/fixtures/not-empty', packageManager: 'npm' });
expect(fixture.hasMessage('Liftoff confirmed.')).to.be.true;
expect(fixture.hasMessage('npm run dev')).to.be.true;
expect(fixture.hasMessage('Good luck out there, astronaut!')).to.be.true;
});
it('--skip-houston', async () => {
await next({ skipHouston: true, cwd: './it/fixtures/not-empty', pkgManager: 'npm' });
await next({ skipHouston: true, cwd: './it/fixtures/not-empty', packageManager: 'npm' });
expect(fixture.hasMessage('Good luck out there, astronaut!')).to.be.false;
});
});

22
pnpm-lock.yaml
View file

@ -594,8 +594,8 @@ importers:
specifier: ^6.2.1
version: 6.2.1
preferred-pm:
specifier: ^3.0.3
version: 3.0.3
specifier: ^3.1.2
version: 3.1.2
prompts:
specifier: ^2.4.2
version: 2.4.2
@ -642,8 +642,8 @@ importers:
specifier: ^0.2.4
version: 0.2.4(vite@4.4.9)
which-pm:
specifier: ^2.0.0
version: 2.0.0
specifier: ^2.1.1
version: 2.1.1
yargs-parser:
specifier: ^21.1.1
version: 21.1.1
@ -6816,7 +6816,7 @@ packages:
meow: 6.1.1
outdent: 0.5.0
p-limit: 2.3.0
preferred-pm: 3.0.3
preferred-pm: 3.1.2
resolve-from: 5.0.0
semver: 7.5.4
spawndamnit: 2.0.0
@ -15166,8 +15166,8 @@ packages:
tar-fs: 2.1.1
tunnel-agent: 0.6.0
/preferred-pm@3.0.3:
resolution: {integrity: sha512-+wZgbxNES/KlJs9q40F/1sfOd/j7f1O9JaHcW5Dsn3aUUOZg3L2bjpVUcKV2jvtElYfoTuQiNeMfQJ4kwUAhCQ==}
/preferred-pm@3.1.2:
resolution: {integrity: sha512-nk7dKrcW8hfCZ4H6klWcdRknBOXWzNQByJ0oJyX97BOupsYD+FzLS4hflgEu/uPUEHZCuRfMxzCBsuWd7OzT8Q==}
engines: {node: '>=10'}
dependencies:
find-up: 5.0.0
@ -17860,6 +17860,14 @@ packages:
load-yaml-file: 0.2.0
path-exists: 4.0.0
/which-pm@2.1.1:
resolution: {integrity: sha512-xzzxNw2wMaoCWXiGE8IJ9wuPMU+EYhFksjHxrRT8kMT5SnocBPRg69YAMtyV4D12fP582RA+k3P8H9J5EMdIxQ==}
engines: {node: '>=8.15'}
dependencies:
load-yaml-file: 0.2.0
path-exists: 4.0.0
dev: false
/which-typed-array@1.1.11:
resolution: {integrity: sha512-qe9UWWpkeG5yzZ0tNYxDmd7vo58HDBc39mZ0xWWpolAGADdFOzkfamWLDxkOWcvHQKVmdTyQdLD4NOfjLWTKew==}
engines: {node: '>= 0.4'}