Skip to content

Commit c31e574

Browse files
alan-agius4filipesilva
authored andcommitted
docs: improve description for optimization, configuration and target options.
Closes #16572 Closes #17978 Closes angular/angular#39780
1 parent 2f12840 commit c31e574

File tree

10 files changed

+19
-19
lines changed

10 files changed

+19
-19
lines changed

packages/angular/cli/commands/definitions.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
}
1515
},
1616
"configuration": {
17-
"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",
17+
"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",
1818
"type": "string",
1919
"aliases": [
2020
"c"

packages/angular/cli/commands/deploy.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
}
2121
},
2222
"configuration": {
23-
"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.",
23+
"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.",
2424
"type": "string",
2525
"aliases": [
2626
"c"

packages/angular/cli/commands/run.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
}
2323
},
2424
"configuration": {
25-
"description": "A named builder configuration, defined in the \"configurations\" section of angular.json.\nThe builder uses the named configuration to run the given target.",
25+
"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.",
2626
"type": "string",
2727
"aliases": [ "c" ]
2828
}

packages/angular/cli/lib/config/schema.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -619,11 +619,11 @@
619619
"properties": {
620620
"browserTarget": {
621621
"type": "string",
622-
"description": "Target to build."
622+
"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`."
623623
},
624624
"serverTarget": {
625625
"type": "string",
626-
"description": "Server target to use for rendering the app shell."
626+
"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`."
627627
},
628628
"appModuleBundle": {
629629
"type": "string",
@@ -701,7 +701,7 @@
701701
"additionalProperties": false
702702
},
703703
"optimization": {
704-
"description": "Enables optimization of the build output.",
704+
"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.",
705705
"oneOf": [
706706
{
707707
"type": "object",
@@ -1169,7 +1169,7 @@
11691169
"properties": {
11701170
"browserTarget": {
11711171
"type": "string",
1172-
"description": "Target to serve."
1172+
"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`."
11731173
},
11741174
"port": {
11751175
"type": "number",
@@ -1261,7 +1261,7 @@
12611261
"default": true
12621262
},
12631263
"optimization": {
1264-
"description": "Enable optimization of the build output.",
1264+
"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.",
12651265
"default": false,
12661266
"oneOf": [
12671267
{
@@ -1352,7 +1352,7 @@
13521352
"properties": {
13531353
"browserTarget": {
13541354
"type": "string",
1355-
"description": "Target to extract from."
1355+
"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`."
13561356
},
13571357
"format": {
13581358
"type": "string",
@@ -1665,7 +1665,7 @@
16651665
},
16661666
"devServerTarget": {
16671667
"type": "string",
1668-
"description": "Dev server target to run tests against."
1668+
"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`."
16691669
},
16701670
"grep": {
16711671
"type": "string",
@@ -1743,7 +1743,7 @@
17431743
"additionalProperties": false
17441744
},
17451745
"optimization": {
1746-
"description": "Enables optimization of the build output.",
1746+
"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.",
17471747
"default": false,
17481748
"oneOf": [
17491749
{

packages/angular_devkit/build_angular/src/app-shell/schema.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
"properties": {
77
"browserTarget": {
88
"type": "string",
9-
"description": "Target to build.",
9+
"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`.",
1010
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
1111
},
1212
"serverTarget": {
1313
"type": "string",
14-
"description": "Server target to use for rendering the app shell.",
14+
"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`.",
1515
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
1616
},
1717
"appModuleBundle": {

packages/angular_devkit/build_angular/src/browser/schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
"additionalProperties": false
5858
},
5959
"optimization": {
60-
"description": "Enables optimization of the build output.",
60+
"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.",
6161
"x-user-analytics": 16,
6262
"default": false,
6363
"oneOf": [

packages/angular_devkit/build_angular/src/dev-server/schema.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"properties": {
77
"browserTarget": {
88
"type": "string",
9-
"description": "Target to serve.",
9+
"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`.",
1010
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
1111
},
1212
"port": {
@@ -105,7 +105,7 @@
105105
"x-deprecated": "No longer has an effect."
106106
},
107107
"optimization": {
108-
"description": "Enables optimization of the build output.",
108+
"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.",
109109
"x-user-analytics": 16,
110110
"oneOf": [
111111
{

packages/angular_devkit/build_angular/src/extract-i18n/schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"properties": {
77
"browserTarget": {
88
"type": "string",
9-
"description": "Target to extract from.",
9+
"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`.",
1010
"pattern": "^[^:\\s]+:[^:\\s]+(:[^\\s]+)?$"
1111
},
1212
"format": {

packages/angular_devkit/build_angular/src/protractor/schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
},
1111
"devServerTarget": {
1212
"type": "string",
13-
"description": "Dev server target to run tests against.",
13+
"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`.",
1414
"pattern": "^([^:\\s]+:[^:\\s]+(:[^\\s]+)?)?$"
1515
},
1616
"grep": {

packages/angular_devkit/build_angular/src/server/schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"additionalProperties": false
3030
},
3131
"optimization": {
32-
"description": "Enables optimization of the build output.",
32+
"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.",
3333
"x-user-analytics": 16,
3434
"default": false,
3535
"oneOf": [

0 commit comments

Comments
 (0)