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", "githubRoot": "https://github.com/nrwl/nx/blob/master",
"name": "web", "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", "root": "/packages/web",
"source": "/packages/web/src", "source": "/packages/web/src",
"generators": [ "generators": [
@ -36,7 +36,7 @@
"required": [], "required": [],
"presets": [] "presets": []
}, },
"description": "Add @nrwl/web to a project", "description": "Add `@nrwl/web` to a project.",
"hidden": true, "hidden": true,
"implementation": "/packages/web/src/generators/init/init#webInitGenerator.ts", "implementation": "/packages/web/src/generators/init/init#webInitGenerator.ts",
"aliases": [], "aliases": [],
@ -136,7 +136,7 @@
}, },
"aliases": ["app"], "aliases": ["app"],
"x-type": "application", "x-type": "application",
"description": "Create an application", "description": "Create an web application.",
"implementation": "/packages/web/src/generators/application/application#applicationGenerator.ts", "implementation": "/packages/web/src/generators/application/application#applicationGenerator.ts",
"hidden": false, "hidden": false,
"path": "/packages/web/src/generators/application/schema.json" "path": "/packages/web/src/generators/application/schema.json"
@ -609,7 +609,7 @@
}, },
"presets": [] "presets": []
}, },
"description": "Build an application using webpack", "description": "Build an application using Webpack.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/web/src/executors/webpack/schema.json" "path": "/packages/web/src/executors/webpack/schema.json"
@ -773,7 +773,7 @@
}, },
"presets": [] "presets": []
}, },
"description": "Package a library using rollup", "description": "Package a library using Rollup.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/web/src/executors/rollup/schema.json" "path": "/packages/web/src/executors/rollup/schema.json"
@ -857,7 +857,7 @@
}, },
"presets": [] "presets": []
}, },
"description": "Serve a web application", "description": "Serve a web application.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/web/src/executors/dev-server/schema.json" "path": "/packages/web/src/executors/dev-server/schema.json"
@ -929,7 +929,7 @@
"required": ["buildTarget"], "required": ["buildTarget"],
"presets": [] "presets": []
}, },
"description": "Serve a web application from a folder", "description": "Serve a web application from a folder.",
"aliases": [], "aliases": [],
"hidden": false, "hidden": false,
"path": "/packages/web/src/executors/file-server/schema.json" "path": "/packages/web/src/executors/file-server/schema.json"

View File

@ -3,44 +3,44 @@
"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 an application using webpack" "description": "Build an application using Webpack."
}, },
"rollup": { "rollup": {
"implementation": "./src/executors/rollup/compat", "implementation": "./src/executors/rollup/compat",
"schema": "./src/executors/rollup/schema.json", "schema": "./src/executors/rollup/schema.json",
"description": "Package a library using rollup" "description": "Package a library using Rollup."
}, },
"dev-server": { "dev-server": {
"implementation": "./src/executors/dev-server/compat", "implementation": "./src/executors/dev-server/compat",
"schema": "./src/executors/dev-server/schema.json", "schema": "./src/executors/dev-server/schema.json",
"description": "Serve a web application" "description": "Serve a web application."
}, },
"file-server": { "file-server": {
"implementation": "./src/executors/file-server/compat", "implementation": "./src/executors/file-server/compat",
"schema": "./src/executors/file-server/schema.json", "schema": "./src/executors/file-server/schema.json",
"description": "Serve a web application from a folder" "description": "Serve a web application from a folder."
} }
}, },
"executors": { "executors": {
"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 an application using webpack" "description": "Build an application using Webpack."
}, },
"rollup": { "rollup": {
"implementation": "./src/executors/rollup/rollup.impl", "implementation": "./src/executors/rollup/rollup.impl",
"schema": "./src/executors/rollup/schema.json", "schema": "./src/executors/rollup/schema.json",
"description": "Package a library using rollup" "description": "Package a library using Rollup."
}, },
"dev-server": { "dev-server": {
"implementation": "./src/executors/dev-server/dev-server.impl", "implementation": "./src/executors/dev-server/dev-server.impl",
"schema": "./src/executors/dev-server/schema.json", "schema": "./src/executors/dev-server/schema.json",
"description": "Serve a web application" "description": "Serve a web application."
}, },
"file-server": { "file-server": {
"implementation": "./src/executors/file-server/file-server.impl", "implementation": "./src/executors/file-server/file-server.impl",
"schema": "./src/executors/file-server/schema.json", "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": { "init": {
"factory": "./src/generators/init/init#webInitGenerator", "factory": "./src/generators/init/init#webInitGenerator",
"schema": "./src/generators/init/schema.json", "schema": "./src/generators/init/schema.json",
"description": "Add @nrwl/web to a project", "description": "Add `@nrwl/web` to a project.",
"hidden": true "hidden": true
}, },
"application": { "application": {
@ -14,14 +14,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 an application" "description": "Create an web application."
} }
}, },
"schematics": { "schematics": {
"init": { "init": {
"factory": "./src/generators/init/init#webInitSchematic", "factory": "./src/generators/init/init#webInitSchematic",
"schema": "./src/generators/init/schema.json", "schema": "./src/generators/init/schema.json",
"description": "Add @nrwl/web to a project", "description": "Add `@nrwl/web` to a project.",
"hidden": true "hidden": true
}, },
"application": { "application": {
@ -29,7 +29,7 @@
"schema": "./src/generators/application/schema.json", "schema": "./src/generators/application/schema.json",
"aliases": ["app"], "aliases": ["app"],
"x-type": "application", "x-type": "application",
"description": "Create an application" "description": "Create an web application."
} }
} }
} }

View File

@ -1,7 +1,7 @@
{ {
"name": "@nrwl/web", "name": "@nrwl/web",
"version": "0.0.1", "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": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/nrwl/nx.git", "url": "https://github.com/nrwl/nx.git",