library
Create a new NestJS library.
Usage
nx generate library ...nx g lib ... # sameBy 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/nest:library ...Show what will be generated without writing to disk:
nx g library ... --dry-runExamples
Generate libs/myapp/mylib:
nx g lib mylib --directory=myappOptions
name (required)
Type:
stringLibrary name.
buildable
Default:
falseType:
booleanGenerate a buildable library.
controller
Default:
falseType:
booleanInclude a controller with the library.
directory
Alias(es): d
Type:
stringA directory where the library is placed.
global
Default:
falseType:
booleanAdd the Global decorator to the generated module.
importPath
Type:
stringThe library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.
linter
Default:
eslintType:
stringPossible values:
eslint, noneThe tool to use for running lint checks.
publishable
Type:
booleanCreate a publishable library.
service
Default:
falseType:
booleanInclude a service with the library.
skipFormat
Default:
falseType:
booleanSkip formatting files.
skipTsConfig
Default:
falseType:
booleanDo not update tsconfig.base.json for development experience.
strict
Default:
falseType:
booleanWhether to enable tsconfig strict mode or not.
tags
Alias(es): t
Type:
stringAdd tags to the library (used for linting).
target
Default:
es6Type:
stringPossible values:
es5, es6, esnext, es2015, es2016, es2017, es2018, es2019, es2020The ES target, Nest suggest using es6 or higher.
testEnvironment
Default:
nodeType:
stringPossible values:
jsdom, nodeThe test environment for jest, for node applications this should stay as node unless doing DOM testing.
unitTestRunner
Default:
jestType:
stringPossible values:
jest, noneTest runner to use for unit tests.