@nx/js:tsc
Builds using TypeScript.
Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.
Examples
@nx/js:tsc can run the TypeScript Transformers by using the transformers option.
libs/ts-lib/project.json
1{
2 "build": {
3 "executor": "@nx/js:tsc",
4 "options": {
5 "outputPath": "dist/libs/ts-lib",
6 "main": "libs/ts-lib/src/index.ts",
7 "tsConfig": "libs/ts-lib/tsconfig.lib.json",
8 "assets": ["libs/ts-lib/*.md"],
9 "transformers": [
10 "@nestjs/swagger/plugin",
11 {
12 "name": "@automapper/classes/transformer-plugin",
13 "options": {}
14 }
15 ]
16 }
17 }
18}
19Options
main
Required
string
The name of the main entry-point file.
outputPath
Required
string
The output path of the generated files.
tsConfig
Required
string
The path to the Typescript configuration file.
additionalEntryPoints
Array<string>
Additional entry-points to add to exports field in the package.json file. Ignored when generatePackageJson is set to false.
generateExportsField
exports
boolean
Default:
falseUpdate the output package.json file's 'exports' field. This field is used by Node and bundlers. Ignored when generatePackageJson is set to false.
clean
boolean
Default:
trueRemove previous output before build.
generatePackageJson
boolean
Default:
trueGenerate package.json file in the output folder.
includeIgnoredAssetFiles
boolean
Default:
falseInclude files that are ignored by .gitignore and .nxignore when copying assets. WARNING: Ignored files are not automatically considered when calculating the task hash. To ensure Nx tracks these files for caching, add them to your target's inputs using 'dependentTasksOutputs' or 'runtime' configuration.
outputFileName
string
The path to the main file relative to the outputPath
rootDir
string
Sets the rootDir for TypeScript compilation. When not defined, it uses the root of project.
watch
boolean
Default:
falseEnable re-building when files change.
generateLockfile
Internal
boolean
Default:
falseGenerate a lockfile (e.g. package-lock.json) that matches the workspace lockfile to ensure package versions match. Ignored when generatePackageJson is set to false.