nx/overview.md at af9d980f34a69429f912bf655bdb51a1539d3c34

docs(js): add a note to JS plugin overview that --preset=ts changed in Nx 20, and that --preset=app can still be used (#28277 )

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 #

2024-10-03 14:00:01 -04:00

3.5 KiB

Raw Blame History

title	description
Overview of the Nx JS Plugin	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. {% /callout %}

In any Nx workspace, you can install @nx/js by running the following command:

{% tabs %} {% tab label="Nx 18+" %}

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.

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"%}

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

{% /tab %} {%tab label="yarn"%}

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 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. {% /callout %}

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:

Speedy Web Compiler (SWC)

SWC

Create a buildable library with swc

nx g @nx/js:lib libs/my-swc-lib --bundler=swc

Convert a tsc library to use swc

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.

3.5 KiB Raw Blame History