docs(core): add description to linter package (#9537)

nrwl · Mar 25, 2022 · 167b57a · 167b57a · vercel · Mar 25, 2022
1 parent 5d28162
commit 167b57a
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/docs/generated/packages/linter.json b/docs/generated/packages/linter.json
@@ -1,7 +1,7 @@
 {
   "githubRoot": "https://github.com/nrwl/nx/blob/master",
   "name": "linter",
-  "description": "Lint Plugin for Nx",
+  "description": "The Linter plugin contains executors, generator, plugin and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "root": "/packages/linter",
   "source": "/packages/linter/src",
   "generators": [
@@ -25,7 +25,7 @@
         "required": [],
         "presets": []
       },
-      "description": "Create the Workspace Lint Rules Project",
+      "description": "Create the Workspace Lint Rules Project.",
       "hidden": true,
       "implementation": "/packages/linter/src/generators/workspace-rules-project/workspace-rules-project#lintWorkspaceRulesProjectGenerator.ts",
       "aliases": [],
@@ -67,7 +67,7 @@
         "required": ["name", "directory"],
         "presets": []
       },
-      "description": "Create a new workspace ESLint rule",
+      "description": "Create a new Workspace ESLint rule.",
       "implementation": "/packages/linter/src/generators/workspace-rule/workspace-rule#lintWorkspaceRuleGenerator.ts",
       "aliases": [],
       "hidden": false,
@@ -182,7 +182,7 @@
         "required": ["linter"],
         "presets": []
       },
-      "description": "**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0",
+      "description": "**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in `v10.3.0`.",
       "aliases": [],
       "hidden": false,
       "path": "/packages/linter/src/executors/lint/schema.json"
@@ -289,7 +289,7 @@
         "presets": []
       },
       "hasher": "./src/executors/eslint/hasher",
-      "description": "Run ESLint on a project",
+      "description": "Run ESLint on a project.",
       "aliases": [],
       "hidden": false,
       "path": "/packages/linter/src/executors/eslint/schema.json"

diff --git a/packages/linter/executors.json b/packages/linter/executors.json
@@ -3,25 +3,25 @@
     "lint": {
       "implementation": "./src/executors/lint/compat",
       "schema": "./src/executors/lint/schema.json",
-      "description": "**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0"
+      "description": "**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in `v10.3.0`."
     },
     "eslint": {
       "implementation": "./src/executors/eslint/compat",
       "schema": "./src/executors/eslint/schema.json",
-      "description": "Run ESLint on a project"
+      "description": "Run ESLint on a project."
     }
   },
   "executors": {
     "lint": {
       "implementation": "./src/executors/lint/lint.impl",
       "schema": "./src/executors/lint/schema.json",
-      "description": "**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0"
+      "description": "**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in `v10.3.0`."
     },
     "eslint": {
       "implementation": "./src/executors/eslint/lint.impl",
       "schema": "./src/executors/eslint/schema.json",
       "hasher": "./src/executors/eslint/hasher",
-      "description": "Run ESLint on a project"
+      "description": "Run ESLint on a project."
     }
   }
 }
diff --git a/packages/linter/generators.json b/packages/linter/generators.json
@@ -5,26 +5,26 @@
     "workspace-rules-project": {
       "factory": "./src/generators/workspace-rules-project/workspace-rules-project#lintWorkspaceRulesProjectSchematic",
       "schema": "./src/generators/workspace-rules-project/schema.json",
-      "description": "Create the Workspace Lint Rules Project",
+      "description": "Create the Workspace Lint Rules Project.",
       "hidden": true
     },
     "workspace-rule": {
       "factory": "./src/generators/workspace-rule/workspace-rule#lintWorkspaceRuleSchematic",
       "schema": "./src/generators/workspace-rule/schema.json",
-      "description": "Create a new workspace ESLint rule"
+      "description": "Create a new Workspace ESLint rule."
     }
   },
   "generators": {
     "workspace-rules-project": {
       "factory": "./src/generators/workspace-rules-project/workspace-rules-project#lintWorkspaceRulesProjectGenerator",
       "schema": "./src/generators/workspace-rules-project/schema.json",
-      "description": "Create the Workspace Lint Rules Project",
+      "description": "Create the Workspace Lint Rules Project.",
       "hidden": true
     },
     "workspace-rule": {
       "factory": "./src/generators/workspace-rule/workspace-rule#lintWorkspaceRuleGenerator",
       "schema": "./src/generators/workspace-rule/schema.json",
-      "description": "Create a new workspace ESLint rule"
+      "description": "Create a new Workspace ESLint rule."
     }
   }
 }
diff --git a/packages/linter/package.json b/packages/linter/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@nrwl/linter",
   "version": "0.0.1",
-  "description": "Lint Plugin for Nx",
+  "description": "The Linter plugin contains executors, generator, plugin and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
     "type": "git",
     "url": "https://github.com/nrwl/nx.git",