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

(cherry picked from commit a22bd54)
nrwl · Jan 17, 2023 · 23d1073 · 23d1073
1 parent a0bf588
commit 23d1073
Show file tree

Hide file tree

Showing 64 changed files with 470 additions and 236 deletions.
diff --git a/docs/generated/packages/angular/generators/add-linting.json b/docs/generated/packages/angular/generators/add-linting.json
@@ -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,

diff --git a/docs/generated/packages/angular/generators/application.json b/docs/generated/packages/angular/generators/application.json
@@ -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,

diff --git a/docs/generated/packages/angular/generators/change-storybook-targets.json b/docs/generated/packages/angular/generators/change-storybook-targets.json
@@ -12,7 +12,8 @@
       "skipFormat": {
         "description": "Skip formatting files.",
         "type": "boolean",
-        "default": false
+        "default": false,
+        "x-priority": "internal"
       }
     },
     "additionalProperties": false,

diff --git a/docs/generated/packages/angular/generators/component-cypress-spec.json b/docs/generated/packages/angular/generators/component-cypress-spec.json
@@ -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,

diff --git a/docs/generated/packages/angular/generators/component-story.json b/docs/generated/packages/angular/generators/component-story.json
@@ -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,

diff --git a/docs/generated/packages/angular/generators/component-test.json b/docs/generated/packages/angular/generators/component-test.json
@@ -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,

diff --git a/docs/generated/packages/angular/generators/component.json b/docs/generated/packages/angular/generators/component.json
@@ -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"],

diff --git a/docs/generated/packages/angular/generators/convert-to-with-mf.json b/docs/generated/packages/angular/generators/convert-to-with-mf.json
@@ -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": []

diff --git a/docs/generated/packages/angular/generators/convert-tslint-to-eslint.json b/docs/generated/packages/angular/generators/convert-tslint-to-eslint.json
@@ -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,

diff --git a/docs/generated/packages/angular/generators/cypress-component-configuration.json b/docs/generated/packages/angular/generators/cypress-component-configuration.json
@@ -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"],

diff --git a/docs/generated/packages/angular/generators/downgrade-module.json b/docs/generated/packages/angular/generators/downgrade-module.json
@@ -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,