The JS plugin contains executors and generators that are useful for JavaScript/TypeScript projects in an Nx workspace.
Setting Up @nx/js
Installation
Make sure to install the @nx/js
version that matches the version of nx
in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can fix Nx version mismatches with this recipe.
In any Nx workspace, you can install @nx/js
by running the following command:
โฏ
nx add @nx/js
This will install the correct version of @nx/js
.
ts
Preset
When initializing a new Nx workspace, specifying --preset=ts
will generate a workspace with @nx/js
pre-installed.
โฏ
npx create-nx-workspace my-org --preset=ts
Nx 20 updates the TS monorepo setup when using --preset=ts
. The workspace is set up with TypeScript Project References along with the Workspaces feature from npm, yarn, pnpm, and bun.
To create with the older setup for TS monorepo with compilerOptions.paths
, use create-nx-workspace --preset=apps
.
Create Libraries
You can add a new JS/TS library with the following command:
โฏ
nx g @nx/js:lib libs/my-lib
Build
You can build
libraries that are generated with a bundler specified.
โฏ
nx g @nx/js:lib libs/my-buildable-lib --bundler=rollup
Generating a library with --bundler
specified will add a build
target to the library's project.json
file allows the library to be built.
โฏ
nx build my-buildable-lib
Test
You can test a library with the following command:
โฏ
nx test my-lib
Lint
You can lint a library with the following command:
โฏ
nx lint my-lib
Compiler
By default, @nx/js
uses TypeScript Compiler (TSC), via @nx/js:tsc
executor, to compile your libraries. Optionally, you can switch tsc
out for a different compiler with --compiler
flag when executing the generators.
Currently, @nx/js
supports the following compilers:
SWC
- Create a buildable library with
swc
โฏ
nx g @nx/js:lib libs/my-swc-lib --bundler=swc
- Convert a
tsc
library to useswc
โฏ
nx g @nx/js:convert-to-swc my-buildable-lib
Now the build
command will use @nx/js:swc
executor to compile your libraries.
The first time you generate a
swc
library or convert atsc
library over toswc
,@nx/js
will install the necessary dependencies to useswc
.