From e64cd783e968a9d48a06298921cc7cca487c3dc7 Mon Sep 17 00:00:00 2001 From: Filipe Silva Date: Mon, 30 Apr 2018 17:27:45 -0700 Subject: [PATCH] docs: update command descriptions --- docs/documentation/build.md | 76 ++++++++++++++++++------------------- docs/documentation/e2e.md | 24 ++++++------ docs/documentation/serve.md | 58 ++++++++++++++-------------- docs/documentation/test.md | 30 +++++++-------- 4 files changed, 93 insertions(+), 95 deletions(-) diff --git a/docs/documentation/build.md b/docs/documentation/build.md index 252e2b464d..a63fd86195 100644 --- a/docs/documentation/build.md +++ b/docs/documentation/build.md @@ -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.
prod

- --prod + --prod

Flag to set configuration to "prod". @@ -141,7 +141,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

configuration

- --configuration (alias: -c) + --configuration (alias: -c)

Specify the configuration to use. @@ -150,7 +150,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

main

- --main + --main

The name of the main entry-point file. @@ -159,7 +159,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

polyfills

- --polyfills + --polyfills

The name of the polyfills file. @@ -168,7 +168,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

ts-config

- --ts-config + --ts-config

The name of the TypeScript configuration file. @@ -177,7 +177,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

optimization

- --optimization + --optimization

Defines the optimization level of the build. @@ -186,7 +186,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

output-path

- --output-path + --output-path

Path where output will be placed. @@ -195,7 +195,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

aot

- --aot + --aot

Build using Ahead of Time compilation. @@ -204,7 +204,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

source-map

- --source-map + --source-map

Output sourcemaps. @@ -213,7 +213,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

eval-source-map

- --eval-source-map + --eval-source-map

Output in-file eval sourcemaps. @@ -222,7 +222,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

vendor-chunk

- --vendor-chunk + --vendor-chunk

Use a separate bundle containing only vendor libraries. @@ -231,7 +231,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

common-chunk

- --common-chunk + --common-chunk

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.

base-href

- --base-href + --base-href

Base url for the application being built. @@ -249,7 +249,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

deploy-url

- --deploy-url + --deploy-url

URL where files will be deployed. @@ -258,7 +258,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

verbose

- --verbose + --verbose

Adds more details to output logging. @@ -267,7 +267,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

progress

- --progress + --progress

Log progress to the console while building. @@ -276,7 +276,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

i18n-file

- --i18n-file + --i18n-file

Localization file to use for i18n. @@ -285,7 +285,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

i18n-format

- --i18n-format + --i18n-format

Format of the localization file specified with --i18n-file. @@ -294,7 +294,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

i18n-locale

- --i18n-locale + --i18n-locale

Locale to use for i18n. @@ -303,7 +303,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

i18n-missing-translation

- --i18n-missing-translation + --i18n-missing-translation

How to handle missing translations for i18n. @@ -312,7 +312,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

extract-css

- --extract-css + --extract-css

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.

watch

- --watch + --watch

Run build when files change. @@ -330,7 +330,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

output-hashing

- --output-hashing + --output-hashing

Define the output filename cache-busting hashing mode. @@ -339,7 +339,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

poll

- --poll + --poll

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.

delete-output-path

- --delete-output-path + --delete-output-path

Delete the output path before building. @@ -357,7 +357,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

preserve-symlinks

- --preserve-symlinks + --preserve-symlinks

Do not use the real path when resolving modules. @@ -366,7 +366,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

extract-licenses

- --extract-licenses + --extract-licenses

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.

show-circular-dependencies

- --show-circular-dependencies + --show-circular-dependencies

Show circular dependency warnings on builds. @@ -384,7 +384,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

build-optimizer

- --build-optimizer + --build-optimizer

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.

named-chunks

- --named-chunks + --named-chunks

Use file name for lazy loaded chunks. @@ -402,7 +402,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

subresource-integrity

- --subresource-integrity + --subresource-integrity

Enables the use of subresource integrity validation. @@ -411,7 +411,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

service-worker

- --service-worker + --service-worker

Generates a service worker config for production builds. @@ -420,7 +420,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

ngsw-config-path

- --ngsw-config-path + --ngsw-config-path

Path to ngsw-config.json. @@ -429,7 +429,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

skip-app-shell

- --skip-app-shell + --skip-app-shell

Flag to prevent building an app shell. @@ -438,7 +438,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

index

- --index + --index

The name of the index HTML file. @@ -447,7 +447,7 @@ See https://github.com/angular/angular-cli/issues/7797 for details.

stats-json

- --stats-json + --stats-json

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.

fork-type-checker

- --fork-type-checker + --fork-type-checker

Run the TypeScript type checker in a forked process. diff --git a/docs/documentation/e2e.md b/docs/documentation/e2e.md index 55478fc59b..7d5db10e83 100644 --- a/docs/documentation/e2e.md +++ b/docs/documentation/e2e.md @@ -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/)

prod

- --prod + --prod

Flag to set configuration to "prod". @@ -26,7 +26,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

configuration

- --configuration (alias: -c) + --configuration (alias: -c)

Specify the configuration to use. @@ -35,7 +35,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

protractor-config

- --protractor-config + --protractor-config

The name of the Protractor configuration file. @@ -44,7 +44,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

dev-server-target

- --dev-server-target + --dev-server-target

Dev server target to run tests against. @@ -53,7 +53,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

suite

- --suite + --suite

Override suite in the protractor config. @@ -62,7 +62,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

element-explorer

- --element-explorer + --element-explorer

Start Protractor's Element Explorer for debugging. @@ -71,7 +71,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

webdriver-update

