danielroe.dev
[READ-ONLY] Mirror of https://github.com/danielroe/nuxt-vitest. An vitest environment with support for testing code that needs a Nuxt runtime environment
nuxt
nuxt-module
testing
unit-testing
vitest
chore: add README
author
Daniel Roe
date
(Dec 19, 2022, 1:57 PM UTC)
commit
cda1abfe
cda1abfecc015b7f03e00411afdf5369ecea65ad
parent
6948aa6f
6948aa6fc13a47c142e30ee8a7bbfffc71488e28
+75
+21
LICENCE
+21
LICENCE
···
1
+
MIT License
2
+
3
+
Copyright (c) 2022 Daniel Roe
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+54
README.md
+54
README.md
···
1
+
<h1 align="center">vitest-environment-nuxt</h1>
2
+
<p align="center">An in-development vitest environment with support for testing code that needs a Nuxt runtime environment.</p>
3
+
4
+
<p align="center">
5
+
6
+
[![npm version][npm-version-src]][npm-version-href]
7
+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
8
+
[![Github Actions][github-actions-src]][github-actions-href]
9
+
[![Codecov][codecov-src]][codecov-href]
10
+
11
+
</p>
12
+
13
+
> An in-development vitest environment with support for testing code that needs a Nuxt runtime environment
14
+
15
+
⚠️ This library is in active development and you should pin the patch version before using.
16
+
17
+
## Quick Start
18
+
19
+
First install `vitest-environment-nuxt`:
20
+
21
+
```bash
22
+
yarn add --dev vitest-environment-nuxt
23
+
24
+
# or npm
25
+
npm i -D vitest-environment-nuxt
26
+
27
+
# or pnpm
28
+
pnpm add -D vitest-environment-nuxt
29
+
```
30
+
31
+
## 💻 Development
32
+
33
+
- Clone this repository
34
+
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)
35
+
- Install dependencies using `pnpm install`
36
+
- Stub the library using `pnpm dev:prepare`
37
+
- Run interactive tests using `pnpm test`
38
+
39
+
## License
40
+
41
+
Made with ❤️
42
+
43
+
Published under [MIT License](./LICENCE).
44
+
45
+
<!-- Badges -->
46
+
47
+
[npm-version-src]: https://img.shields.io/npm/v/vitest-environment-nuxt?style=flat-square
48
+
[npm-version-href]: https://npmjs.com/package/vitest-environment-nuxt
49
+
[npm-downloads-src]: https://img.shields.io/npm/dm/vitest-environment-nuxt?style=flat-square
50
+
[npm-downloads-href]: https://npmjs.com/package/vitest-environment-nuxt
51
+
[github-actions-src]: https://img.shields.io/github/workflow/status/danielroe/vitest-environment-nuxt/ci/main?style=flat-square
52
+
[github-actions-href]: https://github.com/danielroe/vitest-environment-nuxt/actions?query=workflow%3Aci
53
+
[codecov-src]: https://img.shields.io/codecov/c/gh/danielroe/vitest-environment-nuxt/main?style=flat-square
54
+
[codecov-href]: https://codecov.io/gh/danielroe/vitest-environment-nuxt