The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. 

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:

```shell
npm i --save-dev @nrwl/js
```

```shell
yarn add --dev @nrwl/js
```

### `ts` Preset

When initializing a new Nx workspace, specifying `--preset=ts` will generate a workspace with `@nrwl/js` pre-installed.

```shell
npx create-nx-workspace my-org --preset=ts
```

```shell
yarn create nx-workspace my-org --preset=ts
```

## 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`.


Overview

When `updateBuildableProjectDepsInPackageJson` is `true`, this adds dependencies to either `peerDependencies` or `dependencies`.

Sets the rootDir for TypeScript compilation. When not defined, it uses the root of project.

The path to the Typescript configuration file.

Whether to update the buildable project dependencies in `package.json`.

Typescript Build Target

Whether to skip TypeScript type checking.

List of SWC Glob/Regex to be excluded from compilation (https://swc.rs/docs/configuration/compilation#exclude).

The path to the SWC configuration file. Default: .lib.swcrc

node

Additional options to pass into the build target.

Ensures the app is starting with debugging.

The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes.

The targets to run to before starting the node app.

Node executor

library

The compiler used by the build and test targets

The library name used to import it, like @myorg/my-awesome-lib.

Include a .babelrc configuration to compile TypeScript files

Generate JavaScript files rather than TypeScript files.

Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.

Do not update tsconfig.json for development experience.

Whether to skip TypeScript type checking for SWC compiler.

Whether to enable tsconfig strict mode or not.

The test environment to use if unitTestRunner is set to jest.

Create a TypeScript Library

init

Init nrwl/js

Convert a TypeScript library to compile with SWC.

@nrwl/js:convert-to-swc

Usage

Examples

Options

project

targets