Skip to content

Commit 1404a1b

Browse files
committed
Merge branch 'master' into refactor-platform-server
2 parents a26ac98 + 5e54a01 commit 1404a1b

File tree

33 files changed

+213
-140
lines changed

33 files changed

+213
-140
lines changed

docs/documentation/build.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -65,36 +65,46 @@ All builds make use of bundling, and using the `--prod` flag in `ng build --pro
6565
or `ng serve --prod` will also make use of uglifying and tree-shaking functionality.
6666

6767
## Options
68-
`--watch` (`-w`) rebuild when files change
68+
`--aot` Build using Ahead of Time compilation.
6969

70-
`--target` (`-t`) define the build target
70+
`--app` Specifies app name or index to use.
7171

72-
`--environment` (`-e`) defines the build environment
72+
`--base-href` (`-bh`) Base url for the application being built.
7373

74-
`--prod` flag to set build target and environment to production
74+
`--deploy-url` (`-d`) URL where files will be deployed.
7575

76-
`--dev` flag to set build target and environment to development
76+
`--dev` Build target and environment to development.
7777

7878
`--output-path` (`-op`) path where output will be placed
7979

80-
`--aot` flag whether to build using Ahead of Time compilation
80+
`--environment` (`-e`) Defines the build environment.
8181

82-
`--sourcemap` (`-sm`) output sourcemaps
82+
`--extract-css` (`-ec`) Extract css from global styles onto css files instead of js ones.
8383

84-
`--vendor-chunk` (`-vb`) use a separate bundle containing only vendor libraries
84+
`--i18n-file` Localization file to use for i18n.
8585

86-
`--base-href` (`-bh`) base url for the application being built
86+
`--i18n-format` Format of the localization file specified with --i18n-file.
8787

88-
`--deploy-url` (`-d`) url where files will be deployed
88+
`--locale` Locale to use for i18n.
8989

90-
`--verbose` (`-v`) adds more details to output logging
90+
`--output-hashing` Define the output filename cache-busting hashing mode.
9191

92-
`--progress` (`-pr`) log progress to the console while building
92+
`--output-path` (`-op`) Path where output will be placed.
9393

94-
`--extract-css` (`-ec`) extract css from global styles onto css files instead of js ones
94+
`--poll` Enable and define the file watching poll time period (milliseconds).
9595

96-
`--output-hashing` define the output filename cache-busting hashing mode
96+
`--prod` Build target and environment to production.
9797

98-
`--stats-json` generates a `stats.json` file which can be analyzed using tools such as: `webpack-bundle-analyzer` or https://webpack.github.io/analyse
98+
`--progress` (`-pr`) Log progress to the console while building.
9999

100-
`--poll` enable and define the file watching poll time period (milliseconds)
100+
`--sourcemap` (`-sm`) Output sourcemaps.
101+
102+
`--stats-json` Generates a `stats.json` file which can be analyzed using tools such as: `webpack-bundle-analyzer` or https://webpack.github.io/analyse.
103+
104+
`--target` (`-t`) Defines the build target.
105+
106+
`--vendor-chunk` (`-vb`) Use a separate bundle containing only vendor libraries.
107+
108+
`--verbose` (`-v`) Adds more details to output logging.
109+
110+
`--watch` (`-w`) Run build when files change.

docs/documentation/config.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
11
<!-- Links in /docs/documentation should NOT have `.md` at the end, because they end up in our wiki at release. -->
22

3-
`ng get`
4-
`ng set`
3+
# ng get
4+
5+
## Overview
6+
`ng get [key]` Get a value from the configuration.
7+
8+
## Options
9+
`--global` Get the value in the global configuration (in your home directory).
10+
11+
12+
# ng set
13+
14+
## Overview
15+
`ng set [key]=[value]` Set a value in the configuration.
16+
17+
## Options
18+
`--global` Set the value in the global configuration rather than in your project's.

docs/documentation/doc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
# ng doc
44

55
## Overview
6-
`ng doc [search term]` searches documentation on [angular.io](https://angular.io)
6+
`ng doc [search term]` Opens the official Angular documentation for a given keyword on [angular.io](https://angular.io).

docs/documentation/e2e.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,10 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
1616
## Options
1717
`--config` (`-c`) use a specific config file. Defaults to the protractor config file in `.angular-cli.json`.
1818

19-
`--specs` (`-sp`) override specs in the protractor config.
20-
Can send in multiple specs by repeating flag (`ng e2e --specs=spec1.ts --specs=spec2.ts`).
19+
`--element-explorer` (`-ee`) Start Protractor's [Element Explorer](https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively) for debugging.
2120

22-
`--element-explorer` (`-ee`) start Protractor's
23-
[Element Explorer](https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively)
24-
for debugging.
21+
`--serve` Compile and Serve the app. All serve options are also available. The live-reload option defaults to false, and the default port will be random.
2522

26-
`--webdriver-update` (`-wu`) try to update webdriver.
23+
`--specs` Override specs in the protractor config. Can send in multiple specs by repeating flag (ng e2e --specs=spec1.ts --specs=spec2.ts).
2724

28-
`--serve` (`-s`) compile and serve the app.
29-
All non-reload related serve options are also available (e.g. `--port=4400`).
25+
`--webdriver-update` (`-wu`) (Default: true) Try to update webdriver.

docs/documentation/generate/class.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@
66
`ng generate class [name]` generates a class
77

88
## Options
9-
`--spec` specifies if a spec file is generated
9+
`--app` Specifies app name or index to use.
10+
11+
`--spec` Specifies if a spec file is generated.

docs/documentation/generate/component.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,24 @@
66
`ng generate component [name]` generates a component
77

88
## Options
9-
`--flat` flag to indicate if a dir is created
9+
`--app` Specifies app name or index to use.
1010

11-
`--inline-template` (`-it`) specifies if the template will be in the ts file
11+
`--change-detection` (`-cd`) Specifies the change detection strategy.
1212

13-
`--inline-style` (`-is`) specifies if the style will be in the ts file
13+
`--flat` Flag to indicate if a dir is created.
1414

15-
`--prefix` specifies whether to use the prefix
15+
`--export` Specifies if declaring module exports the component.
1616

17-
`--spec` specifies if a spec file is generated
17+
`--inline-style` (`-is`) Specifies if the style will be in the ts file.
1818

19-
`--view-encapsulation` (`-ve`) specifies the view encapsulation strategy
19+
`--inline-template` (`-it`) Specifies if the template will be in the ts file.
2020

21-
`--change-detection` (`-cd`) specifies the change detection strategy
21+
`--module` (`-m`) Allows specification of the declaring module.
2222

23-
`--skip-import` allows for skipping the module import
23+
`--prefix` Specifies whether to use the prefix.
2424

25-
`--module` (`-m`) allows specification of the declaring module
25+
`--skip-import` Allows for skipping the module import.
2626

27-
`--export` specifies if declaring module exports the component
27+
`--spec` Specifies if a spec file is generated.
28+
29+
`--view-encapsulation` (`-ve`) Specifies the view encapsulation strategy.

docs/documentation/generate/directive.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66
`ng generate directive [name]` generates a directive
77

88
## Options
9-
`--flat` flag to indicate if a dir is created
9+
`--app` Specifies app name or index to use.
1010

11-
`--prefix` specifies whether to use the prefix
11+
`--export` Specifies if declaring module exports the component.
1212

13-
`--spec` specifies if a spec file is generated
13+
`--flat` Flag to indicate if a dir is created.
1414

15-
`--skip-import` allows for skipping the module import
15+
`--module` (`-m`) Allows specification of the declaring module.
1616

17-
`--module` (`-m`) allows specification of the declaring module
17+
`--prefix` Specifies whether to use the prefix.
1818

19-
`--export` specifies if declaring module exports the directive
19+
`--skip-import` Allows for skipping the module import.
20+
21+
`--spec` Specifies if a spec file is generated.

docs/documentation/generate/enum.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44

55
## Overview
66
`ng generate enum [name]` generates an enumeration
7+
8+
## Options
9+
`--app` Specifies app name or index to use.

docs/documentation/generate/guard.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
`ng generate guard [name]` generates a guard
55

66
## Options
7-
`--flat` flag to indicate if a dir is created
7+
`--app` Specifies app name or index to use.
88

9-
`--spec` specifies if a spec file is generated
9+
`--flat` Indicate if a dir is created.
1010

11-
`--module` (`-m`) allows specification of the declaring module
11+
`--module` (`-m`) Allows specification of the declaring module.
12+
13+
`--spec` Specifies if a spec file is generated.

docs/documentation/generate/interface.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
## Overview
66
`ng generate interface [name] <type>` generates an interface
77

8-
## Arguments
8+
## Options
9+
`--app` Specifies app name or index to use.
910

10-
`type` optional string to specify the type of interface
11+
`type` Pptional String to specify the type of interface.

0 commit comments

Comments
 (0)