@nx/nestSee schema

@nx/nest:library

Create a NestJS Library for Nx.

Usage

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

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

You can specify the collection explicitly as follows:

1nx g @nx/nest:library ... 2

Show what will be generated without writing to disk:

1nx g library ... --dry-run 2

Examples

Generate libs/myapp/mylib:

1nx g lib mylib --directory=myapp 2

Options

directory

dirRequired
string

A directory where the library is placed.

buildable

boolean
Default: false

Generate a buildable library.

linter

string
Default: none
Accepted values: eslint, none

The tool to use for running lint checks.

publishable

boolean

Create a publishable library.

unitTestRunner

string
Default: none
Accepted values: jest, none

Test runner to use for unit tests.

controller

boolean
Default: false

Include a controller with the library.

global

boolean
Default: false

Add the Global decorator to the generated module.

importPath

string

The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.

name

string
Pattern: (?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$

Library name.

service

boolean
Default: false

Include a service with the library.

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.

simpleName

boolean
Default: false

Don't include the directory in the name of the module of the library.

tags

t
string

Add tags to the library (used for linting).

testEnvironment

string
Default: node
Accepted values: jsdom, node

The test environment for jest, for node applications this should stay as node unless doing DOM testing.

target

string
Default: es2021
Accepted values: es5, es6, esnext, es2015, es2016, es2017, es2018, es2019, es2020, es2021

The ES target, Nest suggest using es2021 or higher.

useProjectJson

boolean

Use a project.json configuration file instead of inlining the Nx configuration in the package.json file.

skipFormat

Internal
boolean
Default: false

Skip formatting files.

skipTsConfig

Internal
boolean
Default: false

Do not update tsconfig.base.json for development experience.

skipPackageJson

Internal
boolean
Default: false

Do not add dependencies to package.json.