@nx/esbuild:configuration
Add esbuild configuration to a project.
1nx g @nx/esbuild:configuration my-package
2Overwriting existing build option
The configuration generator validates that an existing build target isn't already defined for the project. If you are adding esbuild to a project with an existing build target, pass the --skipValidation option.
You may also provide a custom main entry file, or a custom tsconfig file if the defaults don't work. By default, the generator will look for a main file matching src/index.ts or src/main.ts, and a tsconfig file matching tsconfig.app.json or tsconfig.lib.json.
1nx g @nx/esbuild:configuration my-package \
2--main=packages/my-package/src/entry.ts \
3--tsConfig=packages/my-package/tsconfig.custom.json
4Usage
1nx generate configuration ...
21nx g esbuild-project ... #same
2By default, Nx will search for configuration in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
1nx g @nx/esbuild:configuration ...
2Show what will be generated without writing to disk:
1nx g configuration ... --dry-run
2Options
main
entryFile
string
Path relative to the workspace root for the main entry file. Defaults to <project-root>/src/main.ts or <project-root>src/index.ts, whichever is found.
project
string
The name of the project.
tsConfig
string
Path relative to the workspace root for the tsconfig file to build with. Defaults to <project-root>/tsconfig.app.json or <project-root>/tsconfig.lib.json, whichever is found.
buildTarget
string
Default:
buildThe build target to add.
importPath
string
The library name used to import it, like @myorg/my-awesome-lib.
platform
string
Default:
nodeAccepted values:
browser, node, neutralPlatform target for outputs.
skipFormat
Internal
boolean
Default:
falseSkip formatting files.
skipPackageJson
Internal
boolean
Default:
falseDo not add dependencies to package.json.
skipValidation
Internal
boolean
Default:
falseDo not perform any validation on existing project.