Skip to content

Commit 446dc65

Browse files
sumitarorahansl
authored andcommitted
fix(@angular/cli): adding documentation for schema doc
1 parent 2e309cb commit 446dc65

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

docs/documentation/angular-cli.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<!-- Links in /docs/documentation should NOT have `.md` at the end, because they end up in our wiki at release. -->
2+
3+
# Angular CLI Config Schema
4+
5+
## Options
6+
7+
- **project**: The global configuration of the project.
8+
- *name* (`string`): The name of the project.
9+
- *ejected*(`boolean`): Whether or not this project was ejected. Default is `false`.
10+
11+
12+
- **apps** (`array`): Properties of the different applications in this project.
13+
- *name* (`string`): Name of the app.
14+
- *root* (`string`): The root directory of the app.
15+
- *outDir* (`string`): The output directory for build results. Default is `dist/`.
16+
- *assets* (`array`): List of application assets.
17+
- *deployUrl* (`string`): ...
18+
- *index* (`string`): The name of the start HTML file. Default is `index.hrml`
19+
- *main* (`string`): The name of the main entry-point file.
20+
- *polyfills* (`string`): The name of the main entry-point file.
21+
- *test* (`string`): The name of the test entry-point file.
22+
- *tsconfig* (`string`): The name of the TypeScript configuration file. Default is `tsconfig.app.json`.
23+
- *testTsconfig* (`string`): The name of the TypeScript configuration file for unit tests.
24+
- *prefix* (`string`): The prefix to apply to generated selectors.
25+
- *serviceWorker* (`boolean`): Experimental support for a service worker from @angular/service-worker. Default is `false`.
26+
- *styles* (`string|array`): Global styles to be included in the build.
27+
- *stylePreprocessorOptions* : Options to pass to style preprocessors.
28+
- *includePaths* (`array`): Paths to include. Paths will be resolved to project root.
29+
- *scripts* (`array`): Global scripts to be included in the build.
30+
- *environmentSource* (`string`): Source file for environment config.
31+
- *environments* (`object`): Name and corresponding file for environment config.
32+
33+
- **e2e**: Confirguration for end-to-end tests.
34+
- *protractor*
35+
- *config* (`string`): Path to the config file.
36+
37+
- **lint** (`array`): Properties to be passed to TSLint.
38+
- *files* (`string|array`): File glob(s) to lint.
39+
- *project* (`string`): Location of the tsconfig.json project file. Will also use as files to lint if 'files' property not present.
40+
- *tslintConfig* (`string`): Location of the tslint.json configuration. Default is `tslint.json`.
41+
- *exclude* (`string|array`): File glob(s) to ignore.
42+
43+
44+
- **test**: Configuration for unit tests.
45+
- *karma*
46+
- *config* (`string`): Path to the karma config file.
47+
- *codeCoverage*
48+
- *exclude* (`array`): Globs to exclude from code coverage.
49+
50+
- **defaults**: Specify the default values for generating.
51+
- *styleExt* (`string`): The file extension to be used for style files.
52+
- *poll* (`number`): How often to check for file updates.
53+
- *class*: Options for generating a class.
54+
- *spec* (`boolean`): Specifies if a spec file is generated. Default is `false`.
55+
- *component*: Options for generating a component.
56+
- *flat* (`boolean`): Flag to indicate if a dir is created. Default is `false`.
57+
- *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`.
58+
- *inlineStyle* (`boolean`): Specifies if the style will be in the ts file. Default is `false`.
59+
- *inlineTemplate* (`boolean`): Specifies if the template will be in the ts file. Default is `false`.
60+
- *viewEncapsulation* (`string`): Specifies the view encapsulation strategy. Can be one of `Emulated`, `Native` or `None`.
61+
- *changeDetection* (`string`): Specifies the change detection strategy. Can be one of `Default` or `OnPush`.
62+
- *directive*: Options for generating a directive.
63+
- *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`.
64+
- *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`.
65+
- *guard*: Options for generating a guard.
66+
- *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`.
67+
- *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`.
68+
- *interface*: Options for generating a interface.
69+
- *prefix* (`string`): Prefix to apply to interface names. (i.e. I)
70+
- *module*: Options for generating a module.
71+
- *flat* (`boolean`): Flag to indicate if a dir is created. Default is `false`.
72+
- *spec* (`boolean`): Specifies if a spec file is generated. Default is `false`.
73+
- *pipe*: Options for generating a pipe.
74+
- *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`.
75+
- *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`.
76+
- *service*: Options for generating a service.
77+
- *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`.
78+
- *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`.
79+
- *serve*: Properties to be passed to the serve command
80+
- *port* (`number`): The port the application will be served on. Default is `4200`.
81+
- *host* (`string`): The host the application will be served on. Default is `localhost`.
82+
- *ssl* (`boolean`): Enables ssl for the application. Default is `false`.
83+
- *sslKey* (`string`): The ssl key used by the server. Default is `ssl/server.key`.
84+
- *sslCert* (`string`): The ssl certificate used by the server. Default is `ssl/server.crt`.
85+
86+
- **packageManager** (`string`): Specify which package manager tool to use. Options include `npm`, `cnpm` and `yarn`.
87+
88+
- **warnings**: Allow people to disable console warnings.
89+
- *nodeDeprecation* (`boolean`): Show a warning when the node version is incompatible. Default is `true`.
90+
- *packageDeprecation* (`boolean`): Show a warning when the user installed angular-cli. Default is `true`.
91+
- *versionMismatch* (`boolean`): Show a warning when the global version is newer than the local one. Default is `true`.

0 commit comments

Comments
 (0)