This is an experimental command to run to add Jest to your SvelteKit project.
You must start with a fresh copy of the official SvelteKit template, which is currently created by running this command:
npm create svelte@latest <app-name>
Once that is set up, run this command in your project directory to set up Jest:
โ๏ธ When running with TypeScript support enabled, remove comments within
tsconfig.json
or the adder will fail. This is a known limitation of Preset, as it relies upon JSON.parse.
npx apply rossyman/svelte-add-jest # --no-ssh
After the preset runs,
npm install
, pnpm i
, or yarn
to update dependencies.
You can apply another Svelte Adder to your project for more functionality.
Description | Flag | Negated | Default |
---|---|---|---|
Interactive Mode | --interaction |
--no-interaction |
True |
Jest DOM Support | --jest-dom |
--no-jest-dom |
True |
Typescript Support | --ts |
--no-ts |
False |
JSDOM Jest Env by Default | --jsdom |
--jsdom |
True |
Generate Example | --examples |
--no-examples |
True |
If you run into an issue when writing tests for routed svelte components or files (Reference error: describe is not defined
), this is a known issue. To fix it, you must modify your svelte.config.js
(Specifically the routes
property) with the following modification:
kit: {
// Prior svelte configuration goes here...
routes: filepath => {
return ![
// Exclude spec files
/\.spec\.(ts|js)$/,
// Original routes
/(?:(?:^_|\/_)|(?:^\.|\/\.)(?!well-known))/,
].some(regex => regex.test(filepath))
},
}
The reason we cannot perform this change directly for you, is due to a limitation within Preset.
Create an issue and we'll try to help.
Create an issue or pull request and we'll try to fix.
These are new tools, so there are likely to be problems in this project. Thank you for bringing them to our attention or fixing them for us.
MIT
Repository preview image generated with GitHub Social Preview
This README was generated with โค๏ธ by readme-md-generator