4a5eb23302
This PR adds a `@nx/vite:setup-paths-plugin` generator to add
`nxViteTsPaths` plugin to all vite config files in the workspace. This
can also be used with init/add as follows:
```shell
nx add @nx/vite --setupPathsPlugin
nx g @nx/vite:init --setupPathsPlugin
```
Which takes a config such as:
```ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
export default defineConfig({
plugins: [react()],
})
```
And updates it to:
```ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
export default defineConfig({
plugins: [react(), nxViteTsPaths()],
})
```
Taking into account ESM (default) and CJS (deprecated).
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->
<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->
## Current Behavior
<!-- This is the behavior we have today -->
## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->
Fixes #
66 lines
2.1 KiB
JSON
66 lines
2.1 KiB
JSON
{
|
|
"name": "vitest",
|
|
"factory": "./src/generators/vitest/vitest-generator#vitestGeneratorInternal",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "Vitest",
|
|
"title": "Vitest",
|
|
"type": "object",
|
|
"description": "Generate a Vitest setup for a project.",
|
|
"properties": {
|
|
"project": {
|
|
"type": "string",
|
|
"description": "The name of the project to test.",
|
|
"$default": { "$source": "projectName" }
|
|
},
|
|
"uiFramework": {
|
|
"type": "string",
|
|
"enum": ["react", "none"],
|
|
"default": "none",
|
|
"description": "UI framework to use with vitest."
|
|
},
|
|
"inSourceTests": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not generate separate spec files and set up in-source testing."
|
|
},
|
|
"skipViteConfig": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Skip generating a vite config file."
|
|
},
|
|
"coverageProvider": {
|
|
"type": "string",
|
|
"enum": ["v8", "istanbul", "custom"],
|
|
"default": "v8",
|
|
"description": "Coverage provider to use."
|
|
},
|
|
"testTarget": {
|
|
"type": "string",
|
|
"description": "The test target of the project to be transformed to use the @nx/vite:test executor.",
|
|
"hidden": true
|
|
},
|
|
"skipFormat": {
|
|
"description": "Skip formatting files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
},
|
|
"testEnvironment": {
|
|
"description": "The vitest environment to use. See https://vitest.dev/config/#environment.",
|
|
"type": "string",
|
|
"enum": ["node", "jsdom", "happy-dom", "edge-runtime"]
|
|
}
|
|
},
|
|
"required": ["project"],
|
|
"presets": []
|
|
},
|
|
"description": "Generate a vitest configuration.",
|
|
"implementation": "/packages/vite/src/generators/vitest/vitest-generator#vitestGeneratorInternal.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/vite/src/generators/vitest/schema.json",
|
|
"type": "generator"
|
|
}
|