5 lines
23 KiB
JSON
5 lines
23 KiB
JSON
{
|
|
"id": "cli/build",
|
|
"title": "ng build",
|
|
"contents": "\n<article>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/build.json?message=docs(...)%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/build.json\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n \n\n\n<div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io/cli\", \"name\": \"CLI\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/cli/build\", \"name\": \"build\" } }\n ]\n }\n </script>\n <a href=\"cli\">CLI</a>\n</div>\n\n \n<header class=\"cli-header\">\n <h1 id=\"ng-build\">ng build<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"cli/build#ng-build\"><i class=\"material-icons\">link</i></a></h1>\n</header>\n\n\n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"cli-body\">\n \n <p>Compiles an Angular app into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.</p>\n\n \n<code-example hidecopy=\"true\" class=\"no-box api-heading no-auto-link\">ng <span class=\"cli-name\">build</span> <<var>project</var>> [<var>options</var>]</code-example>\n\n<code-example hidecopy=\"true\" class=\"no-box api-heading no-auto-link\">ng <span class=\"cli-name\">b</span> <<var>project</var>> [<var>options</var>]</code-example>\n\n\n\n \n <h2 class=\"no-anchor\" id=\"mode_edit---code----------description\">\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/build-long.md?message=docs%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/build-long.md\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n Description\n </h2>\n <p>The command can be used to build a project of type \"application\" or \"library\".\nWhen used to build a library, a different builder is invoked, and only the <code>ts-config</code>, <code>configuration</code>, and <code>watch</code> options are applied.\nAll other options apply only to building applications.</p>\n<p>The application builder uses the <a href=\"https://webpack.js.org/\">webpack</a> build tool, with default configuration options specified in the workspace configuration file (<code>angular.json</code>) or with a named alternative configuration.\nA \"development\" configuration is created by default when you use the CLI to create the project, and you can use that configuration by specifying the <code>--configuration development</code>.</p>\n<p>The configuration options generally correspond to the command options.\nYou can override individual configuration defaults by specifying the corresponding options on the command line.\nThe command can accept option names given in either dash-case or camelCase.\nNote that in the configuration file, you must specify names in camelCase.</p>\n<p>Some additional options can only be set through the configuration file,\neither by direct editing or with the <code>ng config</code> command.\nThese include <code>assets</code>, <code>styles</code>, and <code>scripts</code> objects that provide runtime-global resources to include in the project.\nResources in CSS, such as images and fonts, are automatically written and fingerprinted at the root of the output folder.</p>\n<p>For further details, see <a href=\"guide/workspace-config\">Workspace Configuration</a>.</p>\n\n \n\n \n\n<h2 class=\"no-anchor\" id=\"arguments\">Arguments</h2>\n<table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th width=\"15%\">Argument</th>\n <th width=\"40%\">Description</th>\n <th>Value Type</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"cli-option\">\n <td><code class=\"cli-option-syntax no-auto-link\"><<var>project</var>></code></td>\n <td>\n <p>The name of the project to build. Can be an application or a library.</p>\n\n \n </td>\n <td><code class=\"cli-option-syntax no-auto-link\">string</code></td>\n </tr>\n \n </tbody>\n</table>\n\n\n \n\n<h2 class=\"no-anchor\" id=\"options\">Options</h2>\n<table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th width=\"15%\">Option</th>\n <th width=\"40%\">Description</th>\n <th>Value Type</th>\n <th>Default Value</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--allowed-common-js-dependencies</code>\n </td>\n <td>\n \n <p>A list of CommonJS packages that are allowed to be used without a build time warning.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">array</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--aot</code>\n </td>\n <td>\n \n <p>Build using Ahead of Time compilation.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--base-href</code>\n </td>\n <td>\n \n <p>Base url for the application being built.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--build-optimizer</code>\n </td>\n <td>\n \n <p>Enables '@angular-devkit/build-optimizer' optimizations when using the 'aot' option.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--common-chunk</code>\n </td>\n <td>\n \n <p>Generate a seperate bundle containing code used across multiple bundles.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--configuration</code>\n </td>\n <td>\n \n <p>One or more named builder configurations as a comma-separated list as specified in the \"configurations\" section of angular.json.\nThe builder uses the named configurations to run the given target.\nFor more information, see <a href=\"https://angular.io/guide/workspace-config#alternate-build-configurations\">https://angular.io/guide/workspace-config#alternate-build-configurations</a>.\nSetting this explicitly overrides the \"--prod\" flag.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -c</p>\n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--cross-origin</code>\n </td>\n <td>\n \n <p>Define the crossorigin attribute setting of elements that provide CORS support.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">none|anonymous|use-credentials</code></td>\n <td><code class=\"no-auto-link\">none</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--delete-output-path</code>\n </td>\n <td>\n \n <p>Delete the output path before building.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--deploy-url</code>\n </td>\n <td>\n \n <p>URL where files will be deployed.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--extract-css</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Deprecated since version 11.0. No longer required to disable CSS extraction for HMR.</p>\n\n \n \n <p>Extract CSS from global styles into '.css' files instead of '.js'.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--extract-licenses</code>\n </td>\n <td>\n \n <p>Extract all licenses in a separate file.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--fork-type-checker</code>\n </td>\n <td>\n \n <p>Run the TypeScript type checker in a forked process.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--help</code>\n </td>\n <td>\n \n <p>Shows a help message for this command in the console.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">true|false|json|JSON</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--i18n-file</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use 'locales' object in the project metadata instead.</p>\n\n \n \n <p>Localization file to use for i18n.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--i18n-format</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> No longer needed as the format will be determined automatically.</p>\n\n \n \n <p>Format of the localization file specified with --i18n-file.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--i18n-locale</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use 'localize' instead.</p>\n\n \n \n <p>Locale to use for i18n.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--i18n-missing-translation</code>\n </td>\n <td>\n \n <p>How to handle missing translations for i18n.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">warning|error|ignore</code></td>\n <td><code class=\"no-auto-link\">warning</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--index</code>\n </td>\n <td>\n \n <p>Configures the generation of the application's HTML index.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--localize</code>\n </td>\n <td>\n \n <p>Translate the bundles in one or more locales.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--main</code>\n </td>\n <td>\n \n <p>The full path for the main entry point to the app, relative to the current workspace.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--named-chunks</code>\n </td>\n <td>\n \n <p>Use file name for lazy loaded chunks.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--ngsw-config-path</code>\n </td>\n <td>\n \n <p>Path to ngsw-config.json.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--optimization</code>\n </td>\n <td>\n \n <p>Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code elimination, inlining of critical CSS and fonts inlining. For more information, see <a href=\"https://angular.io/guide/workspace-config#optimization-configuration\">https://angular.io/guide/workspace-config#optimization-configuration</a>.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--output-hashing</code>\n </td>\n <td>\n \n <p>Define the output filename cache-busting hashing mode.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">none|all|media|bundles</code></td>\n <td><code class=\"no-auto-link\">none</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--output-path</code>\n </td>\n <td>\n \n <p>The full path for the new output directory, relative to the current workspace.</p>\n<p>By default, writes output to a folder named dist/ in the current project.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--poll</code>\n </td>\n <td>\n \n <p>Enable and define the file watching poll time period in milliseconds.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">number</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--polyfills</code>\n </td>\n <td>\n \n <p>The full path for the polyfills file, relative to the current workspace.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--preserve-symlinks</code>\n </td>\n <td>\n \n <p>Do not use the real path when resolving modules. If unset then will default to <code>true</code> if NodeJS option --preserve-symlinks is set.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--prod</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use <code>--configuration production</code> instead.</p>\n\n \n \n <p>Shorthand for \"--configuration=production\".\nSet the build configuration to the production target.\nBy default, the production target is set up in the workspace configuration such that all builds make use of bundling, limited tree-shaking, and also limited dead code elimination.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--progress</code>\n </td>\n <td>\n \n <p>Log progress to the console while building.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--resources-output-path</code>\n </td>\n <td>\n \n <p>The path where style resources will be placed, relative to outputPath.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td><code class=\"no-auto-link\"></code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--service-worker</code>\n </td>\n <td>\n \n <p>Generates a service worker config for production builds.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--show-circular-dependencies</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> The recommended method to detect circular dependencies in project code is to use a either a lint rule or other external tooling.</p>\n\n \n \n <p>Show circular dependency warnings on builds.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--source-map</code>\n </td>\n <td>\n \n <p>Output source maps for scripts and styles. For more information, see <a href=\"https://angular.io/guide/workspace-config#source-map-configuration\">https://angular.io/guide/workspace-config#source-map-configuration</a>.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--stats-json</code>\n </td>\n <td>\n \n <p>Generates a 'stats.json' file which can be analyzed using tools such as 'webpack-bundle-analyzer'.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--subresource-integrity</code>\n </td>\n <td>\n \n <p>Enables the use of subresource integrity validation.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--ts-config</code>\n </td>\n <td>\n \n <p>The full path for the TypeScript configuration file, relative to the current workspace.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--vendor-chunk</code>\n </td>\n <td>\n \n <p>Generate a seperate bundle containing only vendor libraries. This option should only used for development.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--verbose</code>\n </td>\n <td>\n \n <p>Adds more details to output logging.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--watch</code>\n </td>\n <td>\n \n <p>Run build when files change.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--web-worker-ts-config</code>\n </td>\n <td>\n \n <p>TypeScript configuration for Web Worker modules.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n </tbody>\n</table>\n\n\n \n </div>\n</article>\n\n<!-- links to this doc:\n - cli\n - guide/aot-compiler\n - guide/deployment\n - guide/i18n\n - guide/service-worker-getting-started\n - guide/what-is-angular\n - guide/workspace-config\n-->\n<!-- links from this doc:\n - cli\n - cli/build#ng-build\n - guide/workspace-config\n - https://angular.io/guide/workspace-config#alternate-build-configurations\n - https://angular.io/guide/workspace-config#optimization-configuration\n - https://angular.io/guide/workspace-config#source-map-configuration\n - https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/build-long.md?message=docs%3A%20describe%20your%20change...\n - https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/build.json?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/build-long.md\n - https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/build.json\n - https://webpack.js.org/\n-->"
|
|
} |