README.md

template-sveltekit-example

This is a SvelteKit skeleton project which I use as a GitHub template to create SvelteKit examples:

• It uses JSDoc annotations for TypeScript support.
• It comes with linting support for JSDoc.
• It includes workspace settings for VS Code.

Keeping dependencies up-to-date

I update dependencies in this template regularly. These are the steps:

1. Run pnpm create svelte@latest . to regenerate the SvelteKit skeleton project into the existing directory.
2. Where should we create your project? Hit enter to use the current directory.
3. Directory not empty. Continue? Yes.
4. Which Svelte app template? Skeleton project.
5. Add type checking with TypeScript? Yes, using JavaScript with JSDoc comments.
6. Add ESLint and Prettier.
7. Revert README.md (on StackBlitz copy content from GitHub website to revert).
8. Run pnpm i -D eslint-plugin-jsdoc.
9. Check changes in .eslintrc.js and manually revert preserving eslint-plugin-jsdoc.
10. Delete folder node_modules and file pnpm-lock.yaml and run pnpm i.