Skip to content
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.

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

Update doc strings for command reference #12520

Merged
merged 1 commit into from
Oct 10, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/angular/cli/commands/config.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/config.json",
"description": "Get/set configuration values.",
"description": "Retrieves or sets Angular configuration values.",
"$longDescription": "",

"$aliases": [],
Expand All @@ -15,23 +15,23 @@
"properties": {
"jsonPath": {
"type": "string",
"description": "The path to the value to get/set.",
"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.",
"$default": {
"$source": "argv",
"index": 0
}
},
"value": {
"type": ["string", "number", "boolean"],
"description": "The new value to be set.",
"description": "If provided, a new value for the given configuration key.",
"$default": {
"$source": "argv",
"index": 1
}
},
"global": {
"type": "boolean",
"description": "Get/set the value in the global configuration (in your home directory).",
"description": "When true, accesses the global configuration in the caller's home directory.",
"default": false,
"aliases": ["g"]
}
Expand Down
12 changes: 6 additions & 6 deletions packages/angular/cli/commands/definitions.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
}
},
"configuration": {
"description": "A named configuration environment, as specified in the `configurations` section of `angular.json`.",
"description": "A named configuration environment, as specified in the \"configurations\" section of angular.json.",
"type": "string",
"aliases": [
"c"
Expand All @@ -31,7 +31,7 @@
"properties": {
"help": {
"enum": [true, false, "json", "JSON"],
"description": "Shows a help message. You can pass the format as a value.",
"description": "Shows a help message for this command in the console.",
"default": false
}
}
Expand All @@ -42,23 +42,23 @@
"type": "boolean",
"default": false,
"aliases": [ "d" ],
"description": "Run through without making any changes."
"description": "When true, run through and report activity without writing out results."
},
"force": {
"type": "boolean",
"default": false,
"aliases": [ "f" ],
"description": "Forces overwriting of files."
"description": "When true, force overwriting of existing files."
},
"interactive": {
"type": "boolean",
"default": "true",
"description": "Disables interactive inputs (i.e., prompts)."
"description": "When false, disables interactive input prompts."
},
"defaults": {
"type": "boolean",
"default": "false",
"description": "Disables interactive inputs (i.e., prompts) for options with a default."
"description": "When true, disables interactive input prompts for options with a default."
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions packages/angular/cli/commands/doc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/doc.json",
"description": "Opens the official Angular API documentation for a given keyword.",
"description": "Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword.",
"$longDescription": "",

"$aliases": [ "d" ],
Expand All @@ -14,7 +14,7 @@
"properties": {
"keyword": {
"type": "string",
"description": "The query to search upon.",
"description": "The keyword to search for, as provided in the search bar in angular.io.",
"$default": {
"$source": "argv",
"index": 0
Expand All @@ -24,7 +24,7 @@
"aliases": ["s"],
"type": "boolean",
"default": false,
"description": "Search whole angular.io instead of just api."
"description": "When true, searches all of angular.io. Otherwise, searches only API reference documentation."
}
},
"required": [
Expand Down
4 changes: 2 additions & 2 deletions packages/angular/cli/commands/e2e.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/e2e.json",
"description": "Runs the end-to-end tests.",
"$longDescription": "",
"description": "Builds and serves an Angular app, and runs end-to-end tests using Protractor.",
"$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.",

"$aliases": [ "e" ],
"$scope": "in",
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/cli/commands/help.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/help.json",
"description": "Displays help for the Angular CLI.",
"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.",
"$longDescription": "",

"$scope": "all",
Expand Down
2 changes: 2 additions & 0 deletions packages/angular/cli/commands/lint-long.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Takes the name of the project, as specified in the `projects` section of the `angular.json` workspace configuration file.
When a project name is not supplied, uses the configured `defaultProject` of the workspace.
4 changes: 2 additions & 2 deletions packages/angular/cli/commands/lint.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"$schema": "http://json-schema.org/schema",
"$id": "ng-cli://commands/lint.json",
"description": "Lints code in existing project.",
"$longDescription": "",
"description": "Runs the TSLint tool on Angular app code in the given project folder.",
"$longDescription": "./lint-long.md",

"$aliases": [ "l" ],
"$scope": "in",
Expand Down