docs: update command descriptions

This commit is contained in:
Filipe Silva 2018-04-30 17:27:45 -07:00 committed by Hans
parent 6a7c3d68df
commit e64cd783e9
4 changed files with 93 additions and 95 deletions

View File

@ -3,7 +3,7 @@
# ng build
## Overview
`ng build` compiles the application into an output directory
`ng build` compiles the application into an output directory.
### Creating a build
@ -132,7 +132,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>prod</summary>
<p>
<code>--prod</code>
<code>--prod</code>
</p>
<p>
Flag to set configuration to "prod".
@ -141,7 +141,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>configuration</summary>
<p>
<code>--configuration</code> (alias: <code>-c</code>)
<code>--configuration</code> (alias: <code>-c</code>)
</p>
<p>
Specify the configuration to use.
@ -150,7 +150,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>main</summary>
<p>
<code>--main</code>
<code>--main</code>
</p>
<p>
The name of the main entry-point file.
@ -159,7 +159,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>polyfills</summary>
<p>
<code>--polyfills</code>
<code>--polyfills</code>
</p>
<p>
The name of the polyfills file.
@ -168,7 +168,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>ts-config</summary>
<p>
<code>--ts-config</code>
<code>--ts-config</code>
</p>
<p>
The name of the TypeScript configuration file.
@ -177,7 +177,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>optimization</summary>
<p>
<code>--optimization</code>
<code>--optimization</code>
</p>
<p>
Defines the optimization level of the build.
@ -186,7 +186,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>output-path</summary>
<p>
<code>--output-path</code>
<code>--output-path</code>
</p>
<p>
Path where output will be placed.
@ -195,7 +195,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>aot</summary>
<p>
<code>--aot</code>
<code>--aot</code>
</p>
<p>
Build using Ahead of Time compilation.
@ -204,7 +204,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>source-map</summary>
<p>
<code>--source-map</code>
<code>--source-map</code>
</p>
<p>
Output sourcemaps.
@ -213,7 +213,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>eval-source-map</summary>
<p>
<code>--eval-source-map</code>
<code>--eval-source-map</code>
</p>
<p>
Output in-file eval sourcemaps.
@ -222,7 +222,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>vendor-chunk</summary>
<p>
<code>--vendor-chunk</code>
<code>--vendor-chunk</code>
</p>
<p>
Use a separate bundle containing only vendor libraries.
@ -231,7 +231,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>common-chunk</summary>
<p>
<code>--common-chunk</code>
<code>--common-chunk</code>
</p>
<p>
Use a separate bundle containing code used across multiple bundles.
@ -240,7 +240,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>base-href</summary>
<p>
<code>--base-href</code>
<code>--base-href</code>
</p>
<p>
Base url for the application being built.
@ -249,7 +249,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>deploy-url</summary>
<p>
<code>--deploy-url</code>
<code>--deploy-url</code>
</p>
<p>
URL where files will be deployed.
@ -258,7 +258,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>verbose</summary>
<p>
<code>--verbose</code>
<code>--verbose</code>
</p>
<p>
Adds more details to output logging.
@ -267,7 +267,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>progress</summary>
<p>
<code>--progress</code>
<code>--progress</code>
</p>
<p>
Log progress to the console while building.
@ -276,7 +276,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>i18n-file</summary>
<p>
<code>--i18n-file</code>
<code>--i18n-file</code>
</p>
<p>
Localization file to use for i18n.
@ -285,7 +285,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>i18n-format</summary>
<p>
<code>--i18n-format</code>
<code>--i18n-format</code>
</p>
<p>
Format of the localization file specified with --i18n-file.
@ -294,7 +294,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>i18n-locale</summary>
<p>
<code>--i18n-locale</code>
<code>--i18n-locale</code>
</p>
<p>
Locale to use for i18n.
@ -303,7 +303,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>i18n-missing-translation</summary>
<p>
<code>--i18n-missing-translation</code>
<code>--i18n-missing-translation</code>
</p>
<p>
How to handle missing translations for i18n.
@ -312,7 +312,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>extract-css</summary>
<p>
<code>--extract-css</code>
<code>--extract-css</code>
</p>
<p>
Extract css from global styles onto css files instead of js ones.
@ -321,7 +321,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>watch</summary>
<p>
<code>--watch</code>
<code>--watch</code>
</p>
<p>
Run build when files change.
@ -330,7 +330,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>output-hashing</summary>
<p>
<code>--output-hashing</code>
<code>--output-hashing</code>
</p>
<p>
Define the output filename cache-busting hashing mode.
@ -339,7 +339,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>poll</summary>
<p>
<code>--poll</code>
<code>--poll</code>
</p>
<p>
Enable and define the file watching poll time period in milliseconds.
@ -348,7 +348,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>delete-output-path</summary>
<p>
<code>--delete-output-path</code>
<code>--delete-output-path</code>
</p>
<p>
Delete the output path before building.
@ -357,7 +357,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>preserve-symlinks</summary>
<p>
<code>--preserve-symlinks</code>
<code>--preserve-symlinks</code>
</p>
<p>
Do not use the real path when resolving modules.
@ -366,7 +366,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>extract-licenses</summary>
<p>
<code>--extract-licenses</code>
<code>--extract-licenses</code>
</p>
<p>
Extract all licenses in a separate file, in the case of production builds only.
@ -375,7 +375,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>show-circular-dependencies</summary>
<p>
<code>--show-circular-dependencies</code>
<code>--show-circular-dependencies</code>
</p>
<p>
Show circular dependency warnings on builds.
@ -384,7 +384,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>build-optimizer</summary>
<p>
<code>--build-optimizer</code>
<code>--build-optimizer</code>
</p>
<p>
Enables @angular-devkit/build-optimizer optimizations when using the 'aot' option.
@ -393,7 +393,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>named-chunks</summary>
<p>
<code>--named-chunks</code>
<code>--named-chunks</code>
</p>
<p>
Use file name for lazy loaded chunks.
@ -402,7 +402,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>subresource-integrity</summary>
<p>
<code>--subresource-integrity</code>
<code>--subresource-integrity</code>
</p>
<p>
Enables the use of subresource integrity validation.
@ -411,7 +411,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>service-worker</summary>
<p>
<code>--service-worker</code>
<code>--service-worker</code>
</p>
<p>
Generates a service worker config for production builds.
@ -420,7 +420,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>ngsw-config-path</summary>
<p>
<code>--ngsw-config-path</code>
<code>--ngsw-config-path</code>
</p>
<p>
Path to ngsw-config.json.
@ -429,7 +429,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>skip-app-shell</summary>
<p>
<code>--skip-app-shell</code>
<code>--skip-app-shell</code>
</p>
<p>
Flag to prevent building an app shell.
@ -438,7 +438,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>index</summary>
<p>
<code>--index</code>
<code>--index</code>
</p>
<p>
The name of the index HTML file.
@ -447,7 +447,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>stats-json</summary>
<p>
<code>--stats-json</code>
<code>--stats-json</code>
</p>
<p>
Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https: //webpack.github.io/analyse.
@ -456,7 +456,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
<details>
<summary>fork-type-checker</summary>
<p>
<code>--fork-type-checker</code>
<code>--fork-type-checker</code>
</p>
<p>
Run the TypeScript type checker in a forked process.

