Skip to content

Sync cli docs #729

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

Merged
merged 1 commit into from
Oct 31, 2024
+11 −12
Merged

Sync cli docs #729

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 11 additions & 12 deletions apps/svelte.dev/content/docs/cli/20-commands/10-sv-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,6 @@ npx sv create [options] [path]

## Options

<!-- TODO this flag should probably just be '--types', and the options should be 'ts' or 'jsdoc' -->

### `--check-types <option>`

Whether and how to add typechecking to the project:

- `typescript` — default to `.ts` files and use `lang="ts"` for `.svelte` components
- `checkjs` — use [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) for types
- `none` — no typechecking. Not recommended!

### `--template <name>`

Which project template to use:
Expand All @@ -30,9 +20,18 @@ Which project template to use:
- `demo` — showcase app with a word guessing game that works without JavaScript
- `library` — template for a Svelte library, set up with `svelte-package`

### `--no-integrations`
### `--types <option>`

Whether and how to add typechecking to the project:

- `ts` — default to `.ts` files and use `lang="ts"` for `.svelte` components
- `jsdoc` — use [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) for types

### `--no-types`

Prevent typechecking from being added. Not recommended!

<!-- TODO should be renamed to `--no-addons` -->
### `--no-add-ons`

Run the command without the interactive add-ons prompt

Expand Down