···11+# Svelte + TS + Vite
22+33+This template should help get you started developing with Svelte and TypeScript in Vite.
44+55+## Recommended IDE Setup
66+77+[VS Code](https://code.visualstudio.com/) +
88+[Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
99+1010+## Need an official Svelte framework?
1111+1212+Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy
1313+anywhere with its serverless-first approach and adapt to various platforms, with out of the box
1414+support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS,
1515+Tailwind CSS, and more.
1616+1717+## Technical considerations
1818+1919+**Why use this over SvelteKit?**
2020+2121+- It brings its own routing solution which might not be preferable for some users.
2222+- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
2323+2424+This template contains as little as possible to get started with Vite + TypeScript + Svelte, while
2525+taking into account the developer experience with regards to HMR and intellisense. It demonstrates
2626+capabilities on par with the other `create-vite` templates and is a good starting point for
2727+beginners dipping their toes into a Vite + Svelte project.
2828+2929+Should you later need the extended capabilities and extensibility provided by SvelteKit, the
3030+template has been structured similarly to SvelteKit so that it is easy to migrate.
3131+3232+**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
3333+3434+Setting `compilerOptions.types` shuts out all other types not explicitly listed in the
3535+configuration. Using triple-slash references keeps the default TypeScript setting of accepting type
3636+information from the entire workspace, while also adding `svelte` and `vite/client` type
3737+information.
3838+3939+**Why include `.vscode/extensions.json`?**
4040+4141+Other templates indirectly recommend extensions via the README, but this file allows VS Code to
4242+prompt the user to install the recommended extension upon opening the project.
4343+4444+**Why enable `allowJs` in the TS template?**
4545+4646+While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not
4747+prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force
4848+`checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase
4949+is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there
5050+are valid use cases in which a mixed codebase may be relevant.
5151+5252+**Why is HMR not preserving my local component state?**
5353+5454+HMR state preservation comes with a number of gotchas! It has been disabled by default in both
5555+`svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read
5656+the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
5757+5858+If you have state that's important to retain within a component, consider creating an external store
5959+which would not be replaced by HMR.
6060+6161+```ts
6262+// store.ts
6363+// An extremely simple external store
6464+import { writable } from 'svelte/store';
6565+export default writable(0);
6666+```
···11+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
22+33+export default {
44+ // Consult https://svelte.dev/docs#compile-time-svelte-preprocess
55+ // for more information about preprocessors
66+ preprocess: vitePreprocess(),
77+};
+21
packages/svelte-site/tsconfig.json
···11+{
22+ "extends": "@tsconfig/svelte/tsconfig.json",
33+ "compilerOptions": {
44+ "target": "ESNext",
55+ "useDefineForClassFields": true,
66+ "module": "ESNext",
77+ "resolveJsonModule": true,
88+ /**
99+ * Typecheck JS in `.svelte` and `.js` files by default.
1010+ * Disable checkJs if you'd like to use dynamic types in JS.
1111+ * Note that setting allowJs false does not prevent the use
1212+ * of JS in `.svelte` files.
1313+ */
1414+ "allowJs": true,
1515+ "checkJs": true,
1616+ "isolatedModules": true,
1717+ "moduleDetection": "force",
1818+ },
1919+ "include": ["src/**/*.ts", "src/**/*.js", "src/**/*.svelte"],
2020+ "references": [{ "path": "./tsconfig.node.json" }],
2121+}