-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* refactor: new version of create-astro * chore: update README * fix(create-astro): update project name logic * test(create-astro): fix test on windows * test(create-astro): fix test on windows * test(create-astro): remove unused import * chore: remove log * chore: increase test timeout * fix: message when skipping * fix: message for env.d.ts file * fix: always hard exit * fix: return from next-steps * chore: add message * refactor dependencies, bundle create-astro * chore: disable create-astro typings * chore: switch to arg * chore: update message * fix: split typescript into two steps, fix context test * chore: update wording * chore: update wording * Update packages/create-astro/src/actions/dependencies.ts Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com> * refactor: move tests back to mocha/chai * chore: update cli-kit * update test script * chore: add comment about setStdout * chore: update cli-kit * Update packages/create-astro/src/messages.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update packages/create-astro/src/messages.ts Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * chore: update lockfile * fix(create-astro): support scoped package names, improve project-name tests * better git initialization * update cli-kit --------- Co-authored-by: Nate Moore <nate@astro.build> Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
- Loading branch information
4 people
committed
Feb 6, 2023
1 parent
91dc0f4
commit 8d2187d
Showing
41 changed files
with
1,234 additions
and
1,328 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| 'create-astro': major | ||
| --- | ||
|
|
||
| Redesigned `create-astro` experience |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule grubby-group
added at
9a401d
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| import os from 'node:os'; | ||
| import arg from 'arg'; | ||
| import detectPackageManager from 'which-pm-runs'; | ||
| import { prompt } from '@astrojs/cli-kit'; | ||
|
|
||
| import { getName, getVersion } from '../messages.js'; | ||
|
|
||
| export interface Context { | ||
| help: boolean; | ||
| prompt: typeof prompt; | ||
| cwd: string; | ||
| pkgManager: string; | ||
| username: string; | ||
| version: string; | ||
| skipHouston: boolean; | ||
| dryRun?: boolean; | ||
| yes?: boolean; | ||
| projectName?: string; | ||
| template?: string; | ||
| ref: string; | ||
| install?: boolean; | ||
| git?: boolean; | ||
| typescript?: string; | ||
| stdin?: typeof process.stdin; | ||
| stdout?: typeof process.stdout; | ||
| exit(code: number): never; | ||
| } | ||
|
|
||
|
|
||
| export async function getContext(argv: string[]): Promise<Context> { | ||
| const flags = arg({ | ||
| '--template': String, | ||
| '--ref': String, | ||
| '--yes': Boolean, | ||
| '--no': Boolean, | ||
| '--install': Boolean, | ||
| '--no-install': Boolean, | ||
| '--git': Boolean, | ||
| '--no-git': Boolean, | ||
| '--typescript': String, | ||
| '--skip-houston': Boolean, | ||
| '--dry-run': Boolean, | ||
| '--help': Boolean, | ||
| '--fancy': Boolean, | ||
|
|
||
| '-y': '--yes', | ||
| '-n': '--no', | ||
| '-h': '--help', | ||
| }, { argv, permissive: true }); | ||
|
|
||
| const pkgManager = detectPackageManager()?.name ?? 'npm'; | ||
| const [username, version] = await Promise.all([getName(), getVersion()]); | ||
| let cwd = flags['_'][0] as string; | ||
| let { | ||
| '--help': help = false, | ||
| '--template': template, | ||
| '--no': no, | ||
| '--yes': yes, | ||
| '--install': install, | ||
| '--no-install': noInstall, | ||
| '--git': git, | ||
| '--no-git': noGit, | ||
| '--typescript': typescript, | ||
| '--fancy': fancy, | ||
| '--skip-houston': skipHouston, | ||
| '--dry-run': dryRun, | ||
| '--ref': ref, | ||
| } = flags; | ||
| let projectName = cwd; | ||
|
|
||
| if (no) { | ||
| yes = false; | ||
| if (install == undefined) install = false; | ||
| if (git == undefined) git = false; | ||
| if (typescript == undefined) typescript = 'strict'; | ||
| } | ||
|
|
||
| skipHouston = ((os.platform() === 'win32' && !fancy) || skipHouston) ?? [yes, no, install, git, typescript].some((v) => v !== undefined); | ||
|
|
||
| const context: Context = { | ||
| help, | ||
| prompt, | ||
| pkgManager, | ||
| username, | ||
| version, | ||
| skipHouston, | ||
| dryRun, | ||
| projectName, | ||
| template, | ||
| ref: ref ?? 'latest', | ||
| yes, | ||
| install: install ?? (noInstall ? false : undefined), | ||
| git: git ?? (noGit ? false : undefined), | ||
| typescript, | ||
| cwd, | ||
| exit(code) { | ||
| process.exit(code); | ||
| } | ||
| } | ||
| return context; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import type { Context } from "./context"; | ||
|
|
||
| import { title, info, spinner } from '../messages.js'; | ||
| import { execa } from 'execa'; | ||
|
|
||
| export async function dependencies(ctx: Pick<Context, 'install'|'yes'|'prompt'|'pkgManager'|'cwd'|'dryRun'>) { | ||
| let deps = ctx.install ?? ctx.yes; | ||
| if (deps === undefined) { | ||
| ({ deps } = await ctx.prompt({ | ||
| name: 'deps', | ||
| type: 'confirm', | ||
| label: title('deps'), | ||
| message: `Install dependencies?`, | ||
| hint: 'recommended', | ||
| initial: true, | ||
| })); | ||
| ctx.install = deps; | ||
| } | ||
|
|
||
| if (ctx.dryRun) { | ||
| await info('--dry-run', `Skipping dependency installation`); | ||
| } else if (deps) { | ||
| await spinner({ | ||
| start: `Dependencies installing with ${ctx.pkgManager}...`, | ||
| end: 'Dependencies installed', | ||
| while: () => install({ pkgManager: ctx.pkgManager, cwd: ctx.cwd }), | ||
| }); | ||
| } else { | ||
| await info( | ||
| ctx.yes === false ? 'deps [skip]' : 'No problem!', | ||
| 'Remember to install dependencies after setup.' | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| async function install({ pkgManager, cwd }: { pkgManager: string, cwd: string }) { | ||
| const installExec = execa(pkgManager, ['install'], { cwd }); | ||
| return new Promise<void>((resolve, reject) => { | ||
| installExec.on('error', (error) => reject(error)); | ||
| installExec.on('close', () => resolve()); | ||
| }); | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import type { Context } from "./context"; | ||
| import fs from 'node:fs'; | ||
| import path from 'node:path'; | ||
|
|
||
| import { color } from '@astrojs/cli-kit'; | ||
| import { title, info, spinner } from '../messages.js'; | ||
| import { execa } from 'execa'; | ||
|
|
||
| export async function git(ctx: Pick<Context, 'cwd'|'git'|'yes'|'prompt'|'dryRun'>) { | ||
| if (fs.existsSync(path.join(ctx.cwd, '.git'))) { | ||
| await info('Nice!', `Git has already been initialized`); | ||
| return | ||
| } | ||
| let _git = ctx.git ?? ctx.yes; | ||
| if (_git === undefined) { | ||
| ({ git: _git } = await ctx.prompt({ | ||
| name: 'git', | ||
| type: 'confirm', | ||
| label: title('git'), | ||
| message: `Initialize a new git repository?`, | ||
| hint: 'optional', | ||
| initial: true, | ||
| })); | ||
| } | ||
|
|
||
| if (ctx.dryRun) { | ||
| await info('--dry-run', `Skipping Git initialization`); | ||
| } else if (_git) { | ||
| await spinner({ | ||
| start: 'Git initializing...', | ||
| end: 'Git initialized', | ||
| while: () => init({ cwd: ctx.cwd }), | ||
| }); | ||
| } else { | ||
| await info( | ||
| ctx.yes === false ? 'git [skip]' : 'Sounds good!', | ||
| `You can always run ${color.reset('git init')}${color.dim(' manually.')}` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| async function init({ cwd }: { cwd: string }) { | ||
| try { | ||
| await execa('git', ['init'], { cwd, stdio: 'ignore' }); | ||
| await execa('git', ['add', '-A'], { cwd, stdio: 'ignore' }); | ||
| await execa('git', ['commit', '-m', 'Initial commit from Astro', '--author="houston[bot] <astrobot-houston@users.noreply.github.com>"'], { cwd, stdio: 'ignore' }); | ||
| } catch (e) {} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { printHelp } from '../messages.js'; | ||
|
|
||
| export function help() { | ||
| printHelp({ | ||
| commandName: 'create-astro', | ||
| usage: '[dir] [...flags]', | ||
| headline: 'Scaffold Astro projects.', | ||
| tables: { | ||
| Flags: [ | ||
| ['--template <name>', 'Specify your template.'], | ||
| ['--install / --no-install', 'Install dependencies (or not).'], | ||
| ['--git / --no-git', 'Initialize git repo (or not).'], | ||
| ['--yes (-y)', 'Skip all prompt by accepting defaults.'], | ||
| ['--no (-n)', 'Skip all prompt by declining defaults.'], | ||
| ['--dry-run', 'Walk through steps without executing.'], | ||
| ['--skip-houston', 'Skip Houston animation.'], | ||
| ], | ||
| }, | ||
| }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { type Context } from './context'; | ||
|
|
||
| import { banner, welcome, say } from '../messages.js'; | ||
| import { label, color } from '@astrojs/cli-kit'; | ||
| import { random } from '@astrojs/cli-kit/utils'; | ||
|
|
||
| export async function intro(ctx: Pick<Context, 'skipHouston'|'version'|'username'>) { | ||
| if (!ctx.skipHouston) { | ||
| await say([ | ||
| [ | ||
| 'Welcome', | ||
| 'to', | ||
| label('astro', color.bgGreen, color.black), | ||
| color.green(`v${ctx.version}`) + ',', | ||
| `${ctx.username}!`, | ||
| ], | ||
| random(welcome), | ||
| ]); | ||
| await banner(ctx.version); | ||
| } else { | ||
| await banner(ctx.version); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { Context } from "./context"; | ||
| import path from 'node:path'; | ||
|
|
||
| import { nextSteps, say } from '../messages.js'; | ||
|
|
||
| export async function next(ctx: Pick<Context, 'cwd'|'pkgManager'|'skipHouston'>) { | ||
| let projectDir = path.relative(process.cwd(), ctx.cwd); | ||
| const devCmd = ctx.pkgManager === 'npm' ? 'npm run dev' : `${ctx.pkgManager} dev`; | ||
| await nextSteps({ projectDir, devCmd }); | ||
|
|
||
| if (!ctx.skipHouston) { | ||
| await say(['Good luck out there, astronaut! 🚀']); | ||
| } | ||
| return; | ||
| } |
Oops, something went wrong.