docs(core): add description to node package (#9533)

This commit is contained in:
Benjamin Cabanes 2022-03-25 16:18:29 -04:00 committed by GitHub
parent 24173e5742
commit a4da5a19b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 17 deletions

View File

@ -1,7 +1,7 @@
{ {
"githubRoot": "https://github.com/nrwl/nx/blob/master", "githubRoot": "https://github.com/nrwl/nx/blob/master",
"name": "node", "name": "node",
"description": "Node Plugin for Nx", "description": "The Node Plugin contains generators and executors to manage Node applications within an Nx workspace.",
"root": "/packages/node", "root": "/packages/node",
"source": "/packages/node/src", "source": "/packages/node/src",
"generators": [ "generators": [
@ -31,7 +31,7 @@
"required": [], "required": [],
"presets": [] "presets": []
}, },
"description": "Initialize the @nrwl/node plugin", "description": "Initialize the `@nrwl/node` plugin.",
"aliases": ["ng-add"], "aliases": ["ng-add"],
"hidden": true, "hidden": true,
"implementation": "/packages/node/src/generators/init/init.ts", "implementation": "/packages/node/src/generators/init/init.ts",
@ -119,7 +119,7 @@
}, },
"aliases": ["app"], "aliases": ["app"],
"x-type": "application", "x-type": "application",
"description": "Create a node application", "description": "Create a node application.",
"implementation": "/packages/node/src/generators/application/application.ts", "implementation": "/packages/node/src/generators/application/application.ts",
"hidden": false, "hidden": false,
"path": "/packages/node/src/generators/application/schema.json" "path": "/packages/node/src/generators/application/schema.json"
@ -250,7 +250,7 @@
}, },
"aliases": ["lib"], "aliases": ["lib"],
"x-type": "library", "x-type": "library",
"description": "Create a library", "description": "Create a node library.",
"implementation": "/packages/node/src/generators/library/library.ts", "implementation": "/packages/node/src/generators/library/library.ts",
"hidden": false, "hidden": false,
"path": "/packages/node/src/generators/library/schema.json" "path": "/packages/node/src/generators/library/schema.json"
@ -498,7 +498,7 @@
}, },
"presets": [] "presets": []
}, },
"description": "Build a Node application using webpack", "description": "Build a Node application using Webpack.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/node/src/executors/webpack/schema.json" "path": "/packages/node/src/executors/webpack/schema.json"
@ -568,7 +568,7 @@
"required": ["buildTarget"], "required": ["buildTarget"],
"presets": [] "presets": []
}, },
"description": "Execute a Node application", "description": "Execute a Node application.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/node/src/executors/node/schema.json" "path": "/packages/node/src/executors/node/schema.json"

View File

@ -3,24 +3,24 @@
"webpack": { "webpack": {
"implementation": "./src/executors/webpack/webpack.impl", "implementation": "./src/executors/webpack/webpack.impl",
"schema": "./src/executors/webpack/schema.json", "schema": "./src/executors/webpack/schema.json",
"description": "Build a Node application using webpack" "description": "Build a Node application using Webpack."
}, },
"node": { "node": {
"implementation": "./src/executors/node/node.impl", "implementation": "./src/executors/node/node.impl",
"schema": "./src/executors/node/schema.json", "schema": "./src/executors/node/schema.json",
"description": "Execute a Node application" "description": "Execute a Node application."
} }
}, },
"builders": { "builders": {
"webpack": { "webpack": {
"implementation": "./src/executors/webpack/compat", "implementation": "./src/executors/webpack/compat",
"schema": "./src/executors/webpack/schema.json", "schema": "./src/executors/webpack/schema.json",
"description": "Build a Node application using webpack" "description": "Build a Node application using Webpack."
}, },
"node": { "node": {
"implementation": "./src/executors/node/compat", "implementation": "./src/executors/node/compat",
"schema": "./src/executors/node/schema.json", "schema": "./src/executors/node/schema.json",
"description": "Execute a Node application" "description": "Execute a Node application."
} }
} }
} }

View File

@ -6,7 +6,7 @@
"init": { "init": {
"factory": "./src/generators/init/init", "factory": "./src/generators/init/init",
"schema": "./src/generators/init/schema.json", "schema": "./src/generators/init/schema.json",
"description": "Initialize the @nrwl/node plugin", "description": "Initialize the `@nrwl/node` plugin.",
"aliases": ["ng-add"], "aliases": ["ng-add"],
"hidden": true "hidden": true
}, },
@ -15,21 +15,21 @@
"schema": "./src/generators/application/schema.json", "schema": "./src/generators/application/schema.json",
"aliases": ["app"], "aliases": ["app"],
"x-type": "application", "x-type": "application",
"description": "Create a node application" "description": "Create a node application."
}, },
"library": { "library": {
"factory": "./src/generators/library/library", "factory": "./src/generators/library/library",
"schema": "./src/generators/library/schema.json", "schema": "./src/generators/library/schema.json",
"aliases": ["lib"], "aliases": ["lib"],
"x-type": "library", "x-type": "library",
"description": "Create a library" "description": "Create a node library."
} }
}, },
"schematics": { "schematics": {
"init": { "init": {
"factory": "./src/generators/init/init#initSchematic", "factory": "./src/generators/init/init#initSchematic",
"schema": "./src/generators/init/schema.json", "schema": "./src/generators/init/schema.json",
"description": "Initialize the @nrwl/node plugin", "description": "Initialize the `@nrwl/node` plugin.",
"aliases": ["ng-add"], "aliases": ["ng-add"],
"hidden": true "hidden": true
}, },
@ -38,14 +38,14 @@
"schema": "./src/generators/application/schema.json", "schema": "./src/generators/application/schema.json",
"aliases": ["app"], "aliases": ["app"],
"x-type": "application", "x-type": "application",
"description": "Create a node application" "description": "Create a node application."
}, },
"library": { "library": {
"factory": "./src/generators/library/library#librarySchematic", "factory": "./src/generators/library/library#librarySchematic",
"schema": "./src/generators/library/schema.json", "schema": "./src/generators/library/schema.json",
"aliases": ["lib"], "aliases": ["lib"],
"x-type": "library", "x-type": "library",
"description": "Create a library" "description": "Create a node library."
} }
} }
} }

View File

@ -1,7 +1,7 @@
{ {
"name": "@nrwl/node", "name": "@nrwl/node",
"version": "0.0.1", "version": "0.0.1",
"description": "Node Plugin for Nx", "description": "The Node Plugin contains generators and executors to manage Node applications within an Nx workspace.",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/nrwl/nx.git", "url": "https://github.com/nrwl/nx.git",