View File

@ -3,7 +3,7 @@
# ng e2e
## Overview
`ng e2e` serves the application and runs end-to-end tests
`ng e2e` serves the application and runs end-to-end tests.
### Running end-to-end tests
@ -17,7 +17,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>prod</summary>
<p>
<code>--prod</code>
<code>--prod</code>
</p>
<p>
Flag to set configuration to "prod".
@ -26,7 +26,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>configuration</summary>
<p>
<code>--configuration</code> (alias: <code>-c</code>)
<code>--configuration</code> (alias: <code>-c</code>)
</p>
<p>
Specify the configuration to use.
@ -35,7 +35,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>protractor-config</summary>
<p>
<code>--protractor-config</code>
<code>--protractor-config</code>
</p>
<p>
The name of the Protractor configuration file.
@ -44,7 +44,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>dev-server-target</summary>
<p>
<code>--dev-server-target</code>
<code>--dev-server-target</code>
</p>
<p>
Dev server target to run tests against.
@ -53,7 +53,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>suite</summary>
<p>
<code>--suite</code>
<code>--suite</code>
</p>
<p>
Override suite in the protractor config.
@ -62,7 +62,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>element-explorer</summary>
<p>
<code>--element-explorer</code>
<code>--element-explorer</code>
</p>
<p>
Start Protractor's Element Explorer for debugging.
@ -71,7 +71,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>webdriver-update</summary>
<p>
<code>--webdriver-update</code>
<code>--webdriver-update</code>
</p>
<p>
Try to update webdriver.
@ -80,7 +80,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>serve</summary>
<p>
<code>--serve</code>
<code>--serve</code>
</p>
<p>
Compile and Serve the app.
@ -89,7 +89,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>port</summary>
<p>
<code>--port</code>
<code>--port</code>
</p>
<p>
The port to use to serve the application.
@ -98,7 +98,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>host</summary>
<p>
<code>--host</code>
<code>--host</code>
</p>
<p>
Host to listen on.
@ -107,7 +107,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
<details>
<summary>base-url</summary>
<p>
<code>--base-url</code>
<code>--base-url</code>
</p>
<p>
Base URL for protractor to connect to.