- --webdriver-update + --webdriver-update

Try to update webdriver. @@ -80,7 +80,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

serve

- --serve + --serve

Compile and Serve the app. @@ -89,7 +89,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

port

- --port + --port

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/)

host

- --host + --host

Host to listen on. @@ -107,7 +107,7 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)

base-url

- --base-url + --base-url

Base URL for protractor to connect to. diff --git a/docs/documentation/serve.md b/docs/documentation/serve.md index ad7574a106..a8ca7f94ec 100644 --- a/docs/documentation/serve.md +++ b/docs/documentation/serve.md @@ -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

prod

- --prod + --prod

Flag to set configuration to "prod". @@ -20,7 +18,7 @@ All the build Options are available in serve, below are the additional options.

configuration

- --configuration (alias: -c) + --configuration (alias: -c)

Specify the configuration to use. @@ -29,7 +27,7 @@ All the build Options are available in serve, below are the additional options.

browser-target

- --browser-target + --browser-target

Target to serve. @@ -38,7 +36,7 @@ All the build Options are available in serve, below are the additional options.

port

- --port + --port

Port to listen on. @@ -47,7 +45,7 @@ All the build Options are available in serve, below are the additional options.

host

- --host + --host

Host to listen on. @@ -56,7 +54,7 @@ All the build Options are available in serve, below are the additional options.

proxy-config

- --proxy-config + --proxy-config

Proxy configuration file. @@ -65,7 +63,7 @@ All the build Options are available in serve, below are the additional options.

ssl

- --ssl + --ssl

Serve using HTTPS. @@ -74,7 +72,7 @@ All the build Options are available in serve, below are the additional options.

ssl-key

- --ssl-key + --ssl-key

SSL key to use for serving HTTPS. @@ -83,7 +81,7 @@ All the build Options are available in serve, below are the additional options.

ssl-cert

- --ssl-cert + --ssl-cert

SSL certificate to use for serving HTTPS. @@ -92,7 +90,7 @@ All the build Options are available in serve, below are the additional options.

open

- --open (alias: -o) + --open (alias: -o)

Opens the url in default browser. @@ -101,7 +99,7 @@ All the build Options are available in serve, below are the additional options.

live-reload

- --live-reload + --live-reload

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.

public-host

- --public-host + --public-host

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.

serve-path

- --serve-path + --serve-path

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.

disable-host-check

- --disable-host-check + --disable-host-check

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.

hmr

- --hmr + --hmr

Enable hot module replacement. @@ -146,7 +144,7 @@ All the build Options are available in serve, below are the additional options.

watch

- --watch + --watch

Rebuild on change. @@ -155,7 +153,7 @@ All the build Options are available in serve, below are the additional options.

hmr-warning

- --hmr-warning + --hmr-warning

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.

serve-path-default-warning

- --serve-path-default-warning + --serve-path-default-warning

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.

optimization

- --optimization + --optimization

Defines the optimization level of the build. @@ -182,7 +180,7 @@ All the build Options are available in serve, below are the additional options.

aot

- --aot + --aot

Build using Ahead of Time compilation. @@ -191,7 +189,7 @@ All the build Options are available in serve, below are the additional options.

source-map

- --source-map + --source-map

Output sourcemaps. @@ -200,7 +198,7 @@ All the build Options are available in serve, below are the additional options.

eval-source-map

- --eval-source-map + --eval-source-map

Output in-file eval sourcemaps. @@ -209,7 +207,7 @@ All the build Options are available in serve, below are the additional options.

vendor-chunk

- --vendor-chunk + --vendor-chunk

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.

common-chunk

- --common-chunk + --common-chunk

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.

base-href

- --base-href + --base-href

Base url for the application being built. @@ -236,7 +234,7 @@ All the build Options are available in serve, below are the additional options.

deploy-url

- --deploy-url + --deploy-url

URL where files will be deployed. @@ -245,7 +243,7 @@ All the build Options are available in serve, below are the additional options.

verbose

- --verbose + --verbose

Adds more details to output logging. @@ -254,7 +252,7 @@ All the build Options are available in serve, below are the additional options.

progress

- --progress + --progress

Log progress to the console while building. diff --git a/docs/documentation/test.md b/docs/documentation/test.md index ab2d56f9d1..ea5c128225 100644 --- a/docs/documentation/test.md +++ b/docs/documentation/test.md @@ -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

prod

- --prod + --prod

Flag to set configuration to "prod". @@ -28,7 +28,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

configuration

- --configuration (alias: -c) + --configuration (alias: -c)

Specify the configuration to use. @@ -37,7 +37,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

main

- --main + --main

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

ts-config

- --ts-config + --ts-config

The name of the TypeScript configuration file. @@ -55,7 +55,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

karma-config

- --karma-config + --karma-config

The name of the Karma configuration file. @@ -64,7 +64,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

polyfills

- --polyfills + --polyfills

The name of the polyfills file. @@ -73,7 +73,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

environment

- --environment + --environment

Defines the build environment. @@ -82,7 +82,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

source-map

- --source-map + --source-map

Output sourcemaps. @@ -91,7 +91,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

progress

- --progress + --progress

Log progress to the console while building. @@ -100,7 +100,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

watch

- --watch + --watch

Run build when files change. @@ -109,7 +109,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

poll

- --poll + --poll

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

preserve-symlinks

- --preserve-symlinks + --preserve-symlinks

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

browsers

- --browsers + --browsers

Override which browsers tests are run against. @@ -136,7 +136,7 @@ You can run tests with coverage via `--code-coverage`. The coverage report will

code-coverage

- --code-coverage + --code-coverage

Output a code coverage report.