From 5d281622693f2107eabd309dcb7dcbf644ca49aa Mon Sep 17 00:00:00 2001 From: Benjamin Cabanes <3447705+bcabanes@users.noreply.github.com> Date: Fri, 25 Mar 2022 16:42:47 -0400 Subject: [PATCH] docs(core): add description to jest package (#9531) --- docs/generated/packages/jest.json | 8 ++++---- packages/jest/executors.json | 4 ++-- packages/jest/generators.json | 8 ++++---- packages/jest/package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/generated/packages/jest.json b/docs/generated/packages/jest.json index 04f17da86f856..57ab39c5a453f 100644 --- a/docs/generated/packages/jest.json +++ b/docs/generated/packages/jest.json @@ -1,7 +1,7 @@ { "githubRoot": "https://github.com/nrwl/nx/blob/master", "name": "jest", - "description": "Jest plugin for Nx", + "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.", "root": "/packages/jest", "source": "/packages/jest/src", "generators": [ @@ -31,7 +31,7 @@ "required": [], "presets": [] }, - "description": "Initialize the @nrwl/jest plugin", + "description": "Initialize the `@nrwl/jest` plugin.", "aliases": ["ng-add"], "hidden": true, "implementation": "/packages/jest/src/generators/init/init#jestInitGenerator.ts", @@ -108,7 +108,7 @@ "required": [], "presets": [] }, - "description": "Add Jest configuration to a project", + "description": "Add Jest configuration to a project.", "hidden": true, "implementation": "/packages/jest/src/generators/jest-project/jest-project#jestProjectGenerator.ts", "aliases": [], @@ -299,7 +299,7 @@ "presets": [] }, "hasher": "./src/executors/jest/hasher", - "description": "Run Jest unit tests", + "description": "Run Jest unit tests.", "aliases": [], "hidden": false, "path": "/packages/jest/src/executors/jest/schema.json" diff --git a/packages/jest/executors.json b/packages/jest/executors.json index fd10463840d1e..a5c9da9bd71a5 100644 --- a/packages/jest/executors.json +++ b/packages/jest/executors.json @@ -3,7 +3,7 @@ "jest": { "implementation": "./src/executors/jest/compat", "schema": "./src/executors/jest/schema.json", - "description": "Run Jest unit tests" + "description": "Run Jest unit tests." } }, "executors": { @@ -12,7 +12,7 @@ "batchImplementation": "./src/executors/jest/jest.impl#batchJest", "schema": "./src/executors/jest/schema.json", "hasher": "./src/executors/jest/hasher", - "description": "Run Jest unit tests" + "description": "Run Jest unit tests." } } } diff --git a/packages/jest/generators.json b/packages/jest/generators.json index ee5119e98a662..d296c1db5f5ce 100644 --- a/packages/jest/generators.json +++ b/packages/jest/generators.json @@ -5,14 +5,14 @@ "init": { "factory": "./src/generators/init/init#jestInitSchematic", "schema": "./src/generators/init/schema.json", - "description": "Initialize the @nrwl/jest plugin", + "description": "Initialize the `@nrwl/jest` plugin.", "aliases": ["ng-add"], "hidden": true }, "jest-project": { "factory": "./src/generators/jest-project/jest-project#jestProjectSchematic", "schema": "./src/generators/jest-project/schema.json", - "description": "Add Jest configuration to a project", + "description": "Add Jest configuration to a project.", "hidden": true } }, @@ -20,14 +20,14 @@ "init": { "factory": "./src/generators/init/init#jestInitGenerator", "schema": "./src/generators/init/schema.json", - "description": "Initialize the @nrwl/jest plugin", + "description": "Initialize the `@nrwl/jest` plugin.", "aliases": ["ng-add"], "hidden": true }, "jest-project": { "factory": "./src/generators/jest-project/jest-project#jestProjectGenerator", "schema": "./src/generators/jest-project/schema.json", - "description": "Add Jest configuration to a project", + "description": "Add Jest configuration to a project.", "hidden": true } } diff --git a/packages/jest/package.json b/packages/jest/package.json index 0d51a00639d70..ef5b59227c514 100644 --- a/packages/jest/package.json +++ b/packages/jest/package.json @@ -1,7 +1,7 @@ { "name": "@nrwl/jest", "version": "0.0.1", - "description": "Jest plugin for Nx", + "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.", "repository": { "type": "git", "url": "https://github.com/nrwl/nx.git",