<!-- 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` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> Nx Plugin do not have the option to use Vitest as test runner ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> This PR allow us to use Vitest as test runner in plugins projects. Vitest for e2e targets is still missing and a new PR will be raised after https://github.com/nrwl/nx/issues/29139 is fixed ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #22882
71 lines
2.5 KiB
JSON
71 lines
2.5 KiB
JSON
{
|
|
"name": "generator",
|
|
"factory": "./src/generators/generator/generator",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxPluginGenerator",
|
|
"title": "Create a Generator for an Nx Plugin",
|
|
"description": "Create a Generator for an Nx Plugin.",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"description": "Generate a generator exported with the name matching the file name. It results in the generator `foo` at `mylib/src/generators/foo.ts`",
|
|
"command": "nx g @nx/plugin:generator mylib/src/generators/foo.ts"
|
|
},
|
|
{
|
|
"description": "Generate a generator without providing the file extension. It results in the generator `foo` at `mylib/src/generators/foo.ts`",
|
|
"command": "nx g @nx/plugin:generator mylib/src/generators/foo"
|
|
},
|
|
{
|
|
"description": "Generate a generator exported with a different name from the file name. It results in the generator `custom` at `mylib/src/generators/foo.ts`",
|
|
"command": "nx g @nx/plugin:generator mylib/src/generators/foo --name=custom"
|
|
}
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The file path to the generator. Relative to the current working directory.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What is the generator file path?",
|
|
"x-priority": "important"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The generator name to export in the plugin generators collection."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Generator description.",
|
|
"x-priority": "important"
|
|
},
|
|
"unitTestRunner": {
|
|
"type": "string",
|
|
"enum": ["jest", "vitest", "none"],
|
|
"description": "Test runner to use for unit tests.",
|
|
"default": "jest"
|
|
},
|
|
"skipLintChecks": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not add an eslint configuration for plugin json files."
|
|
},
|
|
"skipFormat": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not format files with prettier.",
|
|
"x-priority": "internal"
|
|
}
|
|
},
|
|
"required": ["path"],
|
|
"additionalProperties": false,
|
|
"presets": []
|
|
},
|
|
"description": "Create a generator for an Nx Plugin.",
|
|
"implementation": "/packages/plugin/src/generators/generator/generator.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/plugin/src/generators/generator/schema.json",
|
|
"type": "generator"
|
|
}
|