bc8b71ac6c
<!-- 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 --> Currently, when we use generator's via the CLI passing the `name` arg has more than one responsibility: 1. it can be used as a path 2. it can be used as the generator's name (e.g. Component name) This is not intuitive as if we use via Nx Console because it creates some ambiguity around the `--name` property which is normally described as only 2.  ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> What is expected is that the `name` property should only have the responsibility of determining the name of the generated module (Component, Directive etc...). The new property `path` replaces the `directory` property but fulfils the same purpose as determining where the module should be created. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes # --------- Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
71 lines
2.6 KiB
JSON
71 lines
2.6 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` inside the plugin `my-plugin`:\n\n```bash\nnx g @nx/plugin:executor tools/my-plugin/src/executors/build\n```\n\n{% /tab %}\n{% tab label=\"With custom hashing\" %}\n\nCreate a new executor called `build` inside the plugin `my-plugin`, 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",
|
|
"examples": [
|
|
{
|
|
"command": "nx g executor my-executor --project=my-plugin",
|
|
"description": "Generate `libs/my-plugin/src/executors/my-executor`"
|
|
}
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "Path at which to generate the executor file.",
|
|
"x-prompt": "What path would you like to use for the executor?",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-priority": "important"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Executor name.",
|
|
"x-prompt": "What name would you like to use for the executor?",
|
|
"x-priority": "important"
|
|
},
|
|
"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"
|
|
}
|