810896caae
Since `--preset=ts` has changed, we want to provide users with a way to generate the older, integrated setup if they need to. <!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
129 lines
3.5 KiB
Markdown
129 lines
3.5 KiB
Markdown
---
|
|
title: Overview of the Nx JS Plugin
|
|
description: The Nx JS plugin contains executors and generators that are useful for JavaScript/TypeScript projects in an Nx workspace.
|
|
---
|
|
|
|
The JS plugin contains executors and generators that are useful for JavaScript/TypeScript projects in an Nx workspace.
|
|
|
|
## Setting Up @nx/js
|
|
|
|
### Installation
|
|
|
|
{% callout type="note" title="Keep 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](/recipes/tips-n-tricks/keep-nx-versions-in-sync).
|
|
{% /callout %}
|
|
|
|
In any Nx workspace, you can install `@nx/js` by running the following command:
|
|
|
|
{% tabs %}
|
|
{% tab label="Nx 18+" %}
|
|
|
|
```shell {% skipRescope=true %}
|
|
nx add @nx/js
|
|
```
|
|
|
|
This will install the correct version of `@nx/js`.
|
|
|
|
{% /tab %}
|
|
{% tab label="Nx < 18" %}
|
|
|
|
Install the `@nx/js` package with your package manager.
|
|
|
|
```shell
|
|
npm add -D @nx/js
|
|
```
|
|
|
|
{% /tab %}
|
|
{% /tabs %}
|
|
|
|
### `ts` Preset
|
|
|
|
When initializing a new Nx workspace, specifying `--preset=ts` will generate a workspace with `@nx/js` pre-installed.
|
|
|
|
{% tabs %}
|
|
{%tab label="npm"%}
|
|
|
|
```shell
|
|
npx create-nx-workspace my-org --preset=ts
|
|
```
|
|
|
|
{% /tab %}
|
|
{%tab label="yarn"%}
|
|
|
|
```shell
|
|
yarn create nx-workspace my-org --preset=ts
|
|
```
|
|
|
|
{% /tab %}
|
|
{% /tabs %}
|
|
|
|
{% callout type="note" title="Modernized monorepo setup" %}
|
|
Nx 20 updates the TS monorepo setup when using `--preset=ts`. The workspace is set up with [TypeScript Project References](https://www.typescriptlang.org/docs/handbook/project-references.html) along with the Workspaces feature from [npm](https://docs.npmjs.com/cli/using-npm/workspaces), [yarn](https://yarnpkg.com/features/workspaces), [pnpm](https://pnpm.io/workspaces), and [bun](https://bun.sh/docs/install/workspaces).
|
|
|
|
To create with the older setup for TS monorepo with `compilerOptions.paths`, use `create-nx-workspace --preset=apps`.
|
|
{% /callout %}
|
|
|
|
## Create Libraries
|
|
|
|
You can add a new JS/TS library with the following command:
|
|
|
|
```shell
|
|
nx g @nx/js:lib libs/my-lib
|
|
```
|
|
|
|
## Build
|
|
|
|
You can `build` libraries that are generated with a bundler specified.
|
|
|
|
```shell
|
|
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.
|
|
|
|
```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, `@nx/js` uses [TypeScript Compiler (TSC)](https://www.typescriptlang.org/docs/handbook/2/basic-types.html#tsc-the-typescript-compiler), 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:
|
|
|
|
- [Speedy Web Compiler (SWC)](https://swc.rs)
|
|
|
|
### SWC
|
|
|
|
- Create a buildable library with `swc`
|
|
|
|
```shell
|
|
nx g @nx/js:lib libs/my-swc-lib --bundler=swc
|
|
```
|
|
|
|
- Convert a `tsc` library to use `swc`
|
|
|
|
```shell
|
|
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 a `tsc` library over to `swc`, `@nx/js` will install the necessary dependencies to use `swc`.
|