Skip to content

Commit 21956ca

Browse files
alexeaglealexeagle
committed
docs: minor updates to command reference
Don't mention Architect We don't inline resources anymore Minor grammar tweaks Split out a couple more long descriptions so the short description is plain text
1 parent 3ad551c commit 21956ca

12 files changed

Lines changed: 28 additions & 15 deletions

File tree

‎packages/angular/cli/commands/add.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/add.json",
4-
"description": "Adds support for a published library to your project.",
4+
"description": "Adds support for an external library to your project.",
55
"$longDescription": "./add.md",
66

77
"$scope": "in",

‎packages/angular/cli/commands/build-long.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root
2-
of the output folder. If a resource is less than 10kb, it is also included inline.
1+
Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root of the output folder.
32

4-
Uses the Webpack build tool, with environment and build options specified in the CLI configuration
5-
file.
3+
Uses the Webpack build tool, with environment and build options specified in the CLI configuration file.

‎packages/angular/cli/commands/e2e.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/e2e.json",
4-
"description": "Builds and serves an Angular app, and runs end-to-end tests using Protractor.",
4+
"description": "Builds and serves an Angular app, then runs end-to-end tests using Protractor.",
55
"$longDescription": "./e2e-long.md",
66

77
"$aliases": [ "e" ],

‎packages/angular/cli/commands/eject-long.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The 'eject' command has been disabled and will be removed completely in 8.0.
2+
The new configuration format provides increased flexibility to modify the
3+
configuration of your workspace without ejecting.
4+
5+
There are several projects that can be used in conjuction with the new
6+
configuration format that provide the benefits of ejecting without the maintenance
7+
overhead. One such project is ngx-build-plus found here:
8+
https://github.com/manfredsteyer/ngx-build-plus

‎packages/angular/cli/commands/eject.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/eject.json",
4-
"description": "Temporarily disabled. Ejects your app and output the proper webpack configuration and scripts.",
5-
"$longDescription": "",
4+
"description": "Deprecated, will be removed in Angular 8.0.",
5+
"$longDescription": "./eject-long.md",
66

77
"$hidden": true,
88
"$scope": "in",

‎packages/angular/cli/commands/help-long.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
For help with individual commands, use the `--help` or `-h` option with the command.
2+
3+
For example,
4+
5+
```sh
6+
ng help serve
7+
```

‎packages/angular/cli/commands/help.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/help.json",
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.",
5-
"$longDescription": "",
4+
"description": "Lists available commands and their short descriptions.",
5+
"$longDescription": "./help-long.md",
66

77
"$scope": "all",
88
"$aliases": [],

‎packages/angular/cli/commands/lint.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/lint.json",
4-
"description": "Runs the TSLint tool on Angular app code in the given project folder.",
4+
"description": "Runs linting tools on Angular app code in a given project folder.",
55
"$longDescription": "./lint-long.md",
66

77
"$aliases": [ "l" ],

‎packages/angular/cli/commands/run.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/run.json",
4-
"description": "Runs Architect targets.",
4+
"description": "Runs a custom target defined in your project.",
55
"$longDescription": "",
66

77
"$aliases": [],

‎packages/angular/cli/commands/test.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/test.json",
4-
"description": "Run unit tests in existing project.",
4+
"description": "Runs unit tests in a project.",
55
"$longDescription": "",
66

77
"$aliases": [ "t" ],

0 commit comments

Comments
 (0)