docs(core): add description to web package (#9526)

This commit is contained in:
Benjamin Cabanes 2022-03-25 15:26:31 -04:00 committed by GitHub
parent dd3d7682b6
commit cea9c0c146
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 20 additions and 20 deletions

View File

@ -1,7 +1,7 @@
{
"githubRoot": "https://github.com/nrwl/nx/blob/master",
"name": "web",
"description": "Web Plugin for Nx",
"description": "The Nx Plugin for Web Components contains generators for managing Web Component applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Cypress, and Storybook.\n\n- Scaffolding for creating buildable libraries that can be published to npm.\n\n- Utilities for automatic workspace refactoring.",
"root": "/packages/web",
"source": "/packages/web/src",
"generators": [
@ -36,7 +36,7 @@
"required": [],
"presets": []
},
"description": "Add @nrwl/web to a project",
"description": "Add `@nrwl/web` to a project.",
"hidden": true,
"implementation": "/packages/web/src/generators/init/init#webInitGenerator.ts",
"aliases": [],
@ -136,7 +136,7 @@
},
"aliases": ["app"],
"x-type": "application",
"description": "Create an application",
"description": "Create an web application.",
"implementation": "/packages/web/src/generators/application/application#applicationGenerator.ts",
"hidden": false,
"path": "/packages/web/src/generators/application/schema.json"
@ -609,7 +609,7 @@
},
"presets": []
},
"description": "Build an application using webpack",
"description": "Build an application using Webpack.",
"aliases": [],
"hidden": false,
"path": "/packages/web/src/executors/webpack/schema.json"
@ -773,7 +773,7 @@
},
"presets": []
},
"description": "Package a library using rollup",
"description": "Package a library using Rollup.",
"aliases": [],
"hidden": false,
"path": "/packages/web/src/executors/rollup/schema.json"
@ -857,7 +857,7 @@
},
"presets": []
},
"description": "Serve a web application",
"description": "Serve a web application.",
"aliases": [],
"hidden": false,
"path": "/packages/web/src/executors/dev-server/schema.json"
@ -929,7 +929,7 @@
"required": ["buildTarget"],
"presets": []
},
"description": "Serve a web application from a folder",
"description": "Serve a web application from a folder.",
"aliases": [],
"hidden": false,
"path": "/packages/web/src/executors/file-server/schema.json"

View File

@ -3,44 +3,44 @@
"webpack": {
"implementation": "./src/executors/webpack/compat",
"schema": "./src/executors/webpack/schema.json",
"description": "Build an application using webpack"
"description": "Build an application using Webpack."
},
"rollup": {
"implementation": "./src/executors/rollup/compat",
"schema": "./src/executors/rollup/schema.json",
"description": "Package a library using rollup"
"description": "Package a library using Rollup."
},
"dev-server": {
"implementation": "./src/executors/dev-server/compat",
"schema": "./src/executors/dev-server/schema.json",
"description": "Serve a web application"
"description": "Serve a web application."
},
"file-server": {
"implementation": "./src/executors/file-server/compat",
"schema": "./src/executors/file-server/schema.json",
"description": "Serve a web application from a folder"
"description": "Serve a web application from a folder."
}
},
"executors": {
"webpack": {
"implementation": "./src/executors/webpack/webpack.impl",
"schema": "./src/executors/webpack/schema.json",
"description": "Build an application using webpack"
"description": "Build an application using Webpack."
},
"rollup": {
"implementation": "./src/executors/rollup/rollup.impl",
"schema": "./src/executors/rollup/schema.json",
"description": "Package a library using rollup"
"description": "Package a library using Rollup."
},
"dev-server": {
"implementation": "./src/executors/dev-server/dev-server.impl",
"schema": "./src/executors/dev-server/schema.json",
"description": "Serve a web application"
"description": "Serve a web application."
},
"file-server": {
"implementation": "./src/executors/file-server/file-server.impl",
"schema": "./src/executors/file-server/schema.json",
"description": "Serve a web application from a folder"
"description": "Serve a web application from a folder."
}
}
}

View File

@ -6,7 +6,7 @@
"init": {
"factory": "./src/generators/init/init#webInitGenerator",
"schema": "./src/generators/init/schema.json",
"description": "Add @nrwl/web to a project",
"description": "Add `@nrwl/web` to a project.",
"hidden": true
},
"application": {
@ -14,14 +14,14 @@
"schema": "./src/generators/application/schema.json",
"aliases": ["app"],
"x-type": "application",
"description": "Create an application"
"description": "Create an web application."
}
},
"schematics": {
"init": {
"factory": "./src/generators/init/init#webInitSchematic",
"schema": "./src/generators/init/schema.json",
"description": "Add @nrwl/web to a project",
"description": "Add `@nrwl/web` to a project.",
"hidden": true
},
"application": {
@ -29,7 +29,7 @@
"schema": "./src/generators/application/schema.json",
"aliases": ["app"],
"x-type": "application",
"description": "Create an application"
"description": "Create an web application."
}
}
}

View File

@ -1,7 +1,7 @@
{
"name": "@nrwl/web",
"version": "0.0.1",
"description": "Web Plugin for Nx",
"description": "The Nx Plugin for Web Components contains generators for managing Web Component applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Cypress, and Storybook.\n\n- Scaffolding for creating buildable libraries that can be published to npm.\n\n- Utilities for automatic workspace refactoring.",
"repository": {
"type": "git",
"url": "https://github.com/nrwl/nx.git",