Skip to content

docs: improve description for optimization and target options. #19474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 25, 2020
Merged

docs: improve description for optimization and target options. #19474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/angular/cli/commands/definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
}
},
"configuration": {
"description": "A named build target, as specified in the \"configurations\" section of angular.json.\nEach named target is accompanied by a configuration of option defaults for that target.\nSetting this explicitly overrides the \"--prod\" flag",
"description": "One or more named builder configurations as a comma-separated list as specified in the \"configurations\" section of angular.json.\nThe builder uses the named configurations to run the given target.\nFor more information, see https://angular.io/guide/workspace-config#alternate-build-configurations.\nSetting this explicitly overrides the \"--prod\" flag",
"type": "string",
"aliases": [
"c"
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/cli/commands/deploy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
}
},
"configuration": {
"description": "A named build target, as specified in the \"configurations\" section of angular.json.\nEach named target is accompanied by a configuration of option defaults for that target.",
"description": "One or more named builder configurations as a comma-separated list as specified in the \"configurations\" section of angular.json.\nThe builder uses the named configurations to run the given target.\nFor more information, see https://angular.io/guide/workspace-config#alternate-build-configurations.",
"type": "string",
"aliases": [
"c"
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/cli/commands/run.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
}
},
"configuration": {
"description": "A named builder configuration, defined in the \"configurations\" section of angular.json.\nThe builder uses the named configuration to run the given target.",
"description": "One or more named builder configurations as a comma-separated list as specified in the \"configurations\" section of angular.json.\nThe builder uses the named configurations to run the given target.\nFor more information, see https://angular.io/guide/workspace-config#alternate-build-configurations.",
"type": "string",
"aliases": [ "c" ]
}
Expand Down
16 changes: 8 additions & 8 deletions packages/angular/cli/lib/config/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,11 +633,11 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target to build."
"description": "A browser builder target to use for rendering the app shell in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`."
},
"serverTarget": {
"type": "string",
"description": "Server target to use for rendering the app shell."
"description": "A server builder target to use for rendering the app shell in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`."
},
"appModuleBundle": {
"type": "string",
Expand Down Expand Up @@ -715,7 +715,7 @@
"additionalProperties": false
},
"optimization": {
"description": "Enables optimization of the build output.",
"description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code eliminiation and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-and-source-map-configuration.",
"oneOf": [
{
"type": "object",
Expand Down Expand Up @@ -1188,7 +1188,7 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target to serve."
"description": "A browser builder target to serve in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`."
},
"port": {
"type": "number",
Expand Down Expand Up @@ -1280,7 +1280,7 @@
"default": true
},
"optimization": {
"description": "Enable optimization of the build output.",
"description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code eliminiation and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-and-source-map-configuration.",
"default": false,
"oneOf": [
{
Expand Down Expand Up @@ -1371,7 +1371,7 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target to extract from."
"description": "A browser builder target to extract i18n messages in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`."
},
"format": {
"type": "string",
Expand Down Expand Up @@ -1689,7 +1689,7 @@
},
"devServerTarget": {
"type": "string",
"description": "Dev server target to run tests against."
"description": "A dev-server builder target to run tests against in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`."
},
"grep": {
"type": "string",
Expand Down Expand Up @@ -1767,7 +1767,7 @@
"additionalProperties": false
},
"optimization": {
"description": "Enables optimization of the build output.",
"description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking and dead-code eliminiation. For more information, see https://angular.io/guide/workspace-config#optimization-and-source-map-configuration.",
"default": false,
"oneOf": [
{
Expand Down
4 changes: 2 additions & 2 deletions packages/angular_devkit/build_angular/src/app-shell/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target to build.",
"description": "A browser builder target use for rendering the app shell in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
},
"serverTarget": {
"type": "string",
"description": "Server target to use for rendering the app shell.",
"description": "A server builder target use for rendering the app shell in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
},
"appModuleBundle": {
Expand Down
2 changes: 1 addition & 1 deletion packages/angular_devkit/build_angular/src/browser/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"additionalProperties": false
},
"optimization": {
"description": "Enables optimization of the build output.",
"description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code eliminiation and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-and-source-map-configuration.",
"x-user-analytics": 16,
"default": false,
"oneOf": [
Expand Down
4 changes: 2 additions & 2 deletions packages/angular_devkit/build_angular/src/dev-server/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target to serve.",
"description": "A browser builder target to serve in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
},
"port": {
Expand Down Expand Up @@ -105,7 +105,7 @@
"x-deprecated": "No longer has an effect."
},
"optimization": {
"description": "Enables optimization of the build output.",
"description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code eliminiation, tree-shaking and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-and-source-map-configuration.",
"x-user-analytics": 16,
"oneOf": [
{
Expand Down
2 changes: 1 addition & 1 deletion packages/angular_devkit/build_angular/src/extract-i18n/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"properties": {
"browserTarget": {
"type": "string",
"description": "Target to extract from.",
"description": "A browser builder target to extract i18n messages in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`.",
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
},
"format": {
Expand Down
2 changes: 1 addition & 1 deletion packages/angular_devkit/build_angular/src/protractor/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"devServerTarget": {
"type": "string",
"description": "Dev server target to run tests against.",
"description": "A dev-server builder target to run tests against in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`.",
"pattern": "^([^:\\s]+:[^:\\s]+(:[^\\s]+)?)?$"
},
"grep": {
Expand Down
2 changes: 1 addition & 1 deletion packages/angular_devkit/build_angular/src/server/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"additionalProperties": false
},
"optimization": {
"description": "Enables optimization of the build output.",
"description": "Enables optimization of the build output. Including minification of scripts and styles, tree-shaking and dead-code eliminiation. For more information, see https://angular.io/guide/workspace-config#optimization-and-source-map-configuration.",
"x-user-analytics": 16,
"default": false,
"oneOf": [
Expand Down