From 167b57a18918d81371c896281d8aa1d5ecfc280f Mon Sep 17 00:00:00 2001 From: Benjamin Cabanes <3447705+bcabanes@users.noreply.github.com> Date: Fri, 25 Mar 2022 17:03:16 -0400 Subject: [PATCH] docs(core): add description to linter package (#9537) --- docs/generated/packages/linter.json | 10 +++++----- packages/linter/executors.json | 8 ++++---- packages/linter/generators.json | 8 ++++---- packages/linter/package.json | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/generated/packages/linter.json b/docs/generated/packages/linter.json index 5c762ae657b6e..0435918098c83 100644 --- 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 index dcbf4e17b89f5..526616a0bb637 100644 --- 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 index 6e0cd3be76fee..79aae1043216b 100644 --- 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 index 90217b2420336..2c9de2e8bbe53 100644 --- 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",