Skip to content

Commit cea9c0c

Browse files
bcabanesbcabanes
authored
docs(core): add description to web package (#9526)
1 parent dd3d768 commit cea9c0c

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

‎docs/generated/packages/web.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"githubRoot": "https://github.com/nrwl/nx/blob/master",
33
"name": "web",
4-
"description": "Web Plugin for Nx",
4+
"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.",
55
"root": "/packages/web",
66
"source": "/packages/web/src",
77
"generators": [
@@ -36,7 +36,7 @@
3636
"required": [],
3737
"presets": []
3838
},
39-
"description": "Add @nrwl/web to a project",
39+
"description": "Add `@nrwl/web` to a project.",
4040
"hidden": true,
4141
"implementation": "/packages/web/src/generators/init/init#webInitGenerator.ts",
4242
"aliases": [],
@@ -136,7 +136,7 @@
136136
},
137137
"aliases": ["app"],
138138
"x-type": "application",
139-
"description": "Create an application",
139+
"description": "Create an web application.",
140140
"implementation": "/packages/web/src/generators/application/application#applicationGenerator.ts",
141141
"hidden": false,
142142
"path": "/packages/web/src/generators/application/schema.json"
@@ -609,7 +609,7 @@
609609
},
610610
"presets": []
611611
},
612-
"description": "Build an application using webpack",
612+
"description": "Build an application using Webpack.",
613613
"aliases": [],
614614
"hidden": false,
615615
"path": "/packages/web/src/executors/webpack/schema.json"
@@ -773,7 +773,7 @@
773773
},
774774
"presets": []
775775
},
776-
"description": "Package a library using rollup",
776+
"description": "Package a library using Rollup.",
777777
"aliases": [],
778778
"hidden": false,
779779
"path": "/packages/web/src/executors/rollup/schema.json"
@@ -857,7 +857,7 @@
857857
},
858858
"presets": []
859859
},
860-
"description": "Serve a web application",
860+
"description": "Serve a web application.",
861861
"aliases": [],
862862
"hidden": false,
863863
"path": "/packages/web/src/executors/dev-server/schema.json"
@@ -929,7 +929,7 @@
929929
"required": ["buildTarget"],
930930
"presets": []
931931
},
932-
"description": "Serve a web application from a folder",
932+
"description": "Serve a web application from a folder.",
933933
"aliases": [],
934934
"hidden": false,
935935
"path": "/packages/web/src/executors/file-server/schema.json"

‎packages/web/executors.json‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,44 @@
33
"webpack": {
44
"implementation": "./src/executors/webpack/compat",
55
"schema": "./src/executors/webpack/schema.json",
6-
"description": "Build an application using webpack"
6+
"description": "Build an application using Webpack."
77
},
88
"rollup": {
99
"implementation": "./src/executors/rollup/compat",
1010
"schema": "./src/executors/rollup/schema.json",
11-
"description": "Package a library using rollup"
11+
"description": "Package a library using Rollup."
1212
},
1313
"dev-server": {
1414
"implementation": "./src/executors/dev-server/compat",
1515
"schema": "./src/executors/dev-server/schema.json",
16-
"description": "Serve a web application"
16+
"description": "Serve a web application."
1717
},
1818
"file-server": {
1919
"implementation": "./src/executors/file-server/compat",
2020
"schema": "./src/executors/file-server/schema.json",
21-
"description": "Serve a web application from a folder"
21+
"description": "Serve a web application from a folder."
2222
}
2323
},
2424
"executors": {
2525
"webpack": {
2626
"implementation": "./src/executors/webpack/webpack.impl",
2727
"schema": "./src/executors/webpack/schema.json",
28-
"description": "Build an application using webpack"
28+
"description": "Build an application using Webpack."
2929
},
3030
"rollup": {
3131
"implementation": "./src/executors/rollup/rollup.impl",
3232
"schema": "./src/executors/rollup/schema.json",
33-
"description": "Package a library using rollup"
33+
"description": "Package a library using Rollup."
3434
},
3535
"dev-server": {
3636
"implementation": "./src/executors/dev-server/dev-server.impl",
3737
"schema": "./src/executors/dev-server/schema.json",
38-
"description": "Serve a web application"
38+
"description": "Serve a web application."
3939
},
4040
"file-server": {
4141
"implementation": "./src/executors/file-server/file-server.impl",
4242
"schema": "./src/executors/file-server/schema.json",
43-
"description": "Serve a web application from a folder"
43+
"description": "Serve a web application from a folder."
4444
}
4545
}
4646
}

‎packages/web/generators.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@
66
"init": {
77
"factory": "./src/generators/init/init#webInitGenerator",
88
"schema": "./src/generators/init/schema.json",
9-
"description": "Add @nrwl/web to a project",
9+
"description": "Add `@nrwl/web` to a project.",
1010
"hidden": true
1111
},
1212
"application": {
1313
"factory": "./src/generators/application/application#applicationGenerator",
1414
"schema": "./src/generators/application/schema.json",
1515
"aliases": ["app"],
1616
"x-type": "application",
17-
"description": "Create an application"
17+
"description": "Create an web application."
1818
}
1919
},
2020
"schematics": {
2121
"init": {
2222
"factory": "./src/generators/init/init#webInitSchematic",
2323
"schema": "./src/generators/init/schema.json",
24-
"description": "Add @nrwl/web to a project",
24+
"description": "Add `@nrwl/web` to a project.",
2525
"hidden": true
2626
},
2727
"application": {
2828
"factory": "./src/generators/application/application#applicationSchematic",
2929
"schema": "./src/generators/application/schema.json",
3030
"aliases": ["app"],
3131
"x-type": "application",
32-
"description": "Create an application"
32+
"description": "Create an web application."
3333
}
3434
}
3535
}

‎packages/web/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@nrwl/web",
33
"version": "0.0.1",
4-
"description": "Web Plugin for Nx",
4+
"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.",
55
"repository": {
66
"type": "git",
77
"url": "https://github.com/nrwl/nx.git",

0 commit comments

Comments
 (0)