Skip to content

Commit

Permalink
docs(@angular/cli): minor updates to ng run description
Browse files Browse the repository at this point in the history
Minor improvements of `ng run` docs

(cherry picked from commit 89ab299)
  • Loading branch information
alan-agius4 authored and clydin committed Jan 24, 2023
1 parent 2c04f4a commit e293cb1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
3 changes: 2 additions & 1 deletion packages/angular/cli/src/commands/run/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ export class RunCommandModule

const localYargs: Argv<RunCommandArgs> = argv
.positional('target', {
describe: 'The Architect target to run.',
describe:
'The Architect target to run provided in the the following format `project:target[:configuration]`.',
type: 'string',
demandOption: true,
// Show only in when using --help and auto completion because otherwise comma seperated configuration values will be invalid.
Expand Down
18 changes: 6 additions & 12 deletions packages/angular/cli/src/commands/run/long-description.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
Architect is the tool that the CLI uses to perform complex tasks such as compilation, according to provided configurations.
The CLI commands run Architect targets such as `build`, `serve`, `test`, and `lint`.
Each named target has a default configuration, specified by an "options" object,
and an optional set of named alternate configurations in the "configurations" object.
Each named target has a default configuration, specified by an `options` object,
and an optional set of named alternate configurations in the `configurations` object.

For example, the "serve" target for a newly generated app has a predefined
alternate configuration named "production".
For example, the `serve` target for a newly generated app has a predefined
alternate configuration named `production`.

You can define new targets and their configuration options in the "architect" section
of the `angular.json` file.
If you do so, you can run them from the command line using the `ng run` command.
Execute the command using the following format.

```
ng run project:target[:configuration]
```
You can define new targets and their configuration options in the `architect` section
of the `angular.json` file which you can run them from the command line using the `ng run` command.

0 comments on commit e293cb1

Please sign in to comment.