Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/storybookjs/create-svelte-with-args
A small CLI wrapper around the create-svelte package that enables you to replace the interactive prompts with CLI arguments.
https://github.com/storybookjs/create-svelte-with-args
Last synced: 22 days ago
JSON representation
A small CLI wrapper around the create-svelte package that enables you to replace the interactive prompts with CLI arguments.
- Host: GitHub
- URL: https://github.com/storybookjs/create-svelte-with-args
- Owner: storybookjs
- License: mit
- Created: 2022-09-28T11:16:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T23:30:30.000Z (7 months ago)
- Last Synced: 2024-04-14T01:30:20.170Z (7 months ago)
- Language: JavaScript
- Size: 1.1 MB
- Stars: 5
- Watchers: 8
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🏗 [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte) Without The Prompts
> **Warning**
> This package is **not** supported nor endorsed by the maintainers of Svelte.
> If you experience any issues with it you should file them in this repository and not in the official SvelteKit repository.
>
> The Svelte team has been very explicit about not adding CLI arguments to `create-svelte` for good reasons.
> See https://github.com/sveltejs/kit/pull/6117#issuecomment-1221323822
`create-svelte-with-args` is a simple wrapper around the [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte) package that allows you to specify the options as CLI arguments instead of using the interactive prompts.
This is useful if you want to automate the creation of SvelteKit projects, which can be pretty hard with interactive prompts.
> **Note**
> If you do not need to create SvelteKit projects programmatically you probabvly just want to use the official `create-svelte` package instead of this one.
## Usage
Run the CLi with
```bash
npm create svelte-with-args [args]
```
The arguments match one to one with the upstream [programmatic `create-svelte` package](https://github.com/sveltejs/kit/tree/master/packages/create-svelte#api). All arguments except `--directory´ are required.
| **Argument** | **Description** | **Type** | **Example** |
| -------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------- | ----------------------------------- |
| `--name`, `-n` | The name of the project | `string` | `--name=my-new-app` |
| `--directory`, `-d` | Optional. The directory to install the project in. Defaults to the project name | `string` | `--directory=other-dir` |
| `--template`, `-t` | The template to use | One of `"default"`, `"skeleton"`, `"skeletonlib"` | `--template=default` |
| `--types`, `-y` | How types will be written | One of `"checkjs"`, `"typescript"`, `"null"` | `--types=checkjs` |
| `--prettier`, `-p` | Whether prettier should be included | `boolean` | `--prettier` or `--no-prettier` |
| `--eslint`, `-e` | Whether eslint should be included | `boolean` | `--eslint` or `--no-eslint` |
| `--playwright`, `-l` | Whether playwright should be included | `boolean` | `--playwright` or `--no-playwright` |
| `--vitest`, `-v` | Whether vitest should be included | `boolean` | `--vitest` or `--no-vitest` |
| `--svelte5`, `-5` | If Svelte 5 beta should be used | `boolean` | `--svelte5` or `--no-svelte5` |
### Examples
Create a default project called `my-new-app` that checks JS types with prettier but without eslint and playwright:
```bash
npm create svelte-with-args --name=my-new-app --template=default --types=checkjs --prettier --no-eslint --no-playwright --no-vitest --no-svelte5
```
Create a skeleton project without any type checking:
```bash
npm create svelte-with-args --name=my-new-app --template=skeleton --types=null --no-prettier --no-eslint --no-playwright --no-vitest --no-svelte5
```
### `--help`
```
create-svelte-with-args [args]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-n, --name The name of the project [string] [required]
-d, --directory The directory to install the project in. Defaults to the
project name [string]
-t, --template The template to use
[string] [required] [choices: "default", "skeleton", "skeletonlib"]
-y, --types How types will be written
[required] [choices: "checkjs", "typescript", null]
-p, --prettier Whether prettier should be included [boolean] [required]
-e, --eslint Whether eslint should be included [boolean] [required]
-l, --playwright Whether playwright should be included [boolean] [required]
-v, --vitest Whether vitest should be included [boolean] [required]
-5, --svelte5 If Svelte 5 beta should be used [boolean] [required]
--dry Whether to run in dry run mode, not creating any files
[boolean] [default: false]
Examples:
npm create svelte-with-args@latest Default app, checking JS types, with
--name=my-new-app --template=default Prettier, and no ESLint, Playwright
--types=checkjs --prettier --no-eslint or Vitest
--no-playwright --no-vitest --no-svelte5
npm create svelte-with-args@latest Default app, installing in specified
--name=my-new-app directory
--directory=other-dir/my-app
--template=default --types=typescript
--no-prettier --no-eslint
--no-playwright --no-vitest --no-svelte5
For more information, see https://github.com/storybookjs/create-svelte-with-args
```
## Releasing
Releases are handled automatically by [auto](https://github.com/intuit/auto). By setting the correct labels on a pull request, the semantic versioning is handled automatically, GitHub releases are generated as well as a changelog.
Once a pull request has been merged to `main` it is automatically released as the `latest` version.