| 1 | # Vue Test Utils
|
| 2 |
|
| 3 | Component testing utils for Vue 3.
|
| 4 |
|
| 5 | ## Languages
|
| 6 |
|
| 7 | [🇫🇷 French version of this README.md](https://github.com/vuejs/test-utils/tree/main/docs/fr/README.md)
|
| 8 |
|
| 9 | ## Installation and Usage
|
| 10 |
|
| 11 | - yarn: `yarn add @vue/test-utils --dev`
|
| 12 | - npm: `npm install @vue/test-utils --save-dev`
|
| 13 |
|
| 14 | Get started with the [documentation](https://test-utils.vuejs.org/).
|
| 15 |
|
| 16 | ## Coming from Vue 2 + Test Utils v1?
|
| 17 |
|
| 18 | [Check the migration guide](https://test-utils.vuejs.org/migration/). It's still a work in progress. If you find a problem or something that doesn't work that previously did in Vue Test Utils v1, please open an issue.
|
| 19 |
|
| 20 | ## Documentation
|
| 21 |
|
| 22 | See the [docs](https://test-utils.vuejs.org/).
|
| 23 |
|
| 24 | ## Development
|
| 25 |
|
| 26 | Get started by running `pnpm install`. You can run the tests with `pnpm test`. That's it!
|
| 27 |
|
| 28 | ## Contributing Docs
|
| 29 |
|
| 30 | All the documentation files can be found in `packages/docs`. It contains the English markdown files while translation(s) are stored in their corresponding `<lang>` sub-folder(s):
|
| 31 |
|
| 32 | - [`fr`](https://github.com/vuejs/test-utils/tree/main/packages/docs/fr): French translation.
|
| 33 |
|
| 34 | Besides that, the `.vitepress` sub-folder contains the config and theme, including the i18n information.
|
| 35 |
|
| 36 | - `pnpm docs:dev`: Start the docs dev server.
|
| 37 | - `pnpm docs:build`: Build the docs.
|
| 38 |
|
| 39 | To add or maintain the translations, we follow the [Vue Ecosystem Translation Guidelines](https://github.com/vuejs-translations/guidelines/blob/main/README_ECOSYSTEM.md).
|
| 40 |
|
| 41 | - `pnpm docs:translation:status [<lang>]`: Show the translation status for your language. If you don't specify a language, it will show the status for all languages.
|
| 42 | - `pnpm docs:translation:compare <lang>`: Compare the docs with the latest checkpoint for your language.
|
| 43 | - `pnpm docs:translation:update <lang> [<commit>]`: Update the checkpoint for your language. The checkpoint will be set by the latest commit hash. However, you can also specify a commit hash manually.
|