The JS plugin contains executors and generators that are useful for JavaScript/TypeScript projects in an Nx workspace. ## Setting Up JS ### Installation In any Nx workspace, you can install `@nrwl/js` by running the following commands if `@nrwl/js` package is not installed: {% tabs %} {%tab label="npm"%} ```bash npm i --save-dev @nrwl/js ``` {% /tab %} {%tab label="yarn"%} ```bash yarn add --dev @nrwl/js ``` {% /tab %} {% /tabs %} ### `ts` Preset When initializing a new Nx workspace, specifying `--preset=ts` will generate a workspace with `@nrwl/js` pre-installed. {% tabs %} {%tab label="npm"%} ```bash npx create-nx-workspace my-org --preset=ts ``` {% /tab %} {%tab label="yarn"%} ```bash yarn create nx-workspace my-org --preset=ts ``` {% /tab %} {% /tabs %} ## Create Libraries You can add a new JS/TS library with the following command: ```shell nx g @nrwl/js:lib my-lib ``` ## Build You can `build` libraries that are generated with `--buildable` flag. ```shell nx g @nrwl/js:lib my-buildable-lib --buildable ``` Generating a library with `--buildable` will add a `build` target to the library's `project.json` file allows the library to be built. ```shell nx build my-buildable-lib ``` ## Test You can test a library with the following command: ```shell nx test my-lib ``` ## Lint You can lint a library with the following command: ```shell nx lint my-lib ``` ## Compiler By default, `@nrwl/js` uses [TypeScript Compiler (TSC)](https://www.typescriptlang.org/docs/handbook/2/basic-types.html#tsc-the-typescript-compiler), via `@nrwl/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, `@nrwl/js` supports the following compilers: - [Speedy Web Compiler (SWC)](https://swc.rs) ### SWC - Create a buildable library with `swc` ```shell nx g @nrwl/js:lib my-swc-lib --compiler=swc --buildable ``` - Convert a `tsc` library to use `swc` ```shell nx g @nrwl/js:convert-to-swc my-buildable-lib ``` Now the `build` command will use `@nrwl/js:swc` executor to compile your libraries. > The first time you generate a `swc` library or convert a `tsc` library over to `swc`, `@nrwl/js` will install the necessary dependencies to use `swc`.