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 #
128 lines
4.7 KiB
JSON
128 lines
4.7 KiB
JSON
{
|
|
"name": "scam",
|
|
"factory": "./src/generators/scam/scam",
|
|
"schema": {
|
|
"$schema": "http://json-schema.org/draft-07/schema",
|
|
"$id": "SCAMGenerator",
|
|
"cli": "nx",
|
|
"title": "SCAM Generator Options Schema",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"description": "Generate a component with the exported symbol matching the file name. It results in the component `FooComponent` at `mylib/src/lib/foo.component.ts`",
|
|
"command": "nx g @nx/angular:scam mylib/src/lib/foo"
|
|
},
|
|
{
|
|
"description": "Generate a component with the exported symbol different from the file name. It results in the component `CustomComponent` at `mylib/src/lib/foo.component.ts`",
|
|
"command": "nx g @nx/angular:scam mylib/src/lib/foo --name=custom"
|
|
}
|
|
],
|
|
"description": "Creates a new Angular SCAM.",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The file path to the SCAM without the file extension and suffix. Relative to the current working directory.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What is the SCAM file path?"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The component symbol name. Defaults to the last segment of the file path."
|
|
},
|
|
"displayBlock": {
|
|
"description": "Specifies if the style will contain `:host { display: block; }`.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"alias": "b"
|
|
},
|
|
"inlineStyle": {
|
|
"description": "Include styles inline in the `component.ts` file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the `component.ts` file.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"alias": "s"
|
|
},
|
|
"inlineTemplate": {
|
|
"description": "Include template inline in the `component.ts` file. By default, an external template file is created and referenced in the `component.ts` file.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"alias": "t"
|
|
},
|
|
"viewEncapsulation": {
|
|
"description": "The view encapsulation strategy to use in the new component.",
|
|
"enum": ["Emulated", "None", "ShadowDom"],
|
|
"type": "string",
|
|
"alias": "v"
|
|
},
|
|
"changeDetection": {
|
|
"description": "The change detection strategy to use in the new component.",
|
|
"enum": ["Default", "OnPush"],
|
|
"type": "string",
|
|
"default": "Default",
|
|
"alias": "c"
|
|
},
|
|
"style": {
|
|
"description": "The file extension or preprocessor to use for style files, or 'none' to skip generating the style file.",
|
|
"type": "string",
|
|
"default": "css",
|
|
"enum": ["css", "scss", "sass", "less", "none"]
|
|
},
|
|
"skipTests": {
|
|
"type": "boolean",
|
|
"description": "Do not create `spec.ts` test files for the new component.",
|
|
"default": false
|
|
},
|
|
"inlineScam": {
|
|
"type": "boolean",
|
|
"description": "Create the `NgModule` in the same file as the component.",
|
|
"default": true,
|
|
"x-priority": "important"
|
|
},
|
|
"selector": {
|
|
"type": "string",
|
|
"format": "html-selector",
|
|
"description": "The `HTML` selector to use for this component."
|
|
},
|
|
"skipSelector": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Specifies if the component should have a selector or not."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Adds a developer-defined type to the filename, in the format `name.type.ts`.",
|
|
"default": "component"
|
|
},
|
|
"prefix": {
|
|
"type": "string",
|
|
"description": "The prefix to apply to the generated component selector.",
|
|
"alias": "p",
|
|
"oneOf": [
|
|
{ "maxLength": 0 },
|
|
{ "minLength": 1, "format": "html-selector" }
|
|
]
|
|
},
|
|
"export": {
|
|
"type": "boolean",
|
|
"description": "Specifies if the SCAM should be exported from the project's entry point (normally `index.ts`). It only applies to libraries.",
|
|
"default": true,
|
|
"x-priority": "important"
|
|
},
|
|
"skipFormat": {
|
|
"type": "boolean",
|
|
"description": "Skip formatting files.",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
}
|
|
},
|
|
"required": ["path"],
|
|
"presets": []
|
|
},
|
|
"description": "Generate a component with an accompanying Single Component Angular Module (SCAM).",
|
|
"implementation": "/packages/angular/src/generators/scam/scam.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/angular/src/generators/scam/schema.json",
|
|
"type": "generator"
|
|
}
|