Skip to content

Commit f48a163

Browse files
jbogarthydevikerman
authored andcommitted
docs: cli command docs (#12520)
1 parent 1747845 commit f48a163

File tree

7 files changed

+20
-18
lines changed

7 files changed

+20
-18
lines changed

packages/angular/cli/commands/config.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "http://json-schema.org/schema",
33
"$id": "ng-cli://commands/config.json",
4-
"description": "Get/set configuration values.",
4+
"description": "Retrieves or sets Angular configuration values.",
55
"$longDescription": "",
66

77
"$aliases": [],
@@ -15,23 +15,23 @@
1515
"properties": {
1616
"jsonPath": {
1717
"type": "string",
18-
"description": "The path to the value to get/set.",
18+
"description": "The configuration key to set or query, in JSON path format. For example: \"a[3].foo.bar[2]\". If no new value is provided, returns the current value of this key.",
1919
"$default": {
2020
"$source": "argv",
2121
"index": 0
2222
}
2323
},
2424
"value": {
2525
"type": ["string", "number", "boolean"],
26-
"description": "The new value to be set.",
26+
"description": "If provided, a new value for the given configuration key.",
2727
"$default": {
2828
"$source": "argv",
2929
"index": 1
3030
}
3131
},
3232
"global": {
3333
"type": "boolean",
34-
"description": "Get/set the value in the global configuration (in your home directory).",
34+
"description": "When true, accesses the global configuration in the caller's home directory.",
3535
"default": false,
3636
"aliases": ["g"]
3737
}

packages/angular/cli/commands/definitions.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
}
1515
},
1616
"configuration": {
17-
"description": "A named configuration environment, as specified in the `configurations` section of `angular.json`.",
17+
"description": "A named configuration environment, as specified in the \"configurations\" section of angular.json.",
1818
"type": "string",
1919
"aliases": [
2020
"c"
@@ -31,7 +31,7 @@
3131
"properties": {
3232
"help": {
3333
"enum": [true, false, "json", "JSON"],
34-
"description": "Shows a help message. You can pass the format as a value.",
34+
"description": "Shows a help message for this command in the console.",
3535
"default": false
3636
}
3737
}
@@ -42,23 +42,23 @@
4242
"type": "boolean",
4343
"default": false,
4444
"aliases": [ "d" ],
45-
"description": "Run through without making any changes."
45+
"description": "When true, run through and report activity without writing out results."
4646
},
4747
"force": {
4848
"type": "boolean",
4949
"default": false,
5050
"aliases": [ "f" ],
51-
"description": "Forces overwriting of files."
51+
"description": "When true, force overwriting of existing files."
5252
},
5353
"interactive": {
5454
"type": "boolean",
5555
"default": "true",
56-
"description": "Disables interactive inputs (i.e., prompts)."
56+
"description": "When false, disables interactive input prompts."
5757
},
5858
"defaults": {
5959
"type": "boolean",
6060
"default": "false",
61-
"description": "Disables interactive inputs (i.e., prompts) for options with a default."
61+
"description": "When true, disables interactive input prompts for options with a default."
6262
}
6363
}
6464
}

packages/angular/cli/commands/doc.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "http://json-schema.org/schema",
33
"$id": "ng-cli://commands/doc.json",
4-
"description": "Opens the official Angular API documentation for a given keyword.",
4+
"description": "Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword.",
55
"$longDescription": "",
66

77
"$aliases": [ "d" ],
@@ -14,7 +14,7 @@
1414
"properties": {
1515
"keyword": {
1616
"type": "string",
17-
"description": "The query to search upon.",
17+
"description": "The keyword to search for, as provided in the search bar in angular.io.",
1818
"$default": {
1919
"$source": "argv",
2020
"index": 0
@@ -24,7 +24,7 @@
2424
"aliases": ["s"],
2525
"type": "boolean",
2626
"default": false,
27-
"description": "Search whole angular.io instead of just api."
27+
"description": "When true, searches all of angular.io. Otherwise, searches only API reference documentation."
2828
}
2929
},
3030
"required": [

packages/angular/cli/commands/e2e.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"$schema": "http://json-schema.org/schema",
33
"$id": "ng-cli://commands/e2e.json",
4-
"description": "Runs the end-to-end tests.",
5-
"$longDescription": "",
4+
"description": "Builds and serves an Angular app, and runs end-to-end tests using Protractor.",
5+
"$longDescription": "Must be executed from within a workspace directory.\n When a project name is not supplied, the configured default e2e project of the workspace is used.",
66

77
"$aliases": [ "e" ],
88
"$scope": "in",

packages/angular/cli/commands/help.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "http://json-schema.org/schema",
33
"$id": "ng-cli://commands/help.json",
4-
"description": "Displays help for the Angular CLI.",
4+
"description": "Lists available commands and their short descriptions in the console. \n &nbsp &nbsp For help with individual commands, use the \"--help\" or \"-h\" option with the command.",
55
"$longDescription": "",
66

77
"$scope": "all",
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Takes the name of the project, as specified in the `projects` section of the `angular.json` workspace configuration file.
2+
When a project name is not supplied, uses the configured `defaultProject` of the workspace.

packages/angular/cli/commands/lint.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"$schema": "http://json-schema.org/schema",
33
"$id": "ng-cli://commands/lint.json",
4-
"description": "Lints code in existing project.",
5-
"$longDescription": "",
4+
"description": "Runs the TSLint tool on Angular app code in the given project folder.",
5+
"$longDescription": "./lint-long.md",
66

77
"$aliases": [ "l" ],
88
"$scope": "in",

0 commit comments

Comments
 (0)