Rescope @nrwl to @nx

@nx/js

The JS plugin contains executors and generators that are useful for JavaScript/TypeScript projects in an Nx workspace.

Setting Up @nx/js

Installation

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.

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

❯

nx add @nx/js

This will install the correct version of @nx/js.

ts Preset

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

❯

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

Create Libraries

You can add a new JS/TS library with the following command:

❯

nx g @nx/js:lib my-lib

Build

You can build libraries that are generated with a bundler specified.

❯

nx g @nx/js:lib 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:

SWC

  • Create a buildable library with swc

❯

nx g @nx/js:lib 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.

Package reference

Here is a list of all the executors and generators available from this package.

Guides

Executors

  • tsc

    Build a project using TypeScript.

  • swc

    Build a project using SWC.

  • node

    Execute a Node application.

  • release-publishInternal

    DO NOT INVOKE DIRECTLY WITH nx run. Use nx release publish instead.

  • verdaccio

    Start local registry with verdaccio

Generators

  • library

    Create a library

  • initInternal

    Initialize a TS/JS workspace.

  • convert-to-swc

    Convert a TypeScript library to compile with SWC.

  • release-versionInternal

    DO NOT INVOKE DIRECTLY WITH nx generate. Use nx release version instead.

  • setup-verdaccio

    Setup Verdaccio for local package management.

  • setup-build

    setup-build generator

  • typescript-syncInternal

    Synchronize TypeScript project references based on the project graph