28c53f942b
<!-- 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 --> Artifact generators don't handle consistently receiving a file extension in the `path` option. ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> Artifact generators should handle receiving a file extension in the `path` option. If the file extension is passed, the file path will be treated as "complete" and used fully as provided. If the `path` provided doesn't contain a file extension, the default extension will be appended to it (or the one provided in a related option, e.g. `--language`, `--js`, etc) together with the suffix for generators that use it. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
81 lines
2.8 KiB
JSON
81 lines
2.8 KiB
JSON
{
|
|
"name": "component",
|
|
"factory": "./src/generators/component/component",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxVueComponent",
|
|
"title": "Create a Vue Component",
|
|
"description": "Create a Vue Component for Nx.",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"description": "Generate a component at `mylib/src/lib/foo.vue`",
|
|
"command": "nx g @nx/vue:component mylib/src/lib/foo.vue"
|
|
},
|
|
{
|
|
"description": "Generate a component without providing the file extension at `mylib/src/lib/foo.vue`",
|
|
"command": "nx g @nx/vue:component mylib/src/lib/foo"
|
|
},
|
|
{
|
|
"description": "Generate a component at `mylib/src/lib/foo.vue` with `vitest` as the unit test runner",
|
|
"command": "nx g @nx/vue:component mylib/src/lib/foo --unitTestRunner=vitest"
|
|
}
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The file path to the component. Relative to the current working directory.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What is the component file path?"
|
|
},
|
|
"js": {
|
|
"type": "boolean",
|
|
"description": "Generate JavaScript files rather than TypeScript files.",
|
|
"default": false
|
|
},
|
|
"skipTests": {
|
|
"type": "boolean",
|
|
"description": "When true, does not create `spec.ts` test files for the new component.",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
},
|
|
"export": {
|
|
"type": "boolean",
|
|
"description": "When true, the component is exported from the project `index.ts` (if it exists).",
|
|
"alias": "e",
|
|
"default": false,
|
|
"x-prompt": "Should this component be exported in the project?"
|
|
},
|
|
"routing": {
|
|
"type": "boolean",
|
|
"description": "Generate a library with routes."
|
|
},
|
|
"fileName": {
|
|
"type": "string",
|
|
"description": "Create a component with this file name."
|
|
},
|
|
"inSourceTests": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html"
|
|
},
|
|
"skipFormat": {
|
|
"description": "Skip formatting files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
}
|
|
},
|
|
"required": ["path"],
|
|
"presets": []
|
|
},
|
|
"aliases": ["c"],
|
|
"x-type": "component",
|
|
"description": "Create a Vue component.",
|
|
"implementation": "/packages/vue/src/generators/component/component.ts",
|
|
"hidden": false,
|
|
"path": "/packages/vue/src/generators/component/schema.json",
|
|
"type": "generator"
|
|
}
|