miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

feat(angular): add priority flags to generators (#14299)

Browse Source
This commit is contained in:
Colum Ferry 2023-01-16 12:19:33 +00:00 committed by GitHub
parent c86a361e1c
commit a22bd54f3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
64 changed files with 470 additions and 236 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/generated/packages/angular/generators/add-linting.json
View File

@ -18,15 +18,18 @@
"prefix": {
"type": "string",
"format": "html-selector",
"description": "The prefix to apply to generated selectors."
"description": "The prefix to apply to generated selectors.",
"x-priority": "important"
},
"projectName": {
"type": "string",
"description": "The name of the project."
"description": "The name of the project.",
"x-priority": "important"
},
"projectRoot": {
"type": "string",
"description": "The path to the root of the selected project."
"description": "The path to the root of the selected project.",
"x-priority": "important"
},
"setParserOptionsProject": {
"type": "boolean",
@ -36,12 +39,14 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

18
docs/generated/packages/angular/generators/application.json
View File

@ -18,7 +18,8 @@
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
"type": "string",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -49,7 +50,8 @@
"type": "boolean",
"description": "Generate a routing module.",
"default": false,
"x-prompt": "Would you like to configure routing for this application?"
"x-prompt": "Would you like to configure routing for this application?",
"x-priority": "important"
},
"inlineStyle": {
"description": "Specifies if the style will be in the ts file.",
@ -83,12 +85,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -123,7 +127,8 @@
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
"type": "boolean",
"x-priority": "internal"
},
"port": {
"type": "number",
@ -148,7 +153,8 @@
"description": "Create an application at the root of the workspace.",
"type": "boolean",
"default": false,
"hidden": true
"hidden": true,
"x-priority": "internal"
}
},
"additionalProperties": false,

3
docs/generated/packages/angular/generators/change-storybook-targets.json
View File

@ -12,7 +12,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

18
docs/generated/packages/angular/generators/component-cypress-spec.json
View File

@ -11,27 +11,32 @@
"projectName": {
"type": "string",
"description": "The name of the project.",
"examples": ["ui-samples"]
"examples": ["ui-samples"],
"x-priority": "important"
},
"projectPath": {
"type": "string",
"description": "Path to the project.",
"examples": ["libs/ui-samples"]
"examples": ["libs/ui-samples"],
"x-priority": "important"
},
"componentName": {
"type": "string",
"description": "Class name of the component.",
"examples": ["AwesomeComponent"]
"examples": ["AwesomeComponent"],
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the project root.",
"examples": ["awesome"]
"examples": ["awesome"],
"x-priority": "important"
},
"componentFileName": {
"type": "string",
"description": "Component file name without the `.ts` extension.",
"examples": ["awesome.component"]
"examples": ["awesome.component"],
"x-priority": "important"
},
"cypressProject": {
"type": "string",
@ -44,7 +49,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

15
docs/generated/packages/angular/generators/component-story.json
View File

@ -11,27 +11,32 @@
"projectPath": {
"type": "string",
"description": "Path to the project.",
"examples": ["libs/ui-samples"]
"examples": ["libs/ui-samples"],
"x-priority": "important"
},
"componentName": {
"type": "string",
"description": "Class name of the component.",
"examples": ["AwesomeComponent"]
"examples": ["AwesomeComponent"],
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the project root.",
"examples": ["awesome"]
"examples": ["awesome"],
"x-priority": "important"
},
"componentFileName": {
"type": "string",
"description": "Component file name without the `.ts` extension.",
"examples": ["awesome.component"]
"examples": ["awesome.component"],
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

15
docs/generated/packages/angular/generators/component-test.json
View File

@ -12,30 +12,35 @@
"type": "string",
"description": "The name of the project where the component is located.",
"x-dropdown": "projects",
"x-prompt": "What project is the component located in?"
"x-prompt": "What project is the component located in?",
"x-priority": "important"
},
"componentName": {
"type": "string",
"description": "Class name of the component to create a test for.",
"examples": ["MyFancyButtonComponent"],
"x-prompt": "What is the class name of the component to create a test for?"
"x-prompt": "What is the class name of the component to create a test for?",
"x-priority": "important"
},
"componentDir": {
"type": "string",
"description": "Relative path to the folder that contains the component from the project root.",
"examples": ["src/lib/my-fancy-button"],
"x-prompt": "What is the path to the component directory from the project root?"
"x-prompt": "What is the path to the component directory from the project root?",
"x-priority": "important"
},
"componentFileName": {
"type": "string",
"description": "File name that contains the component without the `.ts` extension.",
"examples": ["my-fancy-button.component"],
"x-prompt": "What is the file name that contains the component?"
"x-prompt": "What is the file name that contains the component?",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

9
docs/generated/packages/angular/generators/component.json
View File

@ -19,7 +19,8 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
@ -48,7 +49,8 @@
"standalone": {
"description": "Whether the generated component is standalone. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean",
"default": false
"default": false,
"x-priority": "important"
},
"viewEncapsulation": {
"description": "The view encapsulation strategy to use in the new component.",
@ -107,7 +109,8 @@
"export": {
"type": "boolean",
"description": "Specifies if the component should be exported in the declaring `NgModule`. Additionally, if the project is a library, the component will be exported from the project's entry point (normally `index.ts`) if the module it belongs to is also exported or if the component is standalone.",
"default": false
"default": false,
"x-priority": "important"
}
},
"required": ["name"],

3
docs/generated/packages/angular/generators/convert-to-with-mf.json
View File

@ -20,7 +20,8 @@
"type": "string",
"description": "The name of the micro frontend project to migrate.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What micro frontend project would you like to migrate?"
"x-prompt": "What micro frontend project would you like to migrate?",
"x-priority": "important"
}
},
"presets": []

