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 #
78 lines
2.6 KiB
JSON
78 lines
2.6 KiB
JSON
{
|
|
"name": "pipe",
|
|
"factory": "./src/generators/pipe/pipe",
|
|
"schema": {
|
|
"$schema": "http://json-schema.org/draft-07/schema",
|
|
"$id": "SchematicsAngularPipe",
|
|
"title": "Angular Pipe Options Schema",
|
|
"type": "object",
|
|
"cli": "nx",
|
|
"additionalProperties": false,
|
|
"description": "Creates an Angular pipe.",
|
|
"examples": [
|
|
{
|
|
"description": "Generate a pipe with the exported symbol matching the file name. It results in the pipe `FooPipe` at `mylib/src/lib/foo.pipe.ts`",
|
|
"command": "nx g @nx/angular:pipe mylib/src/lib/foo.pipe.ts"
|
|
},
|
|
{
|
|
"description": "Generate a pipe without providing the file extension. It results in the pipe `FooPipe` at `mylib/src/lib/foo.pipe.ts`",
|
|
"command": "nx g @nx/angular:pipe mylib/src/lib/foo"
|
|
},
|
|
{
|
|
"description": "Generate a pipe with the exported symbol different from the file name. It results in the pipe `CustomPipe` at `mylib/src/lib/foo.pipe.ts`",
|
|
"command": "nx g @nx/angular:pipe mylib/src/lib/foo --name=custom"
|
|
}
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The file path to the pipe. Relative to the current working directory.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What is the pipe file path?"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The pipe symbol name. Defaults to the last segment of the file path."
|
|
},
|
|
"skipTests": {
|
|
"type": "boolean",
|
|
"description": "Do not create \"spec.ts\" test files for the new pipe.",
|
|
"default": false
|
|
},
|
|
"skipImport": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not import this pipe into the owning NgModule."
|
|
},
|
|
"standalone": {
|
|
"description": "Whether the generated pipe is standalone.",
|
|
"type": "boolean",
|
|
"default": true
|
|
},
|
|
"module": {
|
|
"type": "string",
|
|
"description": "The filename of the declaring NgModule.",
|
|
"alias": "m"
|
|
},
|
|
"export": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "The declaring NgModule exports this pipe."
|
|
},
|
|
"skipFormat": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Skip formatting of files."
|
|
}
|
|
},
|
|
"required": ["path"],
|
|
"presets": []
|
|
},
|
|
"description": "Generate an Angular Pipe",
|
|
"aliases": ["p"],
|
|
"implementation": "/packages/angular/src/generators/pipe/pipe.ts",
|
|
"hidden": false,
|
|
"path": "/packages/angular/src/generators/pipe/schema.json",
|
|
"type": "generator"
|
|
}
|