From 36ce474e69999c6b5093d983ad67863f0fd6ecf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leosvel=20P=C3=A9rez=20Espinosa?= Date: Tue, 29 Nov 2022 12:08:48 +0100 Subject: [PATCH] docs(angular): improve executor descriptions (#13466) --- docs/generated/packages/angular.json | 12 ++++++------ packages/angular/executors.json | 4 ++-- .../angular/src/executors/delegate-build/schema.json | 2 +- .../angular/src/executors/file-server/schema.json | 2 +- .../src/executors/ng-packagr-lite/schema.json | 2 +- packages/angular/src/executors/package/schema.json | 2 +- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/generated/packages/angular.json b/docs/generated/packages/angular.json index 8f5731ec1b790..34017795d12d4 100644 --- a/docs/generated/packages/angular.json +++ b/docs/generated/packages/angular.json @@ -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": { @@ -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": [ @@ -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": [ @@ -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" @@ -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": { @@ -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" diff --git a/packages/angular/executors.json b/packages/angular/executors.json index 188c3831eab2c..621c38cf64fbb 100644 --- a/packages/angular/executors.json +++ b/packages/angular/executors.json @@ -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": { diff --git a/packages/angular/src/executors/delegate-build/schema.json b/packages/angular/src/executors/delegate-build/schema.json index 301293cbd1b33..d60ccce50361a 100644 --- a/packages/angular/src/executors/delegate-build/schema.json +++ b/packages/angular/src/executors/delegate-build/schema.json @@ -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": { diff --git a/packages/angular/src/executors/file-server/schema.json b/packages/angular/src/executors/file-server/schema.json index ed8aaf6a8d1ac..5773152a71765 100644 --- a/packages/angular/src/executors/file-server/schema.json +++ b/packages/angular/src/executors/file-server/schema.json @@ -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": { diff --git a/packages/angular/src/executors/ng-packagr-lite/schema.json b/packages/angular/src/executors/ng-packagr-lite/schema.json index 8a1233ab7b145..a435690103eef 100644 --- a/packages/angular/src/executors/ng-packagr-lite/schema.json +++ b/packages/angular/src/executors/ng-packagr-lite/schema.json @@ -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": [ diff --git a/packages/angular/src/executors/package/schema.json b/packages/angular/src/executors/package/schema.json index 03b30e8b85052..f226b0387f6ce 100644 --- a/packages/angular/src/executors/package/schema.json +++ b/packages/angular/src/executors/package/schema.json @@ -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": [