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

Refine CLI flag descriptions for clarity (#8545)

Browse source 
* Refine CLI flag descriptions for clarity

* Update README.md

* Update README.md

* Update README.md

* Update help.ts

* Update packages/create-astro/src/actions/help.ts

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* Update packages/create-astro/README.md

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* Update packages/create-astro/README.md

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* Update README.md

---------

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
This commit is contained in:
Jacob Lamb 2023-09-22 14:00:38 -07:00 committed by GitHub
parent 4f2bf2156f
commit 139b0f54d9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
packages/create-astro/README.md
View file

@ -45,16 +45,19 @@ npm create astro@latest my-astro-project -- --template cassidoo/shopify-react-as
May be provided in place of prompts May be provided in place of prompts
| Name | Description | | Name | Description |
| :--------------------------- | :----------------------------------------------------- | | :--------------------------- | :--------------------------------------------------------- |
| `--template <name>` | Specify your template. | | `--help` (`-h`) | Display available flags. |
| `--install` / `--no-install` | Install dependencies (or not). | | `--template <name>` | Specify your template. |
| `--git` / `--no-git` | Initialize git repo (or not). | | `--install` / `--no-install` | Install dependencies (or not). |
| `--yes` (`-y`) | Skip all prompt by accepting defaults. | | `--git` / `--no-git` | Initialize git repo (or not). |
| `--no` (`-n`) | Skip all prompt by declining defaults. | | `--yes` (`-y`) | Skip all prompts by accepting defaults. |
| `--dry-run` | Walk through steps without executing. | | `--no` (`-n`) | Skip all prompts by declining defaults. |
| `--skip-houston` | Skip Houston animation. | | `--dry-run` | Walk through steps without executing. |
| `--typescript <option>` | TypeScript option: `strict` / `strictest` / `relaxed`. | | `--skip-houston` | Skip Houston animation. |
| `--ref` | Specify an Astro branch (default: latest). |
| `--fancy` | Enable full Unicode support for Windows. |
| `--typescript <option>` | TypeScript option: `strict` / `strictest` / `relaxed`. |
[examples]: https://github.com/withastro/astro/tree/main/examples [examples]: https://github.com/withastro/astro/tree/main/examples
[typescript]: https://github.com/withastro/astro/tree/main/packages/astro/tsconfigs [typescript]: https://github.com/withastro/astro/tree/main/packages/astro/tsconfigs

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

@ -11,12 +11,12 @@ export function help() {
['--template <name>', 'Specify your template.'], ['--template <name>', 'Specify your template.'],
['--install / --no-install', 'Install dependencies (or not).'], ['--install / --no-install', 'Install dependencies (or not).'],
['--git / --no-git', 'Initialize git repo (or not).'], ['--git / --no-git', 'Initialize git repo (or not).'],
['--yes (-y)', 'Skip all prompt by accepting defaults.'], ['--yes (-y)', 'Skip all prompts by accepting defaults.'],
['--no (-n)', 'Skip all prompt by declining defaults.'], ['--no (-n)', 'Skip all prompts by declining defaults.'],
['--dry-run', 'Walk through steps without executing.'], ['--dry-run', 'Walk through steps without executing.'],
['--skip-houston', 'Skip Houston animation.'], ['--skip-houston', 'Skip Houston animation.'],
['--ref', 'Choose astro branch (default: latest).'], ['--ref', 'Choose astro branch (default: latest).'],
['--fancy', 'Enable full unicode support for Windows.'], ['--fancy', 'Enable full Unicode support for Windows.'],
['--typescript <option>', 'TypeScript option: strict | strictest | relaxed.'], ['--typescript <option>', 'TypeScript option: strict | strictest | relaxed.'],
], ],
}, },