e32079ce3b
Implicit dependencies are not referenced in code and therefore TSC incremental builds are not applicable. ## Current Behavior A project using the `@nx/js:tsc` executor will fail to build if it has implicit dependencies on projects which do not use the `@nx/js:tsc` executor. To reproduce: * Clone https://github.com/cogwirrel/nx-tsc-batch-implicit-deps-example * `pnpm i && pnpm nx run-many --target build --batch --all` ## Expected Behavior - Implicit dependencies that do not use the `@nx/js:tsc` executor are permitted. For example, a TypeScript project may implicitly depend on a Python project, but the TypeScript project should still be buildable in batch mode. - Projects using the `@nx/js:tsc` executor will still fail to build if they have explicit dependencies on projects which do not use the `@nx/js:tsc` executor. Tested by publishing to the local registry, upgrading the [example repo](https://github.com/cogwirrel/nx-tsc-batch-implicit-deps-example) to use my local version, and built successfully in batch mode. ## Related Issue(s) Fixes #28839
41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
# Enable Typescript Batch Mode
|
|
|
|
{% callout type="check" title="Available since Nx 16.6.0" %}
|
|
The `@nx/js:tsc` batch implementation was introduced in Nx **16.6.0**.
|
|
{% /callout %}
|
|
|
|
If you're using the `@nx/js:tsc` to build your projects, you can opt-in to use its batch implementation. The batch implementation uses the [TypeScript APIs for incremental builds](https://www.typescriptlang.org/docs/handbook/project-references.html#build-mode-for-typescript) and batches the execution of the tasks into a single process. This results in a much faster build time when compared to the default implementation (the bigger the task graph to run, the more the performance improvements).
|
|
|
|
{% callout type="warning" title="Experimental feature" %}
|
|
Executing tasks in batch mode is an experimental feature.
|
|
{% /callout %}
|
|
|
|
{% callout type="info" title="Requirements" %}
|
|
Building a project with the `@nx/js:tsc` executor in batch mode requires all dependent projects (excluding implicit dependencies) to be buildable and built using the `@nx/js:tsc` executor.
|
|
{% /callout %}
|
|
|
|
To run your builds using the batch implementation, pass in `--batch` flag:
|
|
|
|
```shell
|
|
nx build my-project --batch
|
|
```
|
|
|
|
For optimal performance, you could set the `clean` option to `false`. Otherwise, the executor cleans the output folder before running the build, which results in the loss of the [`.tsbuildinfo` file](https://www.typescriptlang.org/tsconfig/#tsBuildInfoFile) and, consequently, the loss of important optimizations performed by TypeScript. This is not a requirement. Even if the `clean` option is not set to `false` there are other important optimizations that are performed by the batch implementation.
|
|
|
|
```json {% fileName="libs/ts-lib/project.json" %}
|
|
{
|
|
"build": {
|
|
"executor": "@nx/js:tsc",
|
|
"options": {
|
|
"outputPath": "dist/libs/ts-lib",
|
|
"main": "libs/ts-lib/src/index.ts",
|
|
"tsConfig": "libs/ts-lib/tsconfig.lib.json",
|
|
"assets": ["libs/ts-lib/*.md"],
|
|
"clean": false
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
You can get a sense of the performance improvements over using the `@nx/js:tsc` default implementation in the [tsc batch mode benchmark](/showcase/benchmarks/tsc-batch-mode).
|