Setting Up JS
InstallationKeep Nx Package Versions In Sync
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 commands if
@nx/js package is not installed:
When initializing a new Nx workspace, specifying
--preset=ts will generate a workspace with
npx create-nx-workspace my-org --preset=ts
You can add a new JS/TS library with the following command:
build libraries that are generated with a bundler specified.
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
You can test a library with the following command:
nx test my-lib
You can lint a library with the following command:
nx lint my-lib
@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.
@nx/js supports the following compilers:
- Create a buildable library with
- Convert a
tsclibrary to use
build command will use
@nx/js:swc executor to compile your libraries.
The first time you generate a
swclibrary or convert a
tsclibrary over to
@nx/jswill install the necessary dependencies to use