Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refine CLI flag descriptions for clarity #8545

Merged
merged 16 commits into from
Sep 22, 2023
Merged

Refine CLI flag descriptions for clarity #8545

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
a7bcdd4
Refine CLI flag descriptions for clarity
jacobdalamb Sep 13, 2023
d2c6b53
Merge branch 'main' into chore/create-astro-cli-flags
jacobdalamb Sep 13, 2023
c5d4836
Update README.md
jacobdalamb Sep 13, 2023
749f2f1
Update README.md
jacobdalamb Sep 13, 2023
811bce0
Merge branch 'main' into chore/create-astro-cli-flags
natemoo-re Sep 13, 2023
e69e1d2
Merge branch 'main' into chore/create-astro-cli-flags
jacobdalamb Sep 14, 2023
33238be
Merge branch 'main' into chore/create-astro-cli-flags
jacobdalamb Sep 18, 2023
4605750
Merge branch 'main' into chore/create-astro-cli-flags
jacobdalamb Sep 19, 2023
847da99
Merge branch 'main' into chore/create-astro-cli-flags
jacobdalamb Sep 22, 2023
ffac50e
Update README.md
jacobdalamb Sep 22, 2023
15f7a43
Update help.ts
jacobdalamb Sep 22, 2023
7741d91
Update packages/create-astro/src/actions/help.ts
jacobdalamb Sep 22, 2023
887e69c
Update packages/create-astro/README.md
jacobdalamb Sep 22, 2023
5e60470
Update packages/create-astro/README.md
jacobdalamb Sep 22, 2023
28545f3
Update README.md
natemoo-re Sep 22, 2023
2514716
Merge branch 'main' into chore/create-astro-cli-flags
natemoo-re Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions packages/create-astro/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
jacobdalamb marked this conversation as resolved.
Show resolved Hide resolved
| `--template <name>` | Specify a template. |
| `--install / --no-install` | Toggle dependency installation. |
| `--git / --no-git` | Toggle git repository initialization. |
| `--yes (-y)` | Accept all default prompts. |
| `--no (-n)` | Decline all default prompts. |
| `--dry-run` | Simulate steps without actual execution. |
| `--skip-houston` | Skip the Houston animation. |
| `--ref` | Specify an Astro branch (default: latest). |
| `--fancy` | Enable full Unicode support for Windows. |
| `--typescript <option>` | Choose a TypeScript option: `strict`, `strictest`, `relaxed`. |
jacobdalamb marked this conversation as resolved.
Show resolved Hide resolved

[examples]: https://github.com/withastro/astro/tree/main/examples
[typescript]: https://github.com/withastro/astro/tree/main/packages/astro/tsconfigs
22 changes: 11 additions & 11 deletions packages/create-astro/src/actions/help.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ export function help() {
headline: 'Scaffold Astro projects.',
tables: {
Flags: [
['--help (-h)', 'See all 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 prompt by accepting defaults.'],
['--no (-n)', 'Skip all prompt 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.'],
['--typescript <option>', 'TypeScript option: strict | strictest | relaxed.'],
['--help (-h)', 'Display available flags.'],
['--template <name>', 'Specify a template.'],
['--install / --no-install', 'Toggle dependency installation.'],
['--git / --no-git', 'Toggle git repository initialization.'],
['--yes (-y)', 'Accept all default prompts.'],
['--no (-n)', 'Decline all default prompts.'],
['--dry-run', 'Simulate steps without actual execution.'],
['--skip-houston', 'Skip the Houston animation.'],
['--ref', 'Specify an Astro branch (default: latest).'],
['--fancy', 'Enable full Unicode support for Windows.'],
['--typescript <option>', 'Choose a TypeScript option: strict, strictest, or relaxed.'],
],
},
});
Expand Down
Loading