6
docs/generated/packages/angular/generators/convert-tslint-to-eslint.json
View File

@ -27,7 +27,8 @@
"description": "The name of the Angular project to convert. Please note, if the project is an Angular app with an associated Cypress e2e project, it will also attempt to convert that.",
"type": "string",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "Which Angular project would you like to convert from TSLint to ESLint?"
"x-prompt": "Which Angular project would you like to convert from TSLint to ESLint?",
"x-priority": "important"
},
"ignoreExistingTslintConfig": {
"type": "boolean",
@ -44,7 +45,8 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

9
docs/generated/packages/angular/generators/cypress-component-configuration.json
View File

@ -13,7 +13,8 @@
"type": "string",
"description": "The name of the project to add cypress component testing configuration to",
"x-dropdown": "projects",
"x-prompt": "What project should we add Cypress component testing to?"
"x-prompt": "What project should we add Cypress component testing to?",
"x-priority": "important"
},
"generateTests": {
"type": "boolean",
@ -24,12 +25,14 @@
"buildTarget": {
"type": "string",
"description": "A build target used to configure Cypress component testing in the format of `project:target[:configuration]`. The build target should be an angular app. If not provided we will try to infer it from your projects usage.",
"pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$"
"pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files",
"default": false
"default": false,
"x-priority": "internal"
}
},
"required": ["project"],

12
docs/generated/packages/angular/generators/downgrade-module.json
View File

