-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
345 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,82 @@ | ||
# svelte-add-jest | ||
SvelteKit adder for Jest unit testing | ||
<h1 align="center">Welcome to svelte-add-jest 👋</h1> | ||
<p> | ||
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" /> | ||
<a href="https://github.com/rossyman/svelte-add-jest/blob/main/LICENSE" target="_blank"> | ||
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" /> | ||
</a> | ||
</p> | ||
|
||
## ❓ 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 init svelte@next | ||
``` | ||
|
||
Once that is set up, run this command in your project directory to set up Jest: | ||
|
||
```sh | ||
npx svelte-add jest | ||
``` | ||
|
||
After the preset runs, | ||
|
||
- 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 | | ||
| Generate Example | `--examples` | `--no-examples` | True | | ||
|
||
## 👀 See Also | ||
|
||
- [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) | ||
|
||
## 🤝 Contributing | ||
|
||
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/rossyman/svelte-add-jest/issues). | ||
|
||
### 😵 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. | ||
|
||
## Show your support | ||
|
||
Give a ⭐️ if this project helped you! | ||
|
||
## Author | ||
|
||
👤 **Ross MacPhee** | ||
|
||
- Twitter: [@rossco___](https://twitter.com/rossco___) | ||
- Github: [@rossyman](https://github.com/rossyman) | ||
- LinkedIn: [@ross-macphee](https://linkedin.com/in/ross-macphee) | ||
|
||
👤 **Brady Wiggins** | ||
|
||
- Github: [@FractalHQ](https://github.com/FractalHQ) | ||
|
||
## 📝 License | ||
|
||
Copyright © 2021 - Ross MacPhee & Brady Wiggins.<br /> | ||
This project is [MIT](https://github.com/rossyman/svelte-add-jest/blob/main/LICENSE) licensed. | ||
|
||
--- | ||
|
||
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"private": true, | ||
"name": "@rossyman/svelte-add-jest", | ||
"version": "1.0.0", | ||
"description": "SvelteKit adder for Jest unit testing", | ||
"license": "MIT", | ||
"keywords": [ | ||
"svelte", | ||
"sveltekit", | ||
"svelte-kit", | ||
"jest", | ||
"unit-test", | ||
"test" | ||
], | ||
"repository": "github:rossyman/svelte-add-jest", | ||
"bugs": "https://github.com/rossyman/svelte-add-jest/issues", | ||
"contributors": [ | ||
"Ross MacPhee (https://github.com/rossyman)", | ||
"Brady Wiggins (https://github.com/FractalHQ)" | ||
], | ||
"preset": "preset.ts", | ||
"devDependencies": { | ||
"apply": "^0.2.13" | ||
} | ||
} |
Oops, something went wrong.