Svelte-SPA-2022 Template
This template should help get you started developing a SPA application with Svelte
Features
- Produces a pure SPA app - no SSR or server required
- Tiny: fully featured bundles start at <7kb
Dependencies
- @usvelte/router: Tiny, more customizable SPA router with codesplitting, cached lazy loading
- @usvelte/swr: Tiny data-fetching Component hook that loads instantly from cache and refreshes once loaded
Why use this over SvelteKit?
- Produces a pure SPA app -- SvelteKit only produces an SSR app
- Smaller bundle sizes
- More router features
Recommended IDE Setup
Technical considerations
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.
If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
// store.ts
// An extremely simple external store
import {writable} from 'svelte/store'
export default writable(0)
