dc67660fec
- Update artifact generator schemas: - Clarify `path` is the artifact file path relative to the current working directory - Clarify `name` is the artifact symbol name - Remove prompt for `name` and remove it from the important options (won't be displayed by default in Nx Console generation UI, it will be part of the collapsed options) given that most of the time, it's meant to match the filename (last segment of the `path`) - Remove some leftover options related to the name and path formats that were previously missed - Fix an issue with NestJS generators - Fix an issue with Next `page` generator <!-- 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 --> ## 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 #
63 lines
2.7 KiB
JSON
63 lines
2.7 KiB
JSON
{
|
|
"name": "executor",
|
|
"factory": "./src/generators/executor/executor",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxPluginExecutor",
|
|
"title": "Create an Executor for an Nx Plugin",
|
|
"description": "Create an Executor for an Nx Plugin.",
|
|
"examplesFile": "## Examples\n\n{% tabs %}\n{% tab label=\"Basic executor\" %}\n\nCreate a new executor called `build` at `tools/my-plugin/src/executors/build.ts`:\n\n```bash\nnx g @nx/plugin:executor tools/my-plugin/src/executors/build\n```\n\n{% /tab %}\n{% tab label=\"With different exported name\" %}\n\nCreate a new executor called `custom` at `tools/my-plugin/src/executors/build.ts`:\n\n```bash\nnx g @nx/plugin:executor tools/my-plugin/src/executors/build --name=custom\n```\n\n{% /tab %}\n{% tab label=\"With custom hashing\" %}\n\nCreate a new executor called `build` at `tools/my-plugin/src/executors/build.ts`, that uses a custom hashing function:\n\n```bash\nnx g @nx/plugin:executor tools/my-plugin/src/executors/build --includeHasher\n```\n\n{% /tab %}\n{% /tabs %}\n",
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The file path to the executor without the file extension. Relative to the current working directory.",
|
|
"x-prompt": "What is the executor file path?",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-priority": "important"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The executor name to export in the plugin executors collection."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Executor description.",
|
|
"x-priority": "important"
|
|
},
|
|
"unitTestRunner": {
|
|
"type": "string",
|
|
"enum": ["jest", "none"],
|
|
"description": "Test runner to use for unit tests.",
|
|
"default": "jest"
|
|
},
|
|
"includeHasher": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Should the boilerplate for a custom hasher be generated?"
|
|
},
|
|
"skipLintChecks": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not add an eslint configuration for plugin json files."
|
|
},
|
|
"skipFormat": {
|
|
"type": "boolean",
|
|
"description": "Skip formatting files.",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
}
|
|
},
|
|
"required": ["path"],
|
|
"additionalProperties": false,
|
|
"presets": []
|
|
},
|
|
"description": "Create an executor for an Nx Plugin.",
|
|
"implementation": "/packages/plugin/src/generators/executor/executor.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/plugin/src/generators/executor/schema.json",
|
|
"type": "generator"
|
|
}
|