wehub-resource-sync
66 lines
2.4 KiB
Markdown
66 lines
2.4 KiB
Markdown
## Examples
|
|
|
|
##### Using TypeScript Transformer Plugins
|
|
|
|
`@nx/js:tsc` can run the [TypeScript Transformers](https://github.com/madou/typescript-transformer-handbook) by using the `transformers` option.
|
|
|
|
```json title="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"],
|
|
"transformers": [
|
|
"@nestjs/swagger/plugin",
|
|
{
|
|
"name": "@automapper/classes/transformer-plugin",
|
|
"options": {}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
##### Batch mode execution
|
|
|
|
:::tip[Available since Nx 16.6.0]
|
|
The `@nx/js:tsc` batch implementation was introduced in Nx **16.6.0**.
|
|
:::
|
|
|
|
The `@nx/js:tsc` executor supports running multiple tasks in a single process. When running in batch mode, the executor uses the [TypeScript APIs for incremental builds](https://www.typescriptlang.org/docs/handbook/project-references.html#build-mode-for-typescript). 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).
|
|
|
|
:::danger[Experimental feature]
|
|
Executing tasks in batch mode is an experimental feature.
|
|
:::
|
|
|
|
:::tip[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.
|
|
:::
|
|
|
|
To run your builds using the batch implementation, pass in `--batch` flag:
|
|
|
|
```shell
|
|
nx build ts-lib --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 title="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
|
|
}
|
|
}
|
|
}
|
|
```
|