@ -11,12 +11,14 @@
"properties": {
"project": {
"type": "string",
"description": "The name of the project."
"description": "The name of the project.",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the main AngularJS module.",
"$default": { "$source": "argv", "index": 0 }
"$default": { "$source": "argv", "index": 0 },
"x-priority": "important"
},
"angularJsImport": {
"type": "string",
@ -25,12 +27,14 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"description": "Do not add `@angular/upgrade` to `package.json` (e.g., `--skipPackageJson`).",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

15
docs/generated/packages/angular/generators/host.json
View File

@ -22,7 +22,8 @@
},
"remotes": {
"type": "array",
"description": "The names of the remote applications to add to the host."
"description": "The names of the remote applications to add to the host.",
"x-priority": "important"
},
"dynamic": {
"type": "boolean",
@ -90,12 +91,14 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipPostInstall": {
"type": "boolean",
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`."
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -145,7 +148,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"standalone": {
"type": "boolean",
@ -155,7 +159,8 @@
"ssr": {
"description": "Whether to configure SSR for the host application",
"type": "boolean",
"default": false
"default": false,
"x-priority": "important"
}
},
"additionalProperties": false,

18
docs/generated/packages/angular/generators/init.json
View File

@ -19,29 +19,34 @@
"type": "string",
"enum": ["karma", "jest", "none"],
"description": "Test runner to use for unit tests.",
"default": "jest"
"default": "jest",
"x-priority": "important"
},
"e2eTestRunner": {
"type": "string",
"enum": ["protractor", "cypress", "none"],
"description": "Test runner to use for end to end (e2e) tests.",
"default": "cypress"
"default": "cypress",
"x-priority": "important"
},
"skipInstall": {
"type": "boolean",
"description": "Skip installing after adding `@nrwl/workspace`.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"linter": {
"description": "The tool to use for running lint checks.",
"type": "string",
"enum": ["eslint", "none"],
"default": "eslint"
"default": "eslint",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -71,7 +76,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

9
docs/generated/packages/angular/generators/karma-project.json
View File

@ -12,17 +12,20 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"description": "Skip updating package.json.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

3
docs/generated/packages/angular/generators/karma.json
View File

@ -18,7 +18,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

6
docs/generated/packages/angular/generators/library-secondary-entry-point.json
View File

@ -14,14 +14,16 @@
"description": "The name of the secondary entry point.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the secondary entry point?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"library": {
"type": "string",
"description": "The name of the library to create the secondary entry point for.",
"x-prompt": "What library would you like to create the secondary entry point for?",
"pattern": "^[a-zA-Z].*$",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"skipModule": {
"type": "boolean",

27
docs/generated/packages/angular/generators/library.json
View File

@ -18,17 +18,20 @@
},
"directory": {
"type": "string",
"description": "A directory where the library is placed."
"description": "A directory where the library is placed.",
"x-priority": "important"
},
"publishable": {
"type": "boolean",
"default": false,
"description": "Generate a publishable library."
"description": "Generate a publishable library.",
"x-priority": "important"
},
"buildable": {
"type": "boolean",
"default": false,
"description": "Generate a buildable library."
"description": "Generate a buildable library.",
"x-priority": "important"
},
"prefix": {
"type": "string",
@ -39,7 +42,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"simpleModuleName": {
"description": "Keep the module name simple (when using `--directory`).",
@ -60,7 +64,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipTsConfig": {
"type": "boolean",
@ -70,16 +75,19 @@
"routing": {
"type": "boolean",
"default": false,
"description": "Add router configuration. See `lazy` for more information."
"description": "Add router configuration. See `lazy` for more information.",
"x-priority": "important"
},
"lazy": {
"type": "boolean",
"default": false,
"description": "Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false."
"description": "Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false.",
"x-priority": "important"
},
"parent": {
"type": "string",
"description": "Path to the parent route configuration using `loadChildren` or `children`, depending on what `lazy` is set to."
"description": "Path to the parent route configuration using `loadChildren` or `children`, depending on what `lazy` is set to.",
"x-priority": "important"
},
"tags": {
"type": "string",
@ -108,7 +116,8 @@
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
"type": "boolean",
"x-priority": "internal"
},
"compilationMode": {
"description": "Specifies the compilation mode to use. If not specified, it will default to `partial` for publishable libraries and to `full` for buildable libraries. The `full` value can not be used for publishable libraries.",

9
docs/generated/packages/angular/generators/move.json
View File

@ -19,12 +19,14 @@
"type": "string",
"alias": "project",
"description": "The name of the Angular project to move.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"destination": {
"type": "string",
"description": "The folder to move the Angular project into.",
"$default": { "$source": "argv", "index": 0 }
"$default": { "$source": "argv", "index": 0 },
"x-priority": "important"
},
"importPath": {
"type": "string",
@ -39,7 +41,8 @@
"type": "boolean",
"aliases": ["skip-format"],
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
}
},
"required": ["projectName", "destination"],

21
docs/generated/packages/angular/generators/ng-add.json
View File

@ -11,21 +11,25 @@
"properties": {
"npmScope": {
"type": "string",
"description": "Npm scope for importing libs. NOTE: only used if running the generator in an Angular CLI workspace."
"description": "Npm scope for importing libs. NOTE: only used if running the generator in an Angular CLI workspace.",
"x-priority": "important"
},
"defaultBase": {
"type": "string",
"description": "Default base branch for affected. NOTE: only used if running the generator in an Angular CLI workspace."
"description": "Default base branch for affected. NOTE: only used if running the generator in an Angular CLI workspace.",
"x-priority": "important"
},
"skipInstall": {
"type": "boolean",
"description": "Skip installing added packages.",
"default": false
"default": false,
"x-priority": "internal"
},
"preserveAngularCliLayout": {
"type": "boolean",
"description": "Preserve the Angular CLI layout instead of moving the app into apps. NOTE: only used if running the generator in an Angular CLI workspace.",
"default": false
"default": false,
"x-priority": "important"
},
"unitTestRunner": {
"type": "string",
@ -42,7 +46,8 @@
"skipFormat": {
"description": "Skip formatting files. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"linter": {
"description": "The tool to use for running lint checks. NOTE: only used if running the generator in an Nx workspace.",
@ -59,12 +64,14 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`. NOTE: only used if running the generator in an Nx workspace."
"description": "Do not add dependencies to `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"x-priority": "internal"
},
"skipPostInstall": {
"type": "boolean",
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`. NOTE: only used if running the generator in an Nx workspace."
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"x-priority": "internal"
}
},
"additionalProperties": false,

17
docs/generated/packages/angular/generators/ngrx.json
View File

@ -23,7 +23,8 @@
"type": "string",
"description": "Name of the NgRx feature state, such as `products` or `users`. Recommended to use the plural form of the name.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`."
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`.",
"x-priority": "important"
},
"module": {
"type": "string",
@ -32,8 +33,9 @@
},
"parent": {
"type": "string",
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?"
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. The host directory will create/use the new state directory. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?",
"x-priority": "important"
},
"route": {
"type": "string",
@ -49,7 +51,8 @@
"type": "boolean",
"default": false,
"description": "Setup root or feature state management with NgRx.",
"x-prompt": "Is this the root state of the application?"
"x-prompt": "Is this the root state of the application?",
"x-priority": "important"
},
"facade": {
"type": "boolean",
@ -70,12 +73,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not update the `package.json` with NgRx dependencies."
"description": "Do not update the `package.json` with NgRx dependencies.",
"x-priority": "internal"
},
"barrels": {
"type": "boolean",

9
docs/generated/packages/angular/generators/remote.json
View File

@ -23,7 +23,8 @@
"host": {
"type": "string",
"description": "The name of the host app to attach this remote app to.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"port": {
"type": "number",
@ -90,7 +91,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -140,7 +142,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"standalone": {
"description": "Whether to generate a remote application with standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",

12
docs/generated/packages/angular/generators/scam-directive.json
View File

@ -25,13 +25,15 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the directive.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the directive?"
"x-prompt": "What name would you like to use for the directive?",
"x-priority": "important"
},
"skipTests": {
"type": "boolean",
@ -41,7 +43,8 @@
"inlineScam": {
"type": "boolean",
"description": "Create the `NgModule` in the same file as the Directive.",
"default": true
"default": true,
"x-priority": "important"
},
"flat": {
"type": "boolean",
@ -65,7 +68,8 @@
"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
"default": true,
"x-priority": "important"
}
},
"required": ["name"],

12
docs/generated/packages/angular/generators/scam-pipe.json
View File

@ -25,13 +25,15 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the pipe.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the pipe?"
"x-prompt": "What name would you like to use for the pipe?",
"x-priority": "important"
},
"skipTests": {
"type": "boolean",
@ -41,7 +43,8 @@
"inlineScam": {
"type": "boolean",
"description": "Create the NgModule in the same file as the Pipe.",
"default": true
"default": true,
"x-priority": "important"
},
"flat": {
"type": "boolean",
@ -51,7 +54,8 @@
"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
"default": true,
"x-priority": "important"
}
},
"required": ["name"],

9
docs/generated/packages/angular/generators/scam-to-standalone.json
View File

@ -12,17 +12,20 @@
"component": {
"type": "string",
"description": "The path to the SCAM component file, relative to the root of the project containing the SCAM.",
"$default": { "$source": "argv", "index": 0 }
"$default": { "$source": "argv", "index": 0 },
"x-priority": "important"
},
"project": {
"type": "string",
"description": "The project containing the SCAM.",
"x-prompt": "What project contains the SCAM?",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
}
},
"examplesFile": "## Examples\n\n{% tabs %}\n\n{% tab label=\"Basic Usage\" %}\n\nThis generator allows you to convert an Inline SCAM to a Standalone Component. It's important that the SCAM you wish to convert has it's NgModule within the same file for the generator to be able to correctly convert the component to Standalone.\n\n```bash\n\nnx g @nrwl/angular:scam-to-standalone --component=libs/mylib/src/lib/myscam/myscam.component.ts --project=mylib\n\n```\n\n{% /tab %}\n\n{% /tabs %}\n",

9
docs/generated/packages/angular/generators/scam.json
View File

@ -25,7 +25,8 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
@ -78,7 +79,8 @@
"inlineScam": {
"type": "boolean",
"description": "Create the `NgModule` in the same file as the component.",
"default": true
"default": true,
"x-priority": "important"
},
"flat": {
"type": "boolean",
@ -112,7 +114,8 @@
"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
"default": true,
"x-priority": "important"
}
},
"required": ["name"],

9
docs/generated/packages/angular/generators/setup-mf.json
View File

@ -42,16 +42,19 @@
},
"routing": {
"type": "boolean",
"description": "Generate a routing setup to allow a host application to route to the remote application."
"description": "Generate a routing setup to allow a host application to route to the remote application.",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipE2E": {
"type": "boolean",

3
docs/generated/packages/angular/generators/setup-ssr.json
View File

@ -51,7 +51,8 @@
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
}
},
"required": ["project"],

6
docs/generated/packages/angular/generators/setup-tailwind.json
View File

@ -22,7 +22,8 @@
},
"skipFormat": {
"type": "boolean",
"description": "Skips formatting the workspace after the generator completes."
"description": "Skips formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"stylesEntryPoint": {
"type": "string",
@ -31,7 +32,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

9
docs/generated/packages/angular/generators/stories.json
View File

@ -15,12 +15,14 @@
"description": "Project for which to generate stories.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What's the name of the project for which you want to generate stories?",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"generateCypressSpecs": {
"type": "boolean",
"description": "Specifies whether to automatically generate `*.spec.ts` files in the Cypress e2e app generated by the `cypress-configure` generator.",
"x-prompt": "Do you want to generate Cypress specs as well?"
"x-prompt": "Do you want to generate Cypress specs as well?",
"x-priority": "important"
},
"cypressProject": {
"type": "string",
@ -29,7 +31,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"ignorePaths": {
"type": "array",

3
docs/generated/packages/angular/generators/storybook-configuration.json
View File

@ -58,7 +58,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"ignorePaths": {
"type": "array",

15
docs/generated/packages/angular/generators/upgrade-module.json
View File

@ -11,12 +11,14 @@
"properties": {
"project": {
"type": "string",
"description": "The name of the project."
"description": "The name of the project.",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the main AngularJS module.",
"$default": { "$source": "argv", "index": 0 }
"$default": { "$source": "argv", "index": 0 },
"x-priority": "important"
},
"angularJsImport": {
"type": "string",
@ -29,17 +31,20 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"description": "Do not add `@angular/upgrade` to `package.json` (e.g., `--skipPackageJson`).",
"default": false
"default": false,
"x-priority": "internal"
},
"router": {
"type": "boolean",
"description": "Sets up router synchronization (e.g., `--router`).",
"default": false
"default": false,
"x-priority": "important"
}
},
"additionalProperties": false,

9
docs/generated/packages/angular/generators/web-worker.json
View File

@ -17,13 +17,15 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
"description": "The name of the worker.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the worker?"
"x-prompt": "What name would you like to use for the worker?",
"x-priority": "important"
},
"snippet": {
"type": "boolean",
@ -33,7 +35,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

15
packages/angular/src/generators/add-linting/schema.json
View File

@ -15,15 +15,18 @@
"prefix": {
"type": "string",
"format": "html-selector",
"description": "The prefix to apply to generated selectors."
"description": "The prefix to apply to generated selectors.",
"x-priority": "important"
},
"projectName": {
"type": "string",
"description": "The name of the project."
"description": "The name of the project.",
"x-priority": "important"
},
"projectRoot": {
"type": "string",
"description": "The path to the root of the selected project."
"description": "The path to the root of the selected project.",
"x-priority": "important"
},
"setParserOptionsProject": {
"type": "boolean",
@ -33,12 +36,14 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

18
packages/angular/src/generators/application/schema.json
View File

@ -18,7 +18,8 @@
},
"directory": {
"description": "The directory of the new application.",
"type": "string"
"type": "string",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -52,7 +53,8 @@
"type": "boolean",
"description": "Generate a routing module.",
"default": false,
"x-prompt": "Would you like to configure routing for this application?"
"x-prompt": "Would you like to configure routing for this application?",
"x-priority": "important"
},
"inlineStyle": {
"description": "Specifies if the style will be in the ts file.",
@ -86,12 +88,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -126,7 +130,8 @@
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
"type": "boolean",
"x-priority": "internal"
},
"port": {
"type": "number",
@ -151,7 +156,8 @@
"description": "Create an application at the root of the workspace.",
"type": "boolean",
"default": false,
"hidden": true
"hidden": true,
"x-priority": "internal"
}
},
"additionalProperties": false,

3
packages/angular/src/generators/change-storybook-targets/schema.json
View File

@ -9,7 +9,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

18
packages/angular/src/generators/component-cypress-spec/schema.json
View File

@ -8,27 +8,32 @@
"projectName": {
"type": "string",
"description": "The name of the project.",
"examples": ["ui-samples"]
"examples": ["ui-samples"],
"x-priority": "important"
},
"projectPath": {
"type": "string",
"description": "Path to the project.",
"examples": ["libs/ui-samples"]
"examples": ["libs/ui-samples"],
"x-priority": "important"
},
"componentName": {
"type": "string",
"description": "Class name of the component.",
"examples": ["AwesomeComponent"]
"examples": ["AwesomeComponent"],
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the project root.",
"examples": ["awesome"]
"examples": ["awesome"],
"x-priority": "important"
},
"componentFileName": {
"type": "string",
"description": "Component file name without the `.ts` extension.",
"examples": ["awesome.component"]
"examples": ["awesome.component"],
"x-priority": "important"
},
"cypressProject": {
"type": "string",
@ -41,7 +46,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

15
packages/angular/src/generators/component-story/schema.json
View File

@ -8,27 +8,32 @@
"projectPath": {
"type": "string",
"description": "Path to the project.",
"examples": ["libs/ui-samples"]
"examples": ["libs/ui-samples"],
"x-priority": "important"
},
"componentName": {
"type": "string",
"description": "Class name of the component.",
"examples": ["AwesomeComponent"]
"examples": ["AwesomeComponent"],
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the project root.",
"examples": ["awesome"]
"examples": ["awesome"],
"x-priority": "important"
},
"componentFileName": {
"type": "string",
"description": "Component file name without the `.ts` extension.",
"examples": ["awesome.component"]
"examples": ["awesome.component"],
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

15
packages/angular/src/generators/component-test/schema.json
View File

@ -9,30 +9,35 @@
"type": "string",
"description": "The name of the project where the component is located.",
"x-dropdown": "projects",
"x-prompt": "What project is the component located in?"
"x-prompt": "What project is the component located in?",
"x-priority": "important"
},
"componentName": {
"type": "string",
"description": "Class name of the component to create a test for.",
"examples": ["MyFancyButtonComponent"],
"x-prompt": "What is the class name of the component to create a test for?"
"x-prompt": "What is the class name of the component to create a test for?",
"x-priority": "important"
},
"componentDir": {
"type": "string",
"description": "Relative path to the folder that contains the component from the project root.",
"examples": ["src/lib/my-fancy-button"],
"x-prompt": "What is the path to the component directory from the project root?"
"x-prompt": "What is the path to the component directory from the project root?",
"x-priority": "important"
},
"componentFileName": {
"type": "string",
"description": "File name that contains the component without the `.ts` extension.",
"examples": ["my-fancy-button.component"],
"x-prompt": "What is the file name that contains the component?"
"x-prompt": "What is the file name that contains the component?",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

9
packages/angular/src/generators/component/schema.json
View File

@ -16,7 +16,8 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
@ -48,7 +49,8 @@
"standalone": {
"description": "Whether the generated component is standalone. _Note: This is only supported in Angular versions >= 14.1.0_",
"type": "boolean",
"default": false
"default": false,
"x-priority": "important"
},
"viewEncapsulation": {
"description": "The view encapsulation strategy to use in the new component.",
@ -107,7 +109,8 @@
"export": {
"type": "boolean",
"description": "Specifies if the component should be exported in the declaring `NgModule`. Additionally, if the project is a library, the component will be exported from the project's entry point (normally `index.ts`) if the module it belongs to is also exported or if the component is standalone.",
"default": false
"default": false,
"x-priority": "important"
}
},
"required": ["name"],

3
packages/angular/src/generators/convert-to-with-mf/schema.json
View File

@ -20,7 +20,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What micro frontend project would you like to migrate?"
"x-prompt": "What micro frontend project would you like to migrate?",
"x-priority": "important"
}
}
}

6
packages/angular/src/generators/convert-tslint-to-eslint/schema.json
View File

@ -27,7 +27,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "Which Angular project would you like to convert from TSLint to ESLint?"
"x-prompt": "Which Angular project would you like to convert from TSLint to ESLint?",
"x-priority": "important"
},
"ignoreExistingTslintConfig": {
"type": "boolean",
@ -44,7 +45,8 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

9
packages/angular/src/generators/cypress-component-configuration/schema.json
View File

@ -10,7 +10,8 @@
"type": "string",
"description": "The name of the project to add cypress component testing configuration to",
"x-dropdown": "projects",
"x-prompt": "What project should we add Cypress component testing to?"
"x-prompt": "What project should we add Cypress component testing to?",
"x-priority": "important"
},
"generateTests": {
"type": "boolean",
@ -21,12 +22,14 @@
"buildTarget": {
"type": "string",
"description": "A build target used to configure Cypress component testing in the format of `project:target[:configuration]`. The build target should be an angular app. If not provided we will try to infer it from your projects usage.",
"pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$"
"pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files",
"default": false
"default": false,
"x-priority": "internal"
}
},
"required": ["project"],

12
packages/angular/src/generators/downgrade-module/schema.json
View File

@ -8,7 +8,8 @@
"properties": {
"project": {
"type": "string",
"description": "The name of the project."
"description": "The name of the project.",
"x-priority": "important"
},
"name": {
"type": "string",
@ -16,7 +17,8 @@
"$default": {
"$source": "argv",
"index": 0
}
},
"x-priority": "important"
},
"angularJsImport": {
"type": "string",
@ -25,12 +27,14 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"description": "Do not add `@angular/upgrade` to `package.json` (e.g., `--skipPackageJson`).",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

15
packages/angular/src/generators/host/schema.json
View File

@ -22,7 +22,8 @@
},
"remotes": {
"type": "array",
"description": "The names of the remote applications to add to the host."
"description": "The names of the remote applications to add to the host.",
"x-priority": "important"
},
"dynamic": {
"type": "boolean",
@ -93,12 +94,14 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipPostInstall": {
"type": "boolean",
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`."
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`.",
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -148,7 +151,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"standalone": {
"type": "boolean",
@ -158,7 +162,8 @@
"ssr": {
"description": "Whether to configure SSR for the host application",
"type": "boolean",
"default": false
"default": false,
"x-priority": "important"
}
},
"additionalProperties": false,

18
packages/angular/src/generators/init/schema.json
View File

@ -16,29 +16,34 @@
"type": "string",
"enum": ["karma", "jest", "none"],
"description": "Test runner to use for unit tests.",
"default": "jest"
"default": "jest",
"x-priority": "important"
},
"e2eTestRunner": {
"type": "string",
"enum": ["protractor", "cypress", "none"],
"description": "Test runner to use for end to end (e2e) tests.",
"default": "cypress"
"default": "cypress",
"x-priority": "important"
},
"skipInstall": {
"type": "boolean",
"description": "Skip installing after adding `@nrwl/workspace`.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"linter": {
"description": "The tool to use for running lint checks.",
"type": "string",
"enum": ["eslint", "none"],
"default": "eslint"
"default": "eslint",
"x-priority": "important"
},
"style": {
"description": "The file extension to be used for style files.",
@ -71,7 +76,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false

9
packages/angular/src/generators/karma-project/schema.json
View File

@ -9,17 +9,20 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"description": "Skip updating package.json.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,

3
packages/angular/src/generators/karma/schema.json
View File

@ -15,7 +15,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

6
packages/angular/src/generators/library-secondary-entry-point/schema.json
View File

@ -14,14 +14,16 @@
"index": 0
},
"x-prompt": "What name would you like to use for the secondary entry point?",
"pattern": "^[a-zA-Z].*$"
"pattern": "^[a-zA-Z].*$",
"x-priority": "important"
},
"library": {
"type": "string",
"description": "The name of the library to create the secondary entry point for.",
"x-prompt": "What library would you like to create the secondary entry point for?",
"pattern": "^[a-zA-Z].*$",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"skipModule": {
"type": "boolean",

27
packages/angular/src/generators/library/schema.json
View File

@ -19,17 +19,20 @@
},
"directory": {
"type": "string",
"description": "A directory where the library is placed."
"description": "A directory where the library is placed.",
"x-priority": "important"
},
"publishable": {
"type": "boolean",
"default": false,
"description": "Generate a publishable library."
"description": "Generate a publishable library.",
"x-priority": "important"
},
"buildable": {
"type": "boolean",
"default": false,
"description": "Generate a buildable library."
"description": "Generate a buildable library.",
"x-priority": "important"
},
"prefix": {
"type": "string",
@ -40,7 +43,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"simpleModuleName": {
"description": "Keep the module name simple (when using `--directory`).",
@ -61,7 +65,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipTsConfig": {
"type": "boolean",
@ -71,16 +76,19 @@
"routing": {
"type": "boolean",
"default": false,
"description": "Add router configuration. See `lazy` for more information."
"description": "Add router configuration. See `lazy` for more information.",
"x-priority": "important"
},
"lazy": {
"type": "boolean",
"default": false,
"description": "Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false."
"description": "Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false.",
"x-priority": "important"
},
"parent": {
"type": "string",
"description": "Path to the parent route configuration using `loadChildren` or `children`, depending on what `lazy` is set to."
"description": "Path to the parent route configuration using `loadChildren` or `children`, depending on what `lazy` is set to.",
"x-priority": "important"
},
"tags": {
"type": "string",
@ -109,7 +117,8 @@
},
"standaloneConfig": {
"description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
"type": "boolean"
"type": "boolean",
"x-priority": "internal"
},
"compilationMode": {
"description": "Specifies the compilation mode to use. If not specified, it will default to `partial` for publishable libraries and to `full` for buildable libraries. The `full` value can not be used for publishable libraries.",

9
packages/angular/src/generators/move/schema.json
View File

@ -16,7 +16,8 @@
"type": "string",
"alias": "project",
"description": "The name of the Angular project to move.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"destination": {
"type": "string",
@ -24,7 +25,8 @@
"$default": {
"$source": "argv",
"index": 0
}
},
"x-priority": "important"
},
"importPath": {
"type": "string",
@ -39,7 +41,8 @@
"type": "boolean",
"aliases": ["skip-format"],
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
}
},
"required": ["projectName", "destination"]

21
packages/angular/src/generators/ng-add/schema.json
View File

@ -8,21 +8,25 @@
"properties": {
"npmScope": {
"type": "string",
"description": "Npm scope for importing libs. NOTE: only used if running the generator in an Angular CLI workspace."
"description": "Npm scope for importing libs. NOTE: only used if running the generator in an Angular CLI workspace.",
"x-priority": "important"
},
"defaultBase": {
"type": "string",
"description": "Default base branch for affected. NOTE: only used if running the generator in an Angular CLI workspace."
"description": "Default base branch for affected. NOTE: only used if running the generator in an Angular CLI workspace.",
"x-priority": "important"
},
"skipInstall": {
"type": "boolean",
"description": "Skip installing added packages.",
"default": false
"default": false,
"x-priority": "internal"
},
"preserveAngularCliLayout": {
"type": "boolean",
"description": "Preserve the Angular CLI layout instead of moving the app into apps. NOTE: only used if running the generator in an Angular CLI workspace.",
"default": false
"default": false,
"x-priority": "important"
},
"unitTestRunner": {
@ -40,7 +44,8 @@
"skipFormat": {
"description": "Skip formatting files. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"linter": {
"description": "The tool to use for running lint checks. NOTE: only used if running the generator in an Nx workspace.",
@ -57,12 +62,14 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`. NOTE: only used if running the generator in an Nx workspace."
"description": "Do not add dependencies to `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"x-priority": "internal"
},
"skipPostInstall": {
"type": "boolean",
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`. NOTE: only used if running the generator in an Nx workspace."
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"x-priority": "internal"
}
},
"additionalProperties": false,

17
packages/angular/src/generators/ngrx/schema.json
View File

@ -23,7 +23,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`."
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`.",
"x-priority": "important"
},
"module": {
"type": "string",
@ -32,8 +33,9 @@
},
"parent": {
"type": "string",
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?"
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. The host directory will create/use the new state directory. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?",
"x-priority": "important"
},
"route": {
"type": "string",
@ -49,7 +51,8 @@
"type": "boolean",
"default": false,
"description": "Setup root or feature state management with NgRx.",
"x-prompt": "Is this the root state of the application?"
"x-prompt": "Is this the root state of the application?",
"x-priority": "important"
},
"facade": {
"type": "boolean",
@ -70,12 +73,14 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not update the `package.json` with NgRx dependencies."
"description": "Do not update the `package.json` with NgRx dependencies.",
"x-priority": "internal"
},
"barrels": {
"type": "boolean",

9
packages/angular/src/generators/remote/schema.json
View File

@ -23,7 +23,8 @@
"host": {
"type": "string",
"description": "The name of the host app to attach this remote app to.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"port": {
"type": "number",
@ -93,7 +94,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
@ -143,7 +145,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"standalone": {
"description": "Whether to generate a remote application with standalone components. _Note: This is only supported in Angular versions >= 14.1.0_",

12
packages/angular/src/generators/scam-directive/schema.json
View File

@ -22,7 +22,8 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
@ -31,7 +32,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the directive?"
"x-prompt": "What name would you like to use for the directive?",
"x-priority": "important"
},
"skipTests": {
"type": "boolean",
@ -41,7 +43,8 @@
"inlineScam": {
"type": "boolean",
"description": "Create the `NgModule` in the same file as the Directive.",
"default": true
"default": true,
"x-priority": "important"
},
"flat": {
"type": "boolean",
@ -70,7 +73,8 @@
"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
"default": true,
"x-priority": "important"
}
},
"required": ["name"]

12
packages/angular/src/generators/scam-pipe/schema.json
View File

@ -22,7 +22,8 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
@ -31,7 +32,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the pipe?"
"x-prompt": "What name would you like to use for the pipe?",
"x-priority": "important"
},
"skipTests": {
"type": "boolean",
@ -41,7 +43,8 @@
"inlineScam": {
"type": "boolean",
"description": "Create the NgModule in the same file as the Pipe.",
"default": true
"default": true,
"x-priority": "important"
},
"flat": {
"type": "boolean",
@ -51,7 +54,8 @@
"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
"default": true,
"x-priority": "important"
}
},
"required": ["name"]

9
packages/angular/src/generators/scam-to-standalone/schema.json
View File

@ -12,17 +12,20 @@
"$default": {
"$source": "argv",
"index": 0
}
},
"x-priority": "important"
},
"project": {
"type": "string",
"description": "The project containing the SCAM.",
"x-prompt": "What project contains the SCAM?",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
}
},
"examplesFile": "../../../docs/scam-to-standalone-examples.md"

9
packages/angular/src/generators/scam/schema.json
View File

@ -22,7 +22,8 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
@ -78,7 +79,8 @@
"inlineScam": {
"type": "boolean",
"description": "Create the `NgModule` in the same file as the component.",
"default": true
"default": true,
"x-priority": "important"
},
"flat": {
"type": "boolean",
@ -117,7 +119,8 @@
"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
"default": true,
"x-priority": "important"
}
},
"required": ["name"]

9
packages/angular/src/generators/setup-mf/schema.json
View File

@ -42,16 +42,19 @@
},
"routing": {
"type": "boolean",
"description": "Generate a routing setup to allow a host application to route to the remote application."
"description": "Generate a routing setup to allow a host application to route to the remote application.",
"x-priority": "important"
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
},
"skipE2E": {
"type": "boolean",

3
packages/angular/src/generators/setup-ssr/schema.json
View File

@ -51,7 +51,8 @@
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting the workspace after the generator completes."
"description": "Skip formatting the workspace after the generator completes.",
"x-priority": "internal"
}
},
"required": ["project"],

6
packages/angular/src/generators/setup-tailwind/schema.json
View File

@ -22,7 +22,8 @@
},
"skipFormat": {
"type": "boolean",
"description": "Skips formatting the workspace after the generator completes."
"description": "Skips formatting the workspace after the generator completes.",
"x-priority": "internal"
},
"stylesEntryPoint": {
"type": "string",
@ -31,7 +32,8 @@
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`."
"description": "Do not add dependencies to `package.json`.",
"x-priority": "internal"
}
},
"additionalProperties": false,

