diff --git a/packages/create-app/template-svelte-ts/README.md b/packages/create-app/template-svelte-ts/README.md index 2e42916edc251b..52ad5c8b130201 100644 --- a/packages/create-app/template-svelte-ts/README.md +++ b/packages/create-app/template-svelte-ts/README.md @@ -9,3 +9,42 @@ This template should help get you started developing with Svelte and TypeScript ## Need an official Svelte framework? Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more. + +## Technical considerations + +**Why use this over SvelteKit?** + +- SvelteKit is still a work-in-progress. +- It currently does not support the pure-SPA use case. +- It brings its own routing solution which might not be preferable for some users. +- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app. + `vite dev` and `vite build` wouldn't work in a SvelteKit environment, for example. + +This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-app` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project. + +Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate. + +**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?** + +Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information. + +**Why include `.vscode/extensions.json`?** + +Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project. + +**Why enable `allowJs` in the TS template?** + +While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant. + +**Why is HMR not preserving my local component state?** + +HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr). + +If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR. + +```ts +// store.ts +// An extremely simple external store +import { writable } from 'svelte/store' +export default writable(0) +``` diff --git a/packages/create-app/template-svelte-ts/package.json b/packages/create-app/template-svelte-ts/package.json index ddef4dc160de8f..42909c008923cd 100644 --- a/packages/create-app/template-svelte-ts/package.json +++ b/packages/create-app/template-svelte-ts/package.json @@ -7,10 +7,10 @@ "serve": "vite preview" }, "devDependencies": { - "@svitejs/vite-plugin-svelte": "^0.11.1", + "@sveltejs/vite-plugin-svelte": "next", "svelte": "^3.35.0", "svelte-preprocess": "^4.6.9", "typescript": "^4.2.3", - "vite": "^2.1.0" + "vite": "^2.1.2" } -} \ No newline at end of file +} diff --git a/packages/create-app/template-svelte-ts/src/App.svelte b/packages/create-app/template-svelte-ts/src/App.svelte index 624bfb36d2d837..4023b8b9774246 100644 --- a/packages/create-app/template-svelte-ts/src/App.svelte +++ b/packages/create-app/template-svelte-ts/src/App.svelte @@ -7,7 +7,7 @@
Visit svelte.dev to learn how to build Svelte diff --git a/packages/create-app/template-svelte-ts/globals.d.ts b/packages/create-app/template-svelte-ts/src/global.d.ts similarity index 100% rename from packages/create-app/template-svelte-ts/globals.d.ts rename to packages/create-app/template-svelte-ts/src/global.d.ts diff --git a/packages/create-app/template-svelte-ts/src/lib/Counter.svelte b/packages/create-app/template-svelte-ts/src/lib/Counter.svelte index da35d76dafe7d3..b8e7524c2232aa 100644 --- a/packages/create-app/template-svelte-ts/src/lib/Counter.svelte +++ b/packages/create-app/template-svelte-ts/src/lib/Counter.svelte @@ -1,15 +1,12 @@ -