From 5880e8d5b193ab550df20d8a529fc674309334ad Mon Sep 17 00:00:00 2001 From: bogdancar Date: Thu, 11 Jan 2018 15:59:21 -0500 Subject: [PATCH] docs(@angular/cli): update docs for ng new Update the docs for ng new command: remove source-dir, add new collection, service-worker, view-encapsulation, add aliases, update descriptions on docs/new.md. --- docs/documentation/new.md | 70 +++++++++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 24 deletions(-) diff --git a/docs/documentation/new.md b/docs/documentation/new.md index 9400ce2ef5e2..f08bbaed1d42 100644 --- a/docs/documentation/new.md +++ b/docs/documentation/new.md @@ -8,6 +8,16 @@ Default applications are created in a directory of the same name, with an initialized Angular application. ## Options +
+ collection +

+ --collection (alias: -c) default value: @schematics/angular +

+

+ Schematics collection to use. +

+
+
directory

@@ -21,7 +31,7 @@ Default applications are created in a directory of the same name, with an initia

dry-run

- --dry-run (alias: -d) default value: false + --dry-run (aliases: -d -dryRun) default value: false

Run through without making any changes. Will list all files that would have been created when running ng new. @@ -34,7 +44,7 @@ Default applications are created in a directory of the same name, with an initia --inline-style (alias: -is) default value: false

- Should have an inline style. + Specifies if the style will be in the ts file.

@@ -44,7 +54,7 @@ Default applications are created in a directory of the same name, with an initia --inline-template (alias: -it) default value: false

- Should have an inline template. + Specifies if the template will be in the ts file.

@@ -54,7 +64,7 @@ Default applications are created in a directory of the same name, with an initia --minimal default value: false

- Should create a minimal app. + Create a minimal app (no test structure, inline styles/templates).

@@ -64,7 +74,7 @@ Default applications are created in a directory of the same name, with an initia --prefix (alias: -p) default value: app

- The prefix to use for all component selectors. + The prefix to apply to generated selectors.

You can later change the value in .angular-cli.json (apps[0].prefix). @@ -77,14 +87,24 @@ Default applications are created in a directory of the same name, with an initia --routing default value: false

- Generate a routing module. + Generates a routing module. +

+ + +
+ service-worker +

+ --service-worker default value: false +

+

+ Installs the @angular/service-worker.

skip-commit

- --skip-commit (alias: -sc) default value: false + --skip-commit (aliases: -sc -skipCommit) default value: false

Skip committing the first commit to git. @@ -104,7 +124,7 @@ Default applications are created in a directory of the same name, with an initia

skip-install

- --skip-install (alias: -si) default value: false + --skip-install (aliases: -si -skipInstall) default value: false

Skip installing packages. @@ -124,32 +144,19 @@ Default applications are created in a directory of the same name, with an initia

-
- source-dir -

- --source-dir (alias: -sd) default value: src -

-

- The name of the source directory. -

-

- You can later change the value in .angular-cli.json (apps[0].root). -

-
-
style

--style default value: css

- The style file default extension. Possible values: + The file extension to be used for style files. Possible values:
  • css
  • scss
  • less
  • sass
  • -
  • styl (stylus)
  • +
  • styl (stylus)

@@ -160,9 +167,24 @@ Default applications are created in a directory of the same name, with an initia

verbose

- --verbose (alias: -v) default value: false + --verbose (aliases: -v -verbose) default value: false

Adds more details to output logging.

+ +
+ view-encapsulation +

+ --view-encapsulation +

+
+ Specifies the view encapsulation strategy. Possible values: +
    +
  • Emulated
  • +
  • Native
  • +
  • None
  • +
+
+
\ No newline at end of file