-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
breaking: goodbye create-svelte (#12850)
- Loading branch information
Showing
116 changed files
with
15 additions
and
16,512 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| 'create-svelte': major | ||
| --- | ||
|
|
||
| breaking: the `create-svelte` package has been replaced by the `sv` package |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,11 @@ | ||
| # create-svelte | ||
|
|
||
| A CLI for creating new [SvelteKit](https://kit.svelte.dev) projects. Just run... | ||
| This package has been deprecated. Please see [`sv`](https://npmjs.com/package/sv) instead: | ||
|
|
||
| ```bash | ||
| npm create svelte@latest | ||
| npx sv create | ||
| ``` | ||
|
|
||
| ...and follow the prompts. | ||
|
|
||
| ## API | ||
|
|
||
| You can also use `create-svelte` programmatically: | ||
|
|
||
| ```js | ||
| import { create } from 'create-svelte'; | ||
|
|
||
| await create('my-new-app', { | ||
| name: 'my-new-app', | ||
| template: 'default', // or 'skeleton' or 'skeletonlib' | ||
| types: 'checkjs', // or 'typescript' or null; | ||
| prettier: false, | ||
| eslint: false, | ||
| playwright: false, | ||
| vitest: false | ||
| }); | ||
| ``` | ||
|
|
||
| `checkjs` means your project will use TypeScript to typecheck JavaScript via [JSDoc comments](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html). | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](../../LICENSE). | ||
| [MIT](../../LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,150 +1,3 @@ | ||
| #!/usr/bin/env node | ||
| import fs from 'node:fs'; | ||
| import path from 'node:path'; | ||
| import process from 'node:process'; | ||
| import * as p from '@clack/prompts'; | ||
| import { bold, cyan, grey, yellow } from 'kleur/colors'; | ||
| import { create } from './index.js'; | ||
| import { dist, package_manager } from './utils.js'; | ||
|
|
||
| const { version } = JSON.parse(fs.readFileSync(new URL('package.json', import.meta.url), 'utf-8')); | ||
| let cwd = process.argv[2] || '.'; | ||
|
|
||
| console.log(` | ||
| ${grey(`create-svelte version ${version}`)} | ||
| `); | ||
|
|
||
| p.intro('Welcome to SvelteKit!'); | ||
|
|
||
| if (cwd === '.') { | ||
| const dir = await p.text({ | ||
| message: 'Where should we create your project?', | ||
| placeholder: ' (hit Enter to use current directory)' | ||
| }); | ||
|
|
||
| if (p.isCancel(dir)) process.exit(1); | ||
|
|
||
| if (dir) { | ||
| cwd = /** @type {string} */ (dir); | ||
| } | ||
| } | ||
|
|
||
| if (fs.existsSync(cwd)) { | ||
| if (fs.readdirSync(cwd).length > 0) { | ||
| const force = await p.confirm({ | ||
| message: 'Directory not empty. Continue?', | ||
| initialValue: false | ||
| }); | ||
|
|
||
| // bail if `force` is `false` or the user cancelled with Ctrl-C | ||
| if (force !== true) { | ||
| process.exit(1); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const options = await p.group( | ||
| { | ||
| template: (_) => | ||
| p.select({ | ||
| message: 'Which Svelte app template?', | ||
| options: fs.readdirSync(dist('templates')).map((dir) => { | ||
| const meta_file = dist(`templates/${dir}/meta.json`); | ||
| const { title, description } = JSON.parse(fs.readFileSync(meta_file, 'utf8')); | ||
|
|
||
| return { | ||
| label: title, | ||
| hint: description, | ||
| value: dir | ||
| }; | ||
| }) | ||
| }), | ||
|
|
||
| types: ({ results }) => | ||
| p.select({ | ||
| message: 'Add type checking with TypeScript?', | ||
| initialValue: /** @type {'checkjs' | 'typescript' | null} */ ( | ||
| results.template === 'skeletonlib' ? 'checkjs' : 'typescript' | ||
| ), | ||
| options: [ | ||
| { | ||
| label: 'Yes, using TypeScript syntax', | ||
| value: 'typescript' | ||
| }, | ||
| { | ||
| label: 'Yes, using JavaScript with JSDoc comments', | ||
| value: 'checkjs' | ||
| }, | ||
| { label: 'No', value: null } | ||
| ] | ||
| }), | ||
|
|
||
| features: () => | ||
| p.multiselect({ | ||
| message: 'Select additional options (use arrow keys/space bar)', | ||
| required: false, | ||
| options: [ | ||
| { | ||
| value: 'eslint', | ||
| label: 'Add ESLint for code linting' | ||
| }, | ||
| { | ||
| value: 'prettier', | ||
| label: 'Add Prettier for code formatting' | ||
| }, | ||
| { | ||
| value: 'playwright', | ||
| label: 'Add Playwright for browser testing' | ||
| }, | ||
| { | ||
| value: 'vitest', | ||
| label: 'Add Vitest for unit testing' | ||
| }, | ||
| { | ||
| value: 'svelte5', | ||
| label: 'Try the Svelte 5 preview (unstable!)' | ||
| } | ||
| ] | ||
| }) | ||
| }, | ||
| { onCancel: () => process.exit(1) } | ||
| ); | ||
|
|
||
| await create(cwd, { | ||
| name: path.basename(path.resolve(cwd)), | ||
| template: /** @type {'default' | 'skeleton' | 'skeletonlib'} */ (options.template), | ||
| types: /** @type {'checkjs' | 'typescript' | null} */ (options.types), | ||
| prettier: options.features.includes('prettier'), | ||
| eslint: options.features.includes('eslint'), | ||
| playwright: options.features.includes('playwright'), | ||
| vitest: options.features.includes('vitest'), | ||
| svelte5: options.features.includes('svelte5') | ||
| }); | ||
|
|
||
| p.outro('Your project is ready!'); | ||
|
|
||
| if (!options.types && options.template === 'skeletonlib') { | ||
| const warning = yellow('▲'); | ||
| console.log( | ||
| `${warning} You chose to not add type checking, but TypeScript will still be installed in order to generate type definitions when building the library\n` | ||
| ); | ||
| } | ||
|
|
||
| console.log('Install more integrations with:'); | ||
| console.log(bold(cyan(' npx svelte-add'))); | ||
|
|
||
| console.log('\nNext steps:'); | ||
| let i = 1; | ||
|
|
||
| const relative = path.relative(process.cwd(), cwd); | ||
| if (relative !== '') { | ||
| console.log(` ${i++}: ${bold(cyan(`cd ${relative}`))}`); | ||
| } | ||
|
|
||
| console.log(` ${i++}: ${bold(cyan(`${package_manager} install`))}`); | ||
| // prettier-ignore | ||
| console.log(` ${i++}: ${bold(cyan('git init && git add -A && git commit -m "Initial commit"'))} (optional)`); | ||
| console.log(` ${i++}: ${bold(cyan(`${package_manager} run dev -- --open`))}`); | ||
|
|
||
| console.log(`\nTo close the dev server, hit ${bold(cyan('Ctrl-C'))}`); | ||
| console.log(`\nStuck? Visit us at ${cyan('https://svelte.dev/chat')}`); | ||
| console.warn("'npm create svelte' has been replaced with 'npx sv create'"); |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.