Skip to content

Commit

Permalink
docs(angular): improve executor descriptions (#13466)
Browse files Browse the repository at this point in the history
  • Loading branch information
leosvelperez committed Nov 29, 2022
1 parent 42fa5d8 commit 36ce474
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions docs/generated/packages/angular.json
Expand Up @@ -2466,7 +2466,7 @@
"outputCapture": "direct-nodejs",
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Schema for an executor which delegates a build.",
"description": "Options for delegating a build to a different target.",
"description": "Delegates the build to a different target while supporting incremental builds.",
"cli": "nx",
"type": "object",
"properties": {
Expand Down Expand Up @@ -2509,7 +2509,7 @@
"outputCapture": "direct-nodejs",
"$schema": "http://json-schema.org/schema",
"title": "ng-packagr Target",
"description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.",
"description": "Builds a library with support for incremental builds.\n\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.",
"cli": "nx",
"type": "object",
"presets": [
Expand Down Expand Up @@ -2574,7 +2574,7 @@
"outputCapture": "direct-nodejs",
"$schema": "http://json-schema.org/schema",
"title": "ng-packagr Target",
"description": "ng-packagr target options for Build Architect. Use to build and package library projects for publishing.",
"description": "Builds and packages an Angular library producing an output following the Angular Package Format (APF) to be distributed as an NPM package.\n\nThis executor is similar to the `@angular-devkit/build-angular:ng-packagr` with additional support for incremental builds.",
"cli": "nx",
"type": "object",
"presets": [
Expand Down Expand Up @@ -2628,7 +2628,7 @@
"additionalProperties": false,
"required": ["project"]
},
"description": "Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.",
"description": "Builds and packages an Angular library producing an output following the Angular Package Format (APF) to be distributed as an NPM package.\nThis executor is similar to the `@angular-devkit/build-angular:ng-packagr` with additional support for incremental builds.",
"aliases": [],
"hidden": false,
"path": "/packages/angular/src/executors/package/schema.json"
Expand All @@ -2640,7 +2640,7 @@
"version": 2,
"outputCapture": "direct-nodejs",
"title": "File Server",
"description": "Serve a web application from a folder.",
"description": "Serves a static web application from a folder.",
"type": "object",
"cli": "nx",
"properties": {
Expand Down Expand Up @@ -2707,7 +2707,7 @@
"examplesFile": "## Examples\n\n{% tabs %}\n\n{% tab label=\"Serve static files with http-server\" %}\n\nSet up `http-server` to host static files on a local webserver.\n\n```json\n{\n \"static-serve\": {\n \"executor\": \"@nrwl/angular:file-server\",\n \"options\": {\n \"buildTarget\": \"app:build\",\n \"port\": 4201\n }\n }\n}\n```\n\n{% /tab %}\n\n{% tab label=\"Watch for changes\" %}\n\nTo allow watching for changes, simply add the watch property.\n\n```json\n{\n \"static-serve\": {\n \"executor\": \"@nrwl/angular:file-server\",\n \"options\": {\n \"buildTarget\": \"app:build\",\n \"port\": 4201,\n \"watch\": true\n }\n }\n}\n```\n\n{% /tab %}\n\n{% /tabs %}\n",
"presets": []
},
"description": "Serve a web application from a folder.",
"description": "Serves a static web application from a folder.",
"aliases": [],
"hidden": false,
"path": "/packages/angular/src/executors/file-server/schema.json"
Expand Down
4 changes: 2 additions & 2 deletions packages/angular/executors.json
Expand Up @@ -13,12 +13,12 @@
"package": {
"implementation": "./src/executors/package/package.impl",
"schema": "./src/executors/package/schema.json",
"description": "Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds."
"description": "Builds and packages an Angular library producing an output following the Angular Package Format (APF) to be distributed as an NPM package.\nThis executor is similar to the `@angular-devkit/build-angular:ng-packagr` with additional support for incremental builds."
},
"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": "Serves a static web application from a folder."
}
},
"builders": {
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/src/executors/delegate-build/schema.json
Expand Up @@ -3,7 +3,7 @@
"outputCapture": "direct-nodejs",
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Schema for an executor which delegates a build.",
"description": "Options for delegating a build to a different target.",
"description": "Delegates the build to a different target while supporting incremental builds.",
"cli": "nx",
"type": "object",
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/src/executors/file-server/schema.json
Expand Up @@ -2,7 +2,7 @@
"version": 2,
"outputCapture": "direct-nodejs",
"title": "File Server",
"description": "Serve a web application from a folder.",
"description": "Serves a static web application from a folder.",
"type": "object",
"cli": "nx",
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/src/executors/ng-packagr-lite/schema.json
Expand Up @@ -3,7 +3,7 @@
"outputCapture": "direct-nodejs",
"$schema": "http://json-schema.org/schema",
"title": "ng-packagr Target",
"description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.",
"description": "Builds a library with support for incremental builds.\n\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.",
"cli": "nx",
"type": "object",
"presets": [
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/src/executors/package/schema.json
Expand Up @@ -3,7 +3,7 @@
"outputCapture": "direct-nodejs",
"$schema": "http://json-schema.org/schema",
"title": "ng-packagr Target",
"description": "ng-packagr target options for Build Architect. Use to build and package library projects for publishing.",
"description": "Builds and packages an Angular library producing an output following the Angular Package Format (APF) to be distributed as an NPM package.\n\nThis executor is similar to the `@angular-devkit/build-angular:ng-packagr` with additional support for incremental builds.",
"cli": "nx",
"type": "object",
"presets": [
Expand Down

1 comment on commit 36ce474

@vercel
Copy link

@vercel vercel bot commented on 36ce474 Nov 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx.dev
nx-five.vercel.app
nx-dev-nrwl.vercel.app

Please sign in to comment.