|
| 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`): URL where files will be deployed. |
| 18 | + - *index* (`string`): The name of the start HTML file. Default is `index.html` |
| 19 | + - *main* (`string`): The name of the main entry-point file. |
| 20 | + - *polyfills* (`string`): The name of the polyfills entry-point file. Loaded before the app. |
| 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 | + - *showCircularDependencies* (`boolean`): Show circular dependency warnings on builds. Default is `true`. |
| 27 | + - *styles* (`string|array`): Global styles to be included in the build. |
| 28 | + - *stylePreprocessorOptions* : Options to pass to style preprocessors. |
| 29 | + - *includePaths* (`array`): Paths to include. Paths will be resolved to project root. |
| 30 | + - *scripts* (`array`): Global scripts to be included in the build. |
| 31 | + - *environmentSource* (`string`): Source file for environment config. |
| 32 | + - *environments* (`object`): Name and corresponding file for environment config. |
| 33 | + |
| 34 | +- **e2e**: Configuration for end-to-end tests. |
| 35 | + - *protractor* |
| 36 | + - *config* (`string`): Path to the config file. |
| 37 | + |
| 38 | +- **lint** (`array`): Properties to be passed to TSLint. |
| 39 | + - *files* (`string|array`): File glob(s) to lint. |
| 40 | + - *project* (`string`): Location of the tsconfig.json project file. Will also use as files to lint if 'files' property not present. |
| 41 | + - *tslintConfig* (`string`): Location of the tslint.json configuration. Default is `tslint.json`. |
| 42 | + - *exclude* (`string|array`): File glob(s) to ignore. |
| 43 | + |
| 44 | + |
| 45 | +- **test**: Configuration for unit tests. |
| 46 | + - *karma* |
| 47 | + - *config* (`string`): Path to the karma config file. |
| 48 | + - *codeCoverage* |
| 49 | + - *exclude* (`array`): Globs to exclude from code coverage. |
| 50 | + |
| 51 | +- **defaults**: Specify the default values for generating. |
| 52 | + - *styleExt* (`string`): The file extension to be used for style files. |
| 53 | + - *poll* (`number`): How often to check for file updates. |
| 54 | + - *class*: Options for generating a class. |
| 55 | + - *spec* (`boolean`): Specifies if a spec file is generated. Default is `false`. |
| 56 | + - *component*: Options for generating a component. |
| 57 | + - *flat* (`boolean`): Flag to indicate if a dir is created. Default is `false`. |
| 58 | + - *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`. |
| 59 | + - *inlineStyle* (`boolean`): Specifies if the style will be in the ts file. Default is `false`. |
| 60 | + - *inlineTemplate* (`boolean`): Specifies if the template will be in the ts file. Default is `false`. |
| 61 | + - *viewEncapsulation* (`string`): Specifies the view encapsulation strategy. Can be one of `Emulated`, `Native` or `None`. |
| 62 | + - *changeDetection* (`string`): Specifies the change detection strategy. Can be one of `Default` or `OnPush`. |
| 63 | + - *directive*: Options for generating a directive. |
| 64 | + - *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`. |
| 65 | + - *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`. |
| 66 | + - *guard*: Options for generating a guard. |
| 67 | + - *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`. |
| 68 | + - *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`. |
| 69 | + - *interface*: Options for generating a interface. |
| 70 | + - *prefix* (`string`): Prefix to apply to interface names. (i.e. I) |
| 71 | + - *module*: Options for generating a module. |
| 72 | + - *flat* (`boolean`): Flag to indicate if a dir is created. Default is `false`. |
| 73 | + - *spec* (`boolean`): Specifies if a spec file is generated. Default is `false`. |
| 74 | + - *pipe*: Options for generating a pipe. |
| 75 | + - *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`. |
| 76 | + - *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`. |
| 77 | + - *service*: Options for generating a service. |
| 78 | + - *flat* (`boolean`): Flag to indicate if a dir is created. Default is `true`. |
| 79 | + - *spec* (`boolean`): Specifies if a spec file is generated. Default is `true`. |
| 80 | + - *build*: Properties to be passed to the build command. |
| 81 | + - *sourcemaps* (`boolean`): Output sourcemaps. |
| 82 | + - *baseHref* (`string`): Base url for the application being built. |
| 83 | + - *progress* (`boolean`): Log progress to the console while building. Default is `true`. |
| 84 | + - *poll* (`number`): Enable and define the file watching poll time period (milliseconds). |
| 85 | + - *deleteOutputPath* (`boolean`): Delete output path before build. Default is `true`. |
| 86 | + - *preserveSymlinks* (`boolean`): Do not use the real path when resolving modules. Default is `false`. |
| 87 | + - *showCircularDependencies* (`boolean`): Show circular dependency warnings on builds. Default is `true`. |
| 88 | + - *namedChunks* (`boolean`): Use file name for lazy loaded chunks. |
| 89 | + - *serve*: Properties to be passed to the serve command |
| 90 | + - *port* (`number`): The port the application will be served on. Default is `4200`. |
| 91 | + - *host* (`string`): The host the application will be served on. Default is `localhost`. |
| 92 | + - *ssl* (`boolean`): Enables ssl for the application. Default is `false`. |
| 93 | + - *sslKey* (`string`): The ssl key used by the server. Default is `ssl/server.key`. |
| 94 | + - *sslCert* (`string`): The ssl certificate used by the server. Default is `ssl/server.crt`. |
| 95 | + - *proxyConfig* (`string`): Proxy configuration file. |
| 96 | + |
| 97 | +- **packageManager** (`string`): Specify which package manager tool to use. Options include `npm`, `cnpm` and `yarn`. |
| 98 | + |
| 99 | +- **warnings**: Allow people to disable console warnings. |
| 100 | + - *nodeDeprecation* (`boolean`): Show a warning when the node version is incompatible. Default is `true`. |
| 101 | + - *packageDeprecation* (`boolean`): Show a warning when the user installed angular-cli. Default is `true`. |
| 102 | + - *versionMismatch* (`boolean`): Show a warning when the global version is newer than the local one. Default is `true`. |
0 commit comments