Skip to content

Commit 1ad847e

Browse files
authored
docs: change unit tests references on chore: contributing.md from JEST to VITEST (#2462)
1 parent 42453b4 commit 1ad847e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

.github/contributing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ A high-level overview of tools used:
5252

5353
- [TypeScript](https://www.typescriptlang.org/) as the development language
5454
- [Rollup](https://rollupjs.org) for bundling
55-
- [Jest](https://jestjs.io/) for unit testing
55+
- [Vitest](https://vitest.dev/) for unit testing
5656
- [Prettier](https://prettier.io/) for code formatting
5757

5858
## Scripts
@@ -83,7 +83,7 @@ The `pnpm test` script runs all checks:
8383
$ pnpm test
8484

8585
# run unit tests in watch mode
86-
$ pnpm jest --watch
86+
$ pnpm test:unit --watch
8787
```
8888

8989
## Project Structure
@@ -102,7 +102,7 @@ Vue Router source code can be found in the `src` directory:
102102

103103
## Contributing Tests
104104

105-
Unit tests are located inside `__tests__`. Consult the [Jest docs](https://jestjs.io/docs/en/using-matchers) and existing test cases for how to write new test specs. Here are some additional guidelines:
105+
Unit tests are located inside `__tests__`. Consult the [Vitest docs](https://vitest.dev/guide/) and existing test cases for how to write new test specs. Here are some additional guidelines:
106106

107107
- Use the minimal API needed for a test case. For example, if a test can be written without involving the reactivity system or a component, it should be written so. This limits the test's exposure to changes in unrelated parts and makes it more stable.
108108
- Use the minimal API needed for a test case. For example, if a test concerns the `router-link` component, don't create a router instance, mock the required properties instead.

0 commit comments

Comments
 (0)