Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rossyman/svelte-add-jest
SvelteKit adder for Jest unit testing
https://github.com/rossyman/svelte-add-jest
jest svelte sveltekit
Last synced: about 21 hours ago
JSON representation
SvelteKit adder for Jest unit testing
- Host: GitHub
- URL: https://github.com/rossyman/svelte-add-jest
- Owner: rossyman
- License: mit
- Created: 2021-03-28T22:07:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T15:53:53.000Z (over 1 year ago)
- Last Synced: 2025-01-30T23:44:53.094Z (9 days ago)
- Topics: jest, svelte, sveltekit
- Language: TypeScript
- Homepage:
- Size: 17.6 KB
- Stars: 31
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🧪 Add Jest to Sveltekit
## ❓ What is this?
This is an **experimental** command to run to add Jest to your SvelteKit project.
## 🛠 Usage
You must start with a fresh copy of the official SvelteKit template, which is currently created by running this command:
```sh
npm create svelte@latest
```
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](https://usepreset.dev/), as it relies upon JSON.parse.__
```sh
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](https://github.com/svelte-add/svelte-adders) to your project for more functionality.
### ⚙️ Options
| 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 |
### 📑 Relevant Documentation
- [Svelte Testing Library Docs](https://testing-library.com/docs/svelte-testing-library/intro/)
- [Jest DOM](https://github.com/testing-library/jest-dom#usage)
- [Jest](https://jestjs.io)
## Routed Tests
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:
```js
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](https://usepreset.dev/).
## 😵 Help! I have a question
[Create an issue](https://github.com/svelte-add/jest/issues/new) and we'll try to help.
## 😡 Fix! There is something that needs improvement
[Create an issue](https://github.com/rossyman/svelte-add-jest/issues/new) or [pull request](https://github.com/rossyman/svelte-add-jest/pulls) 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.
# 📄 License
MIT
---
_Repository preview image generated with [GitHub Social Preview](https://social-preview.pqt.dev)_
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_