9
packages/angular/src/generators/stories/schema.json
View File

@ -15,12 +15,14 @@
"index": 0
},
"x-prompt": "What's the name of the project for which you want to generate stories?",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"generateCypressSpecs": {
"type": "boolean",
"description": "Specifies whether to automatically generate `*.spec.ts` files in the Cypress e2e app generated by the `cypress-configure` generator.",
"x-prompt": "Do you want to generate Cypress specs as well?"
"x-prompt": "Do you want to generate Cypress specs as well?",
"x-priority": "important"
},
"cypressProject": {
"type": "string",
@ -29,7 +31,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"ignorePaths": {
"type": "array",

3
packages/angular/src/generators/storybook-configuration/schema.json
View File

@ -58,7 +58,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
},
"ignorePaths": {
"type": "array",

15
packages/angular/src/generators/upgrade-module/schema.json
View File

@ -8,7 +8,8 @@
"properties": {
"project": {
"type": "string",
"description": "The name of the project."
"description": "The name of the project.",
"x-priority": "important"
},
"name": {
"type": "string",
@ -16,7 +17,8 @@
"$default": {
"$source": "argv",
"index": 0
}
},
"x-priority": "important"
},
"angularJsImport": {
"type": "string",
@ -29,17 +31,20 @@
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files.",
"default": false
"default": false,
"x-priority": "internal"
},
"skipPackageJson": {
"type": "boolean",
"description": "Do not add `@angular/upgrade` to `package.json` (e.g., `--skipPackageJson`).",
"default": false
"default": false,
"x-priority": "internal"
},
"router": {
"type": "boolean",
"description": "Sets up router synchronization (e.g., `--router`).",
"default": false
"default": false,
"x-priority": "important"
}
},
"additionalProperties": false,

9
packages/angular/src/generators/web-worker/schema.json
View File

@ -14,7 +14,8 @@
"project": {
"type": "string",
"description": "The name of the project.",
"x-dropdown": "projects"
"x-dropdown": "projects",
"x-priority": "important"
},
"name": {
"type": "string",
@ -23,7 +24,8 @@
"$source": "argv",
"index": 0
},
"x-prompt": "What name would you like to use for the worker?"
"x-prompt": "What name would you like to use for the worker?",
"x-priority": "important"
},
"snippet": {
"type": "boolean",
@ -33,7 +35,8 @@
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false
"default": false,
"x-priority": "internal"
}
},
"additionalProperties": false,