@nrwl/jsSee schema

@nrwl/js:library

Create a TypeScript Library.

The @nrwl/js:lib generator will generate a library for you, and it will configure it according to the options you provide.

npx nx g @nrwl/js:lib mylib

By default, the library that is generated when you use this executor without passing any options, like the example above, will be a buildable library, using the @nrwl/js:tsc executor as a builder.

You may configure the tools you want to use to build your library, or bundle it too, by passing the --bundler flag. The --bundler flag controls the compiler and/or the bundler that will be used to build your library. If you choose tsc or swc, the result will be a buildable library using either tsc or swc as the compiler. If you choose rollup or vite, the result will be a buildable library using rollup or vite as the bundler. In the case of rollup, it will default to the tsc compiler. If you choose esbuild, you may use the esbuildOptions property in your project.json under the build target options to specify whether you wish to bundle your library or not.

Examples

Generate a buildable library using the @nrwl/js:tsc executor. This uses tsc as the compiler.

npx nx g @nrwl/js:lib mylib

Usage

nx generate library ...
nx g lib ... #same

By default, Nx will search for library in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

nx g @nrwl/js:library ...

Show what will be generated without writing to disk:

nx g library ... --dry-run

Options

name

Required
string
Pattern: ^[a-zA-Z].*$

Library name.

bundler

string
Default: tsc
Accepted values: swc, tsc, rollup, vite, esbuild, none

The bundler to use. Choosing 'none' means this library is not buildable.

directory

string

A directory where the lib is placed.

publishable

boolean
Default: false

Generate a publishable library.

includeBabelRc

boolean

Include a .babelrc configuration to compile TypeScript files

importPath

string

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

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

linter

string
Default: eslint
Accepted values: eslint, none

The tool to use for running lint checks.

minimal

boolean
Default: false

Generate a library with a minimal setup. No README.md generated.

pascalCaseFiles

P
boolean
Default: false

Use pascal case file names.

strict

boolean
Default: true

Whether to enable tsconfig strict mode or not.

setParserOptionsProject

boolean
Default: false

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

skipTypeCheck

boolean
Default: false

Whether to skip TypeScript type checking for SWC compiler.

simpleName

boolean
Default: false

Don't include the directory in the generated file name.

tags

string

Add tags to the library (used for linting).

testEnvironment

string
Default: jsdom
Accepted values: jsdom, node

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

unitTestRunner

string
Accepted values: jest, vitest, none

Test runner to use for unit tests.

config

string
Default: project
Accepted values: workspace, project, npm-scripts

Determines whether the project's executors should be configured in workspace.json, project.json or as npm scripts.

skipFormat

boolean
Default: false

Skip formatting files.

skipTsConfig

boolean
Default: false

Do not update tsconfig.json for development experience.

buildable

Deprecated
boolean
Default: true

Generate a buildable library.

Use the bundler option for greater control (swc, tsc, rollup, vite, esbuild, none).

compiler

Deprecated
string
Default: tsc
Accepted values: tsc, swc

The compiler used by the build and test targets

Use the bundler option for greater control (swc, tsc, rollup, vite, esbuild, none).