View File

@ -5,13 +5,11 @@
## Overview
`ng serve` builds the application and starts a web server.
All the build Options are available in serve, below are the additional options.
## Options
<details>
<summary>prod</summary>
<p>
<code>--prod</code>
<code>--prod</code>
</p>
<p>
Flag to set configuration to "prod".
@ -20,7 +18,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>configuration</summary>
<p>
<code>--configuration</code> (alias: <code>-c</code>)
<code>--configuration</code> (alias: <code>-c</code>)
</p>
<p>
Specify the configuration to use.
@ -29,7 +27,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>browser-target</summary>
<p>
<code>--browser-target</code>
<code>--browser-target</code>
</p>
<p>
Target to serve.
@ -38,7 +36,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>port</summary>
<p>
<code>--port</code>
<code>--port</code>
</p>
<p>
Port to listen on.
@ -47,7 +45,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>host</summary>
<p>
<code>--host</code>
<code>--host</code>
</p>
<p>
Host to listen on.
@ -56,7 +54,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>proxy-config</summary>
<p>
<code>--proxy-config</code>
<code>--proxy-config</code>
</p>
<p>
Proxy configuration file.
@ -65,7 +63,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>ssl</summary>
<p>
<code>--ssl</code>
<code>--ssl</code>
</p>
<p>
Serve using HTTPS.
@ -74,7 +72,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>ssl-key</summary>
<p>
<code>--ssl-key</code>
<code>--ssl-key</code>
</p>
<p>
SSL key to use for serving HTTPS.
@ -83,7 +81,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>ssl-cert</summary>
<p>
<code>--ssl-cert</code>
<code>--ssl-cert</code>
</p>
<p>
SSL certificate to use for serving HTTPS.
@ -92,7 +90,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>open</summary>
<p>
<code>--open</code> (alias: <code>-o</code>)
<code>--open</code> (alias: <code>-o</code>)
</p>
<p>
Opens the url in default browser.
@ -101,7 +99,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>live-reload</summary>
<p>
<code>--live-reload</code>
<code>--live-reload</code>
</p>
<p>
Whether to reload the page on change, using live-reload.
@ -110,7 +108,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>public-host</summary>
<p>
<code>--public-host</code>
<code>--public-host</code>
</p>
<p>
Specify the URL that the browser client will use.
@ -119,7 +117,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>serve-path</summary>
<p>
<code>--serve-path</code>
<code>--serve-path</code>
</p>
<p>
The pathname where the app will be served.
@ -128,7 +126,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>disable-host-check</summary>
<p>
<code>--disable-host-check</code>
<code>--disable-host-check</code>
</p>
<p>
Don't verify connected clients are part of allowed hosts.
@ -137,7 +135,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>hmr</summary>
<p>
<code>--hmr</code>
<code>--hmr</code>
</p>
<p>
Enable hot module replacement.
@ -146,7 +144,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>watch</summary>
<p>
<code>--watch</code>
<code>--watch</code>
</p>
<p>
Rebuild on change.
@ -155,7 +153,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>hmr-warning</summary>
<p>
<code>--hmr-warning</code>
<code>--hmr-warning</code>
</p>
<p>
Show a warning when the --hmr option is enabled.
@ -164,7 +162,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>serve-path-default-warning</summary>
<p>
<code>--serve-path-default-warning</code>
<code>--serve-path-default-warning</code>
</p>
<p>
Show a warning when deploy-url/base-href use unsupported serve path values.
@ -173,7 +171,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>optimization</summary>
<p>
<code>--optimization</code>
<code>--optimization</code>
</p>
<p>
Defines the optimization level of the build.
@ -182,7 +180,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>aot</summary>
<p>
<code>--aot</code>
<code>--aot</code>
</p>
<p>
Build using Ahead of Time compilation.
@ -191,7 +189,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>source-map</summary>
<p>
<code>--source-map</code>
<code>--source-map</code>
</p>
<p>
Output sourcemaps.
@ -200,7 +198,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>eval-source-map</summary>
<p>
<code>--eval-source-map</code>
<code>--eval-source-map</code>
</p>
<p>
Output in-file eval sourcemaps.
@ -209,7 +207,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>vendor-chunk</summary>
<p>
<code>--vendor-chunk</code>
<code>--vendor-chunk</code>
</p>
<p>
Use a separate bundle containing only vendor libraries.
@ -218,7 +216,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>common-chunk</summary>
<p>
<code>--common-chunk</code>
<code>--common-chunk</code>
</p>
<p>
Use a separate bundle containing code used across multiple bundles.
@ -227,7 +225,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>base-href</summary>
<p>
<code>--base-href</code>
<code>--base-href</code>
</p>
<p>
Base url for the application being built.
@ -236,7 +234,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>deploy-url</summary>
<p>
<code>--deploy-url</code>
<code>--deploy-url</code>
</p>
<p>
URL where files will be deployed.
@ -245,7 +243,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>verbose</summary>
<p>
<code>--verbose</code>
<code>--verbose</code>
</p>
<p>
Adds more details to output logging.
@ -254,7 +252,7 @@ All the build Options are available in serve, below are the additional options.
<details>
<summary>progress</summary>
<p>
<code>--progress</code>
<code>--progress</code>
</p>
<p>
Log progress to the console while building.

View File

@ -11,7 +11,7 @@
ng test
```
Tests will execute after a build is executed via [Karma](http://karma-runner.github.io/0.13/index.html), and it will automatically watch your files for changes. You can run tests a single time via `--watch=false` or `--single-run`.
Tests will execute after a build is executed via [Karma](http://karma-runner.github.io/0.13/index.html), and it will automatically watch your files for changes. You can run tests a single time via `--watch=false`.
You can run tests with coverage via `--code-coverage`. The coverage report will be in the `coverage/` directory.
@ -19,7 +19,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>prod</summary>
<p>
<code>--prod</code>
<code>--prod</code>
</p>
<p>
Flag to set configuration to "prod".
@ -28,7 +28,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>configuration</summary>
<p>
<code>--configuration</code> (alias: <code>-c</code>)
<code>--configuration</code> (alias: <code>-c</code>)
</p>
<p>
Specify the configuration to use.
@ -37,7 +37,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>main</summary>
<p>
<code>--main</code>
<code>--main</code>
</p>
<p>
The name of the main entry-point file.
@ -46,7 +46,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>ts-config</summary>
<p>
<code>--ts-config</code>
<code>--ts-config</code>
</p>
<p>
The name of the TypeScript configuration file.
@ -55,7 +55,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>karma-config</summary>
<p>
<code>--karma-config</code>
<code>--karma-config</code>
</p>
<p>
The name of the Karma configuration file.
@ -64,7 +64,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>polyfills</summary>
<p>
<code>--polyfills</code>
<code>--polyfills</code>
</p>
<p>
The name of the polyfills file.
@ -73,7 +73,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>environment</summary>
<p>
<code>--environment</code>
<code>--environment</code>
</p>
<p>
Defines the build environment.
@ -82,7 +82,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>source-map</summary>
<p>
<code>--source-map</code>
<code>--source-map</code>
</p>
<p>
Output sourcemaps.
@ -91,7 +91,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>progress</summary>
<p>
<code>--progress</code>
<code>--progress</code>
</p>
<p>
Log progress to the console while building.
@ -100,7 +100,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>watch</summary>
<p>
<code>--watch</code>
<code>--watch</code>
</p>
<p>
Run build when files change.
@ -109,7 +109,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>poll</summary>
<p>
<code>--poll</code>
<code>--poll</code>
</p>
<p>
Enable and define the file watching poll time period in milliseconds.
@ -118,7 +118,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>preserve-symlinks</summary>
<p>
<code>--preserve-symlinks</code>
<code>--preserve-symlinks</code>
</p>
<p>
Do not use the real path when resolving modules.
@ -127,7 +127,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>browsers</summary>
<p>
<code>--browsers</code>
<code>--browsers</code>
</p>
<p>
Override which browsers tests are run against.
@ -136,7 +136,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will
<details>
<summary>code-coverage</summary>
<p>
<code>--code-coverage</code>
<code>--code-coverage</code>
</p>
<p>
Output a code coverage report.