mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
a3787bdfa6
This changes include mentioning the experimental application builder migration and changes to the `outputPath` and `optimization` option. PR Close #53949
259 lines
14 KiB
Markdown
259 lines
14 KiB
Markdown
# Getting started with the Angular CLI's new build system
|
|
|
|
In v17 and higher, the new build system provides an improved way to build Angular applications. This new build system includes:
|
|
|
|
- A modern output format using ESM, with dynamic import expressions to support lazy module loading.
|
|
- Faster build-time performance for both initial builds and incremental rebuilds.
|
|
- Newer JavaScript ecosystem tools such as [esbuild](https://esbuild.github.io/) and [Vite](https://vitejs.dev/).
|
|
- Integrated SSR and prerendering capabilites
|
|
|
|
This new build system is stable and fully supported for use with Angular applications.
|
|
You can migrate to the new build system with applications that use the `browser` builder.
|
|
If using a custom builder, please refer to the documentation for that builder on possible migration options.
|
|
|
|
<div class="alert is-important">
|
|
|
|
The existing Webpack-based build system is still considered stable and fully supported.
|
|
Applications can continue to use the `browser` builder and will not be automatically migrated when updating.
|
|
|
|
</div>
|
|
|
|
## For new applications
|
|
|
|
New applications will use this new build system by default via the `application` builder.
|
|
|
|
## For existing applications
|
|
|
|
For existing projects, you can opt-in to use the new builder on a per-application basis with two different options.
|
|
Both options are considered stable and fully supported by the Angular team.
|
|
The choice of which option to use is a factor of how many changes you will need to make to migrate and what new features you would like to use in the project.
|
|
|
|
Builder | Configuration Changes | Code Changes | Integrated SSR |
|
|
| :----- | :-------- | :------ | :------- |
|
|
| `application` | Multiple option changes required. If using SSR, additional targets will need to be updated. | Yes, if using SSR | Yes
|
|
| `browser-esbuild` | builder name only | No* | No
|
|
|
|
The `application` builder is generally preferred as it improves server-side rendered (SSR) builds, and makes it easier for client-side rendered projects to adopt SSR in the future.
|
|
However it requires a little more migration effort, particularly for existing SSR applications.
|
|
If the `application` builder is difficult for your project to adopt, `browser-esbuild` can be an easier solution which gives most of the build performance benefits with fewer breaking changes.
|
|
|
|
### Using the `browser-esbuild` builder
|
|
|
|
A builder named `browser-esbuild` is available within the `@angular-devkit/build-angular` package that is present in an Angular CLI generated application. The builder is a drop-in replacement for the existing `browser` builder that provides the preexisting browser application build system.
|
|
|
|
The compatiblity option was implemented to minimize the amount of changes necessary to initially migrate your applications.
|
|
This is provided via an alternate builder (`browser-esbuild`).
|
|
You can update the `build` target for any application target to migrate to the new build system.
|
|
|
|
The following is what you would typically find in `angular.json` for an application:
|
|
|
|
<code-example language="json" hideCopy="true">
|
|
...
|
|
"architect": {
|
|
"build": {
|
|
"builder": "@angular-devkit/build-angular:browser",
|
|
...
|
|
</code-example>
|
|
|
|
Changing the `builder` field is the only change you will need to make.
|
|
|
|
<code-example language="json" hideCopy="true">
|
|
...
|
|
"architect": {
|
|
"build": {
|
|
"builder": "@angular-devkit/build-angular:browser-esbuild",
|
|
...
|
|
</code-example>
|
|
|
|
### Using the `application` builder
|
|
|
|
A builder named `application` is also available within the `@angular-devkit/build-angular` package that is present in an Angular CLI generated application.
|
|
This builder is the default for all new applications created via `ng new`.
|
|
|
|
The following is what you would typically find in `angular.json` for an application:
|
|
|
|
<code-example language="json" hideCopy="true">
|
|
...
|
|
"architect": {
|
|
"build": {
|
|
"builder": "@angular-devkit/build-angular:browser",
|
|
...
|
|
</code-example>
|
|
|
|
Changing the `builder` field is the first change you will need to make.
|
|
|
|
<code-example language="json" hideCopy="true">
|
|
...
|
|
"architect": {
|
|
"build": {
|
|
"builder": "@angular-devkit/build-angular:application",
|
|
...
|
|
</code-example>
|
|
|
|
Once the builder name has been changed, options within the `build` target will need to be updated.
|
|
The following table lists all the `browser` builder options that will need to be adjusted or removed.
|
|
|
|
| `browser` Option | Action | Notes |
|
|
| :-------------- | :----- | :----- |
|
|
| `main` | rename option to `browser` | |
|
|
| `polyfills` | convert value to an array | may already have been migrated |
|
|
| `buildOptimizer` | remove option |
|
|
| `resourcesOutputPath` | move option to `outputPath.media` | defaults to `media` |
|
|
| `vendorChunk` | remove option |
|
|
| `commonChunk` | remove option |
|
|
| `deployUrl` | remove option |
|
|
| `ngswConfigPath` | move value to `serviceWorker` and remove option | `serviceWorker` is now either `false` or a configuration path
|
|
|
|
|
|
If the application is not using SSR currently, this should be the final step to allow `ng build` to function.
|
|
After executing `ng build` for the first time, there may be new warnings or errors based on behavioral differences or application usage of Webpack-specific features.
|
|
Many of the warnings will provide suggestions on how to remedy that problem.
|
|
If it appears that a warning is incorrect or the solution is not apparent, please open an issue on [GitHub](https://github.com/angular/angular-cli/issues).
|
|
Also, the later sections of this guide provide additional information on several specific cases as well as current known issues.
|
|
|
|
For applications new to SSR, the [Angular SSR Guide](/guide/ssr) provides additional information regarding the setup process for adding SSR to an application.
|
|
|
|
For applications that are already using SSR, additional adjustments will be needed to update the application server to support the new integrated SSR capabilities.
|
|
The `application` builder now provides the integrated functionality for all of the following preexisting builders:
|
|
|
|
* `app-shell`
|
|
* `prerender`
|
|
* `server`
|
|
* `ssr-dev-server`
|
|
|
|
The `ng update` process will automatically remove usages of the `@nguniversal` scope packages where some of these builders were previously located.
|
|
The new `@angular/ssr` package will also be automatically added and used with configuration and code being adjusted during the update.
|
|
The `@angular/ssr` package supports the `browser` builder as well as the `application` builder.
|
|
To convert from the separate SSR builders to the integrated capabilities of the `application` builder, run the experimental `use-application-builder` migration.
|
|
|
|
<code-example language="shell">
|
|
|
|
ng update @angular/cli --name use-application-builder
|
|
|
|
</code-example>
|
|
|
|
The migration does the following:
|
|
|
|
* Converts existing `browser` or `browser-esbuild` target to `application`
|
|
* Removes any previous SSR builders (because `application` does that now).
|
|
* Updates configuration accordingly.
|
|
* Merges `tsconfig.server.json` with `tsconfig.app.json` and adds the TypeScript option `"esModuleInterop": true` to ensure `express` imports are [ESM compliant](#esm-default-imports-vs-namespace-imports).
|
|
* Updates application server code to use new bootstrapping and output directory structure.
|
|
|
|
<div class="alert is-important">
|
|
|
|
Remember to remove any CommonJS assumptions in the application server code such as `require`, `__filename`, `__dirname`, or other constructs from the [CommonJS module scope](https://nodejs.org/api/modules.html#the-module-scope). All application code should be ESM compatible. This does not apply to third-party dependencies.
|
|
|
|
</div>
|
|
|
|
## Executing a build
|
|
|
|
Once you have updated the application configuration, builds can be performed using the `ng build` as was previously done.
|
|
Depending on the choice of builder migration, some of the command line options may be different.
|
|
If the build command is contained in any `npm` or other scripts, ensure they are reviewed and updated.
|
|
For applications that have migrated to the `application` builder and that use SSR and/or prererending, you also may be able to remove extra `ng run` commands from scripts now that `ng build` has integrated SSR support.
|
|
|
|
<code-example language="shell">
|
|
|
|
ng build
|
|
|
|
</code-example>
|
|
|
|
## Starting the development server
|
|
|
|
The development server will automatically detect the new build system and use it to build the application.
|
|
To start the development server no changes are necessary to the `dev-server` builder configuration or command line.
|
|
|
|
<code-example language="shell">
|
|
|
|
ng serve
|
|
|
|
</code-example>
|
|
|
|
You can continue to use the [command line options](/cli/serve) you have used in the past with the development server.
|
|
|
|
<div class="alert is-important">
|
|
|
|
JavaScript-based Hot Module Replacement (HMR) is currently not supported.
|
|
However, global stylesheet (`styles` build option) HMR is available and enabled by default.
|
|
Angular focused HMR capabilities are currently planned and will be introduced in a future version.
|
|
|
|
</div>
|
|
|
|
## Unimplemented options and behavior
|
|
|
|
Several build options are not yet implemented but will be added in the future as the build system moves towards a stable status. If your application uses these options, you can still try out the build system without removing them. Warnings will be issued for any unimplemented options but they will otherwise be ignored. However, if your application relies on any of these options to function, you may want to wait to try.
|
|
|
|
- [WASM imports](https://github.com/angular/angular-cli/issues/25102) -- WASM can still be loaded manually via [standard web APIs](https://developer.mozilla.org/en-US/docs/WebAssembly/Loading_and_running).
|
|
|
|
Building libraries with the new build system via `ng-packagr` is also not yet possible but library build support will be available in a future release.
|
|
|
|
## ESM default imports vs. namespace imports
|
|
|
|
TypeScript by default allows default exports to be imported as namespace imports and then used in call expressions. This is unfortunately a divergence from the ECMAScript specification. The underlying bundler (`esbuild`) within the new build system expects ESM code that conforms to the specification. The build system will now generate a warning if your application uses an incorrect type of import of a package. However, to allow TypeScript to accept the correct usage, a TypeScript option must be enabled within the application's `tsconfig` file. When enabled, the [`esModuleInterop`](https://www.typescriptlang.org/tsconfig#esModuleInterop) option provides better alignment with the ECMAScript specification and is also recommended by the TypeScript team. Once enabled, you can update package imports where applicable to an ECMAScript conformant form.
|
|
|
|
Using the [`moment`](https://npmjs.com/package/moment) package as an example, the following application code will cause runtime errors:
|
|
|
|
```ts
|
|
import * as moment from 'moment';
|
|
|
|
console.log(moment().format());
|
|
```
|
|
|
|
The build will generate a warning to notify you that there is a potential problem. The warning will be similar to:
|
|
|
|
<code-example format="shell" language="shell" hideCopy="true">
|
|
▲ [WARNING] Calling "moment" will crash at run-time because it's an import namespace object, not a function [call-import-namespace]
|
|
|
|
src/main.ts:2:12:
|
|
2 │ console.log(moment().format());
|
|
╵ ~~~~~~
|
|
|
|
Consider changing "moment" to a default import instead:
|
|
|
|
src/main.ts:1:7:
|
|
1 │ import * as moment from 'moment';
|
|
│ ~~~~~~~~~~~
|
|
╵ moment
|
|
|
|
</code-example>
|
|
|
|
However, you can avoid the runtime errors and the warning by enabling the `esModuleInterop` TypeScript option for the application and changing the import to the following:
|
|
|
|
```ts
|
|
import moment from 'moment';
|
|
|
|
console.log(moment().format());
|
|
```
|
|
|
|
## Vite as a development server
|
|
|
|
The usage of Vite in the Angular CLI is currently only within a _development server capacity only_. Even without using the underlying Vite build system, Vite provides a full-featured development server with client side support that has been bundled into a low dependency npm package. This makes it an ideal candidate to provide comprehensive development server functionality. The current development server process uses the new build system to generate a development build of the application in memory and passes the results to Vite to serve the application. The usage of Vite, much like the Webpack-based development server, is encapsulated within the Angular CLI `dev-server` builder and currently cannot be directly configured.
|
|
|
|
## Known Issues
|
|
|
|
There are currently several known issues that you may encounter when trying the new build system. This list will be updated to stay current. If any of these issues are currently blocking you from trying out the new build system, please check back in the future as it may have been solved.
|
|
|
|
### Type-checking of Web Worker code and processing of nested Web Workers
|
|
|
|
Web Workers can be used within application code using the same syntax (`new Worker(new URL('<workerfile>', import.meta.url))`) that is supported with the `browser` builder.
|
|
However, the code within the Worker will not currently be type-checked by the TypeScript compiler. TypeScript code is supported just not type-checked.
|
|
Additionally, any nested workers will not be processed by the build system. A nested worker is a Worker instantiation within another Worker file.
|
|
|
|
### Order-dependent side-effectful imports in lazy modules
|
|
|
|
Import statements that are dependent on a specific ordering and are also used in multiple lazy modules can cause top-level statements to be executed out of order.
|
|
This is not common as it depends on the usage of side-effectful modules and does not apply to the `polyfills` option.
|
|
This is caused by a [defect](https://github.com/evanw/esbuild/issues/399) in the underlying bundler but will be addressed in a future update.
|
|
|
|
<div class="alert is-important">
|
|
|
|
Avoiding the use of modules with non-local side effects (outside of polyfills) is recommended whenever possible regardless of the build system being used and avoids this particular issue. Modules with non-local side effects can have a negative effect on both application size and runtime performance as well.
|
|
|
|
</div>
|
|
|
|
## Bug reports
|
|
|
|
Report issues and feature requests on [GitHub](https://github.com/angular/angular-cli/issues).
|
|
|
|
Please provide a minimal reproduction where possible to aid the team in addressing issues.
|