Skip to content

Commit aa1544c

Browse files
clydinclydin
committed
docs: update wiki command options
1 parent b2acaa2 commit aa1544c

File tree

16 files changed

+116
-1159
lines changed

16 files changed

+116
-1159
lines changed

‎docs/documentation/add.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- Links in /docs/documentation should NOT have \`.md\` at the end, because they end up in our wiki at release. -->
2+
3+
# ng add
4+
5+
## Overview
6+
Add support for a library to your project.
7+
8+
## Options
9+
None.

‎docs/documentation/build.md

Lines changed: 6 additions & 264 deletions
Original file line numberDiff line numberDiff line change
@@ -130,278 +130,20 @@ See https://github.com/angular/angular-cli/issues/7797 for details.
130130

131131
## Options
132132
<details>
133-
<summary>aot</summary>
133+
<summary>prod</summary>
134134
<p>
135-
<code>--aot</code> <em>default value: false</em>
135+
<code>--prod</code>
136136
</p>
137137
<p>
138-
Build using Ahead of Time compilation.
138+
Flag to set configuration to "prod".
139139
</p>
140140
</details>
141-
142-
<details>
143-
<summary>app</summary>
144-
<p>
145-
<code>--app</code> (aliases: <code>-a</code>)
146-
</p>
147-
<p>
148-
Specifies app name or index to use.
149-
</p>
150-
</details>
151-
152-
<details>
153-
<summary>base-href</summary>
154-
<p>
155-
<code>--base-href</code> (aliases: <code>-bh</code>)
156-
</p>
157-
<p>
158-
Base url for the application being built.
159-
</p>
160-
</details>
161-
162-
<details>
163-
<summary>deploy-url</summary>
164-
<p>
165-
<code>--deploy-url</code> (aliases: <code>-d</code>)
166-
</p>
167-
<p>
168-
URL where files will be deployed.
169-
</p>
170-
</details>
171-
172-
<details>
173-
<summary>environment</summary>
174-
<p>
175-
<code>--environment</code> (aliases: <code>-e</code>)
176-
</p>
177-
<p>
178-
Defines the build environment.
179-
</p>
180-
</details>
181-
182-
<details>
183-
<summary>extract-css</summary>
184-
<p>
185-
<code>--extract-css</code> (aliases: <code>-ec</code>)
186-
</p>
187-
<p>
188-
Extract css from global styles onto css files instead of js ones.
189-
</p>
190-
</details>
191-
192-
<details>
193-
<summary>i18n-file</summary>
194-
<p>
195-
<code>--i18n-file</code>
196-
</p>
197-
<p>
198-
Localization file to use for i18n.
199-
</p>
200-
</details>
201-
202-
<details>
203-
<summary>i18n-format</summary>
204-
<p>
205-
<code>--i18n-format</code>
206-
</p>
207-
<p>
208-
Format of the localization file specified with --i18n-file.
209-
</p>
210-
</details>
211-
212-
<details>
213-
<summary>locale</summary>
214-
<p>
215-
<code>--locale</code>
216-
</p>
217-
<p>
218-
Locale to use for i18n.
219-
</p>
220-
</details>
221-
222-
<details>
223-
<summary>missing-translation</summary>
224-
<p>
225-
<code>--missing-translation</code>
226-
</p>
227-
<p>
228-
How to handle missing translations for i18n.
229-
</p>
230-
<p>
231-
Values: <code>error</code>, <code>warning</code>, <code>ignore</code>
232-
</p>
233-
</details>
234-
235-
<details>
236-
<summary>output-hashing</summary>
237-
<p>
238-
<code>--output-hashing</code> (aliases: <code>-oh</code>)
239-
</p>
240-
<p>
241-
Define the output filename cache-busting hashing mode.
242-
</p>
243-
<p>
244-
Values: <code>none</code>, <code>all</code>, <code>media</code>, <code>bundles</code>
245-
</p>
246-
</details>
247-
248-
<details>
249-
<summary>output-path</summary>
250-
<p>
251-
<code>--output-path</code> (aliases: <code>-op</code>)
252-
</p>
253-
<p>
254-
Path where output will be placed.
255-
</p>
256-
</details>
257-
258-
<details>
259-
<summary>delete-output-path</summary>
260-
<p>
261-
<code>--delete-output-path</code> (aliases: <code>-dop</code>) <em>default value: true</<em>
262-
</p>
263-
<p>
264-
Delete the output-path directory.
265-
</p>
266-
</details>
267-
268-
<details>
269-
<summary>poll</summary>
270-
<p>
271-
<code>--poll</code>
272-
</p>
273-
<p>
274-
Enable and define the file watching poll time period (milliseconds).
275-
</p>
276-
</details>
277-
278-
<details>
279-
<summary>progress</summary>
280-
<p>
281-
<code>--progress</code> (aliases: <code>-pr</code>) <em>default value: true inside TTY, false otherwise</<em>
282-
</p>
283-
<p>
284-
Log progress to the console while building.
285-
</p>
286-
</details>
287-
288-
<details>
289-
<summary>sourcemap</summary>
290-
<p>
291-
<code>--sourcemap</code> (aliases: <code>-sm</code>, <code>sourcemaps</code>)
292-
</p>
293-
<p>
294-
Output sourcemaps.
295-
</p>
296-
</details>
297-
298-
<details>
299-
<summary>stats-json</summary>
300-
<p>
301-
<code>--stats-json</code>
302-
</p>
303-
<p>
304-
Generates a <code>stats.json</code> file which can be analyzed using tools such as: <code>webpack-bundle-analyzer</code> or https://webpack.github.io/analyse.
305-
</p>
306-
</details>
307-
308-
<details>
309-
<summary>target</summary>
310-
<p>
311-
<code>--target</code> (aliases: <code>-t</code>, <code>-dev</code>, <code>-prod</code>) <em>default value: development</em>
312-
</p>
313-
<p>
314-
Defines the build target.
315-
</p>
316-
</details>
317-
318-
<details>
319-
<summary>vendor-chunk</summary>
320-
<p>
321-
<code>--vendor-chunk</code> (aliases: <code>-vc</code>) <em>default value: true</em>
322-
</p>
323-
<p>
324-
Use a separate bundle containing only vendor libraries.
325-
</p>
326-
</details>
327-
328-
<details>
329-
<summary>common-chunk</summary>
330-
<p>
331-
<code>--common-chunk</code> (aliases: <code>-cc</code>) <em>default value: true</em>
332-
</p>
333-
<p>
334-
Use a separate bundle containing code used across multiple bundles.
335-
</p>
336-
</details>
337-
338-
<details>
339-
<summary>verbose</summary>
340-
<p>
341-
<code>--verbose</code> (aliases: <code>-v</code>) <em>default value: false</em>
342-
</p>
343-
<p>
344-
Adds more details to output logging.
345-
</p>
346-
</details>
347-
348-
<details>
349-
<summary>watch</summary>
350-
<p>
351-
<code>--watch</code> (aliases: <code>-w</code>)
352-
</p>
353-
<p>
354-
Run build when files change.
355-
</p>
356-
</details>
357-
358-
<details>
359-
<summary>show-circular-dependencies</summary>
360-
<p>
361-
<code>--show-circular-dependencies</code> (aliases: <code>-scd</code>)
362-
</p>
363-
<p>
364-
Show circular dependency warnings on builds.
365-
</p>
366-
</details>
367-
368-
<details>
369-
<summary>build-optimizer</summary>
370-
<p>
371-
<code>--build-optimizer</code>
372-
</p>
373-
<p>
374-
Enables @angular-devkit/build-optimizer optimizations when using `--aot`.
375-
</p>
376-
</details>
377-
378-
<details>
379-
<summary>named-chunks</summary>
380-
<p>
381-
<code>--named-chunks</code> (aliases: <code>-nc</code>)
382-
</p>
383-
<p>
384-
Use file name for lazy loaded chunks.
385-
</p>
386-
</details>
387-
388-
<details>
389-
<summary>bundle-dependencies</summary>
390-
<p>
391-
<code>--bundle-dependencies</code>
392-
</p>
393-
<p>
394-
In a server build, state whether `all` or `none` dependencies should be bundles in the output.
395-
</p>
396-
</details>
397-
398-
399141
<details>
400-
<summary>extract-licenses</summary>
142+
<summary>configuration</summary>
401143
<p>
402-
<code>--extract-licenses</code> <em>default value: true</<em>
144+
<code>--configuration</code> (aliases: <code>-c</code>)
403145
</p>
404146
<p>
405-
Extract all licenses in a separate file, in the case of production builds only.
147+
Specify the configuration to use.
406148
</p>
407149
</details>

‎docs/documentation/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If both the `[key]` and `[value]` are provided it will set the value.
1212
<details>
1313
<summary>global</summary>
1414
<p>
15-
<code>--global</code> <em>default value: false</em>
15+
<code>--global</code> (aliases: <code>-g</code>)
1616
</p>
1717
<p>
1818
Get/set the value in the global configuration (in your home directory).

‎docs/documentation/doc.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@
66
`ng doc [search term]` Opens the official Angular API documentation for a given keyword on [angular.io](https://angular.io).
77

88
## Options
9-
109
<details>
1110
<summary>search</summary>
1211
<p>
13-
<code>--search</code> (alias: <code>-s</code>) <em>default value: false</em>
12+
<code>--search</code> (aliases: <code>-s</code>)
1413
</p>
1514
<p>
16-
Search for the keyword in the whole [angular.io](https://angular.io) documentation instead of just the API.
15+
Search whole angular.io instead of just api.
1716
</p>
1817
</details>

‎docs/documentation/e2e.md

Lines changed: 6 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -14,68 +14,21 @@ ng e2e
1414
End-to-end tests are run via [Protractor](https://angular.github.io/protractor/).
1515

1616
## Options
17-
18-
Please note that options that are supported by `ng serve` are also supported by `ng e2e`
19-
20-
<details>
21-
<summary>config</summary>
22-
<p>
23-
<code>--config</code> (aliases: <code>-c</code>)
24-
</p>
25-
<p>
26-
Use a specific config file. Defaults to the protractor config file in <code>.angular-cli.json</code>.
27-
</p>
28-
</details>
29-
3017
<details>
31-
<summary>element-explorer</summary>
18+
<summary>prod</summary>
3219
<p>
33-
<code>--element-explorer</code> (aliases: <code>-ee</code>) <em>default value: false</em>
20+
<code>--prod</code>
3421
</p>
3522
<p>
36-
Start Protractor's <a href="https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively">Element Explorer</a> for debugging.
23+
Flag to set configuration to "prod".
3724
</p>
3825
</details>
39-
40-
<details>
41-
<summary>serve</summary>
42-
<p>
43-
<code>--serve</code> (aliases: <code>-s</code>) <em>default value: true</em>
44-
</p>
45-
<p>
46-
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.
47-
</p>
48-
<p>
49-
NOTE: Build failure will not launch the e2e task. You must first fix error(s) and run e2e again.
50-
</p>
51-
</details>
52-
53-
<details>
54-
<summary>specs</summary>
55-
<p>
56-
<code>--specs</code> (aliases: <code>-sp</code>) <em>default value: []</em>
57-
</p>
58-
<p>
59-
Override specs in the protractor config. Can send in multiple specs by repeating flag (<code>ng e2e --specs=spec1.ts --specs=spec2.ts</code>).
60-
</p>
61-
</details>
62-
63-
<details>
64-
<summary>suite</summary>
65-
<p>
66-
<code>--suite</code> (aliases: <code>-su</code>)
67-
</p>
68-
<p>
69-
Override suite in the protractor config. Can send in multiple suite by comma separated values (<code>ng e2e --suite=suiteA,suiteB</code>).
70-
</p>
71-
</details>
72-
7326
<details>
74-
<summary>webdriver-update</summary>
27+
<summary>configuration</summary>
7528
<p>
76-
<code>--webdriver-update</code> (aliases: <code>-wu</code>) <em>default value: true</em>
29+
<code>--configuration</code> (aliases: <code>-c</code>)
7730
</p>
7831
<p>
79-
Try to update webdriver.
32+
Specify the configuration to use.
8033
</p>
8134
</details>

0 commit comments

Comments
 (0)