@terminal-nerds/vitest-config v0.15.0
@terminal-nerds/vitest-config
➡️ Extendable configuration, part of the terminal-nerds/configs project.
Prerequisites
ℹ️ This configuration package require these tools to use locally on your device(s):
- Latest Node.js LTS (Long-Term Support) version
- One of Node.js package managers:
- Latest version
Basic usage
👣 Follow the steps below:
Install it with the package manager of your choice (in our case, we use ).
pnpm install --save-dev vitest @terminal-nerds/vitest-config
Create a vitest configuration file -
vitest.config.ts
.Import a specific options from this module package configuration and use it.\ NOTE: This one below is an example!
import { WITH_COVERAGE_OPTIONS } from "@terminal-nerds/vitest-config"; import { defineConfig } from "vitest/config"; // https://vitest.dev/config/ export default defineConfig({ test: { ...WITH_COVERAGE_OPTIONS, // Override the config from there, if neccessary }, });
📖 For the vitest CLI usage, please refer to its documentation.
Used extensions
Extension | Version | Loading condition(s) |
---|---|---|
@vitest/coverage-c8 | ||
@vitest/ui |
Available options
Options | Purpose |
---|---|
BASE_OPTIONS | Base options for general usage with Vitest |
WITH_COVERAGE_OPTIONS | Base options extended by options which uses a c8 coverage |
Security
🔐 For more information, please refer to the Security section at the root of the terminal-nerds/configs monorepo.
Contributing
🤝 Contributions of any kind are welcome!
Please refer to the monorepo (terminal-nerds/configs) project's CONTRIBUTING file for more information if you wish to get involved.
License
⚖️ For more information, please refer to the License section at the root of the terminal-nerds/configs monorepo.