chore(core): improve help output for generators and executors (#9800)

.eslintrc.json

@@ -5,10 +5,18 @@
     "node": true
   },
   "ignorePatterns": ["**/*.ts"],
-  "plugins": ["@typescript-eslint"],
+  "plugins": ["@typescript-eslint", "@nrwl/nx"],
   "extends": [],
   "rules": {
     "@typescript-eslint/explicit-module-boundary-types": "off"
   },
-  "overrides": []
+  "overrides": [
+    {
+      "files": ["**/executors/**/schema.json", "**/generators/**/schema.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nrwl/nx/workspace/valid-schema-description": "error"
+      }
+    }
+  ]
 }

docs/generated/packages/angular.json

@@ -12,6 +12,7 @@
         "$schema": "http://json-schema.org/schema",
         "$id": "NxAngularAddLintingGenerator",
         "title": "Add linting to an Angular project.",
+        "description": "Adds linting configuration to an Angular project.",
         "cli": "nx",
         "type": "object",
         "properties": {
@@ -61,6 +62,7 @@
         "$schema": "http://json-schema.org/schema",
         "$id": "GeneratorNxApp",
         "title": "Creates an Angular application.",
+        "description": "Creates an Angular application.",
         "type": "object",
         "cli": "nx",
         "properties": {
@@ -245,7 +247,7 @@
         "title": "Angular Component Schema",
         "cli": "nx",
         "type": "object",
-        "description": "Creates a new, generic component definition in the given or default project.",
+        "description": "Creates a new, generic Angular component definition in the given or default project.",
         "additionalProperties": false,
         "properties": {
           "path": {
@@ -355,6 +357,7 @@
         "$id": "NxAngularComponentCypressSpecGenerator",
         "type": "object",
         "cli": "nx",
+        "description": "Creates a Cypress spec for a UI component that has a story.",
         "properties": {
           "projectName": {
             "type": "string",
@@ -410,6 +413,7 @@
         "$id": "NxAngularComponentStoryGenerator",
         "type": "object",
         "cli": "nx",
+        "description": "Creates a `stories.ts` file for an Angular component.",
         "properties": {
           "projectPath": {
             "type": "string",
@@ -455,7 +459,7 @@
         "$id": "NxAngularConvertTSLintToESLintGenerator",
         "cli": "nx",
         "title": "Convert an Angular project from TSLint to ESLint",
-        "description": "Convert an Angular project from TSLint to ESLint. NOTE: Does not work in `--dry-run mode`",
+        "description": "Convert an Angular project from TSLint to ESLint. NOTE: Does not work in `--dry-run mode`.",
         "examples": [
           {
             "command": "nx g convert-tslint-to-eslint myapp",
@@ -513,7 +517,7 @@
         "$schema": "http://json-schema.org/schema",
         "$id": "NxDowngradeModuleGenerator",
         "title": "Generates downgradeModule setup.",
-        "description": "Sets up a Downgrade Module.",
+        "description": "Sets up a Downgrade Module for using AngularJS and Angular.",
         "cli": "nx",
         "type": "object",
         "properties": {
@@ -559,7 +563,7 @@
         "$id": "SchematicsAngularModuleInit",
         "cli": "nx",
         "title": "Init Angular Plugin",
-        "description": "Initializes the `@nrwl/angular` plugin. NOTE: Does not work in the `--dry-run` mode",
+        "description": "Initializes the `@nrwl/angular` plugin. NOTE: Does not work in the `--dry-run` mode.",
         "type": "object",
         "properties": {
           "unitTestRunner": {
@@ -1087,7 +1091,7 @@
         "cli": "nx",
         "title": "Convert to withModuleFederation Generator Options Schema",
         "type": "object",
-        "description": "Converts an old micro frontend configuration to use the new withModuleFederation helper. It will run successfully if the following conditions are met: \n - Is either a host or remote application \n - Shared npm package configurations have not been modified \n - Name used to identify the Micro Frontend application matches the project name \n\n _**Note:** This generator will overwrite your webpack config. If you have additional custom configuration in your config file, it will be lost!_",
+        "description": "Converts an old micro frontend configuration to use the new withModuleFederation helper. It will run successfully if the following conditions are met: \n - Is either a host or remote application \n - Shared npm package configurations have not been modified \n - Name used to identify the Micro Frontend application matches the project name \n\n _**Note:** This generator will overwrite your webpack config. If you have additional custom configuration in your config file, it will be lost!_.",
         "additionalProperties": false,
         "properties": {
           "project": {
@@ -1113,7 +1117,7 @@
         "$id": "NxMFEHost",
         "cli": "nx",
         "title": "Nx MFE Host Application",
-        "description": "Create an Angular Host Micro Frontend Application",
+        "description": "Create an Angular Host Micro Frontend Application.",
         "type": "object",
         "examples": [
           {
@@ -1433,7 +1437,7 @@
         "cli": "nx",
         "title": "SCAM Generator Options Schema",
         "type": "object",
-        "description": "Creates a new, generic component definition in the given or default project.",
+        "description": "Creates a new, generic Angular component definition in the given or default project.",
         "additionalProperties": false,
         "properties": {
           "path": {
@@ -1553,7 +1557,7 @@
         "cli": "nx",
         "title": "SCAM Directive Generator Options Schema",
         "type": "object",
-        "description": "Creates a new, generic directive definition in the given or default project.",
+        "description": "Creates a new, generic Angular directive definition in the given or default project.",
         "additionalProperties": false,
         "properties": {
           "path": {
@@ -1626,7 +1630,7 @@
         "cli": "nx",
         "title": "SCAM Pipe Generator Options Schema",
         "type": "object",
-        "description": "Creates a new, generic pipe definition in the given or default project.",
+        "description": "Creates a new, generic Angular pipe definition in the given or default project.",
         "additionalProperties": false,
         "properties": {
           "path": {
@@ -1798,7 +1802,7 @@
         "$schema": "http://json-schema.org/schema",
         "$id": "NxAngularStorybookStoriesGenerator",
         "title": "Create Storybook stories/specs",
-        "description": "Creates Storybook stories/specs for all components declared in a project.",
+        "description": "Creates Storybook stories/specs for all Angular components declared in a project.",
         "cli": "nx",
         "type": "object",
         "properties": {

docs/generated/packages/jest.json

@@ -45,7 +45,7 @@
         "$id": "NxJestProject",
         "cli": "nx",
         "title": "Add Jest Configuration to a project",
-        "description": "Add Jest Configuration to a project",
+        "description": "Add Jest Configuration to a project.",
         "type": "object",
         "properties": {
           "project": {

docs/generated/packages/js.json

@@ -136,7 +136,7 @@
         "$id": "NxTypescriptInit",
         "cli": "nx",
         "title": "Init nrwl/js",
-        "description": "Init generator placeholder for nrwl/js",
+        "description": "Init generator placeholder for nrwl/js.",
         "presets": []
       },
       "aliases": ["lib"],

docs/generated/packages/nest.json

@@ -12,7 +12,7 @@
         "$schema": "http://json-schema.org/schema",
         "$id": "NxNestApplicationGenerator",
         "title": "Nx Application Options Schema",
-        "description": "Nx Application Options Schema",
+        "description": "Nx Application Options Schema.",
         "cli": "nx",
         "type": "object",
         "properties": {

docs/generated/packages/next.json

@@ -51,6 +51,7 @@
         "cli": "nx",
         "$id": "NxNextApp",
         "title": "Create a Next.js Application for Nx",
+        "description": "Create a Next.js Application for Nx.",
         "examples": [
           {
             "command": "nx g app myapp --directory=myorg",
@@ -287,6 +288,7 @@
         "cli": "nx",
         "$id": "NxNextReactComponent",
         "title": "Create a React Component for Next",
+        "description": "Create a React Component for Next.",
         "type": "object",
         "examples": [
           {
@@ -560,7 +562,7 @@
         "$schema": "http://json-schema.org/schema",
         "cli": "nx",
         "title": "Next Build",
-        "description": "Build a Next.js app",
+        "description": "Build a Next.js app.",
         "type": "object",
         "properties": {
           "root": { "description": "The source root", "type": "string" },
@@ -612,7 +614,7 @@
       "schema": {
         "cli": "nx",
         "title": "Next Serve",
-        "description": "Serve a Next.js app",
+        "description": "Serve a Next.js app.",
         "type": "object",
         "properties": {
           "dev": {

docs/generated/packages/node.json

@@ -205,7 +205,6 @@
           },
           "rootDir": {
             "type": "string",
-            "alias": "srcRootForCompilationRoot",
             "description": "Sets the `rootDir` for TypeScript compilation. When not defined, it uses the project's root property, or `srcRootForCompilationRoot` if it is defined."
           },
           "testEnvironment": {

docs/generated/packages/react-native.json

@@ -325,7 +325,7 @@
         "cli": "nx",
         "$id": "NxReactNativeStorybookConfigure",
         "title": "React native Storybook configuration",
-        "description": "Set up Storybook for a React-Native app or library",
+        "description": "Set up Storybook for a React-Native app or library.",
         "type": "object",
         "properties": {
           "name": {

docs/generated/packages/react.json

@@ -12,7 +12,7 @@
         "$schema": "http://json-schema.org/schema",
         "$id": "NxReactNgInit",
         "title": "Init React Plugin",
-        "description": "Initialize a React Plugin",
+        "description": "Initialize a React Plugin.",
         "cli": "nx",
         "type": "object",
         "properties": {
@@ -218,7 +218,7 @@
         "cli": "nx",
         "$id": "NxReactLibrary",
         "title": "Create a React Library",
-        "description": "Create a React Library for an Nx workspace",
+        "description": "Create a React Library for an Nx workspace.",
         "type": "object",
         "examples": [
           {

docs/generated/packages/web.json

@@ -13,6 +13,7 @@
         "$id": "NxWebInit",
         "cli": "nx",
         "title": "Init Web Plugin",
+        "description": "Init Web Plugin.",
         "type": "object",
         "properties": {
           "unitTestRunner": {
@@ -148,7 +149,7 @@
       "implementation": "/packages/web/src/executors/webpack/webpack.impl.ts",
       "schema": {
         "title": "Webpack Executor",
-        "description": "Builds web applications using webpack",
+        "description": "Builds web applications using webpack.",
         "cli": "nx",
         "type": "object",
         "properties": {

e2e/cli/src/cli.test.ts

@@ -72,11 +72,13 @@ describe('Cli', () => {
 
     const genHelp = runCLI(`g @nrwl/web:app --help`);
     expect(genHelp).toContain(
-      'The file extension to be used for style files. (default: css)'
+      'Find more information and examples at: https://nx.dev/packages/web/generators/application'
     );
 
     const buildHelp = runCLI(`build ${myapp} --help`);
-    expect(buildHelp).toContain('The name of the main entry-point file.');
+    expect(buildHelp).toContain(
+      'Find more information and examples at: https://nx.dev/packages/web/executors/webpack'
+    );
 
     const affectedHelp = runCLI(`affected --help`);
     expect(affectedHelp).toContain('Run target for affected projects');

nx.json

@@ -3,7 +3,8 @@
     "package.json": "*",
     ".eslintrc.json": "*",
     "scripts/vercel/*": ["nx-dev"],
-    ".circleci/config.yml": "*"
+    ".circleci/config.yml": "*",
+    "tools/eslint-rules/**/*": "*"
   },
   "affected": {
     "defaultBase": "master"

package.json

@@ -166,6 +166,7 @@
     "jest": "27.2.3",
     "jest-circus": "27.2.3",
     "jest-preset-angular": "11.1.1",
+    "jsonc-eslint-parser": "^2.1.0",
     "jsonc-parser": "3.0.0",
     "karma": "~4.0.0",
     "karma-chrome-launcher": "~2.2.0",

packages/angular/project.json

@@ -85,7 +85,9 @@
           "packages/angular/**/*.spec.tsx",
           "packages/angular/**/*.spec.js",
           "packages/angular/**/*.spec.jsx",
-          "packages/angular/**/*.d.ts"
+          "packages/angular/**/*.d.ts",
+          "packages/angular/**/executors/**/schema.json",
+          "packages/angular/**/generators/**/schema.json"
         ]
       },
       "outputs": ["{options.outputFile}"]

packages/angular/src/generators/add-linting/schema.json

@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/schema",
   "$id": "NxAngularAddLintingGenerator",
   "title": "Add linting to an Angular project.",
+  "description": "Adds linting configuration to an Angular project.",
   "cli": "nx",
   "type": "object",
   "properties": {

packages/angular/src/generators/application/schema.json

@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/schema",
   "$id": "GeneratorNxApp",
   "title": "Creates an Angular application.",
+  "description": "Creates an Angular application.",
   "type": "object",
   "cli": "nx",
   "properties": {

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

@@ -3,6 +3,7 @@
   "$id": "NxAngularComponentCypressSpecGenerator",
   "type": "object",
   "cli": "nx",
+  "description": "Creates a Cypress spec for a UI component that has a story.",
   "properties": {
     "projectName": {
       "type": "string",

packages/angular/src/generators/component-story/schema.json

@@ -3,6 +3,7 @@
   "$id": "NxAngularComponentStoryGenerator",
   "type": "object",
   "cli": "nx",
+  "description": "Creates a `stories.ts` file for an Angular component.",
   "properties": {
     "projectPath": {
       "type": "string",

packages/angular/src/generators/component/schema.json

@@ -4,7 +4,7 @@
   "title": "Angular Component Schema",
   "cli": "nx",
   "type": "object",
-  "description": "Creates a new, generic component definition in the given or default project.",
+  "description": "Creates a new, generic Angular component definition in the given or default project.",
   "additionalProperties": false,
   "properties": {
     "path": {

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

@@ -4,7 +4,7 @@
   "cli": "nx",
   "title": "Convert to withModuleFederation Generator Options Schema",
   "type": "object",
-  "description": "Converts an old micro frontend configuration to use the new withModuleFederation helper. It will run successfully if the following conditions are met: \n - Is either a host or remote application \n - Shared npm package configurations have not been modified \n - Name used to identify the Micro Frontend application matches the project name \n\n _**Note:** This generator will overwrite your webpack config. If you have additional custom configuration in your config file, it will be lost!_",
+  "description": "Converts an old micro frontend configuration to use the new withModuleFederation helper. It will run successfully if the following conditions are met: \n - Is either a host or remote application \n - Shared npm package configurations have not been modified \n - Name used to identify the Micro Frontend application matches the project name \n\n _**Note:** This generator will overwrite your webpack config. If you have additional custom configuration in your config file, it will be lost!_.",
   "additionalProperties": false,
   "properties": {
     "project": {

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

@@ -3,7 +3,7 @@
   "$id": "NxAngularConvertTSLintToESLintGenerator",
   "cli": "nx",
   "title": "Convert an Angular project from TSLint to ESLint",
-  "description": "Convert an Angular project from TSLint to ESLint. NOTE: Does not work in `--dry-run mode`",
+  "description": "Convert an Angular project from TSLint to ESLint. NOTE: Does not work in `--dry-run mode`.",
   "examples": [
     {
       "command": "nx g convert-tslint-to-eslint myapp",

packages/angular/src/generators/downgrade-module/schema.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/schema",
   "$id": "NxDowngradeModuleGenerator",
   "title": "Generates downgradeModule setup.",
-  "description": "Sets up a Downgrade Module.",
+  "description": "Sets up a Downgrade Module for using AngularJS and Angular.",
   "cli": "nx",
   "type": "object",
   "properties": {

packages/angular/src/generators/init/schema.json

@@ -3,7 +3,7 @@
   "$id": "SchematicsAngularModuleInit",
   "cli": "nx",
   "title": "Init Angular Plugin",
-  "description": "Initializes the `@nrwl/angular` plugin. NOTE: Does not work in the `--dry-run` mode",
+  "description": "Initializes the `@nrwl/angular` plugin. NOTE: Does not work in the `--dry-run` mode.",
   "type": "object",
   "properties": {
     "unitTestRunner": {

packages/angular/src/generators/mfe-host/schema.json

@@ -3,7 +3,7 @@
   "$id": "NxMFEHost",
   "cli": "nx",
   "title": "Nx MFE Host Application",
-  "description": "Create an Angular Host Micro Frontend Application",
+  "description": "Create an Angular Host Micro Frontend Application.",
   "type": "object",
   "examples": [
     {

packages/angular/src/generators/scam-directive/schema.json

@@ -4,7 +4,7 @@
   "cli": "nx",
   "title": "SCAM Directive Generator Options Schema",
   "type": "object",
-  "description": "Creates a new, generic directive definition in the given or default project.",
+  "description": "Creates a new, generic Angular directive definition in the given or default project.",
   "additionalProperties": false,
   "properties": {
     "path": {