diff options
| author |  Jacob Lamb <jacobtlamb@hey.com>
| 2023-09-22 14:00:38 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-09-22 16:00:38 -0500 |
| commit | 139b0f54d9ad92059c4bca55a08c70c3c563a4e7 (patch) | |
| tree | 9ba32665069023622df702321072ccce56e2f72e | |
| parent | 4f2bf2156f3fa1508d61f0b3f4a6f25399d0bd4e (diff) | |
| download | astro-139b0f54d9ad92059c4bca55a08c70c3c563a4e7.tar.gz astro-139b0f54d9ad92059c4bca55a08c70c3c563a4e7.tar.zst astro-139b0f54d9ad92059c4bca55a08c70c3c563a4e7.zip | |
Refine CLI flag descriptions for clarity (#8545)
* 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>
Diffstat (limited to '')
| -rw-r--r-- | packages/create-astro/README.md | 23 | ||||
| -rw-r--r-- | packages/create-astro/src/actions/help.ts | 6 |
2 files changed, 16 insertions, 13 deletions
diff --git a/packages/create-astro/README.md b/packages/create-astro/README.md index ba406d942..0f9fbde5a 100644 --- a/packages/create-astro/README.md +++ b/packages/create-astro/README.md @@ -45,16 +45,19 @@ npm create astro@latest my-astro-project -- --template cassidoo/shopify-react-as May be provided in place of prompts -| Name | Description | -| :--------------------------- | :----------------------------------------------------- | -| `--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. | -| `--typescript <option>` | TypeScript option: `strict` / `strictest` / `relaxed`. | +| Name | Description | +| :--------------------------- | :--------------------------------------------------------- | +| `--help` (`-h`) | Display available 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 prompts by accepting defaults. | +| `--no` (`-n`) | Skip all prompts by declining defaults. | +| `--dry-run` | Walk through steps without executing. | +| `--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 [typescript]: https://github.com/withastro/astro/tree/main/packages/astro/tsconfigs diff --git a/packages/create-astro/src/actions/help.ts b/packages/create-astro/src/actions/help.ts index c03735b18..097dfa701 100644 --- a/packages/create-astro/src/actions/help.ts +++ b/packages/create-astro/src/actions/help.ts @@ -11,12 +11,12 @@ export function help() { ['--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.'], + ['--yes (-y)', 'Skip all prompts by accepting defaults.'], + ['--no (-n)', 'Skip all prompts by declining defaults.'], ['--dry-run', 'Walk through steps without executing.'], ['--skip-houston', 'Skip Houston animation.'], ['--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.'], ], }, |