library
Create a 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/node: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
babelJest
Default:
falseType:
booleanUse babel instead ts-jest
buildable
Default:
falseType:
booleanGenerate a buildable library.
directory
Alias(es): d
Type:
stringA directory where the lib is placed
importPath
Type:
stringThe library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.
js
Default:
falseType:
booleanGenerate JavaScript files rather than TypeScript files.
linter
Default:
eslintType:
stringPossible values:
eslint, tslintThe tool to use for running lint checks.
pascalCaseFiles
Alias(es): P
Default:
falseType:
booleanUse pascal case file names.
publishable
Type:
booleanCreate a publishable library.
rootDir
Alias(es): srcRootForCompilationRoot
Type:
stringSets the rootDir for TypeScript compilation. When not defined, it uses the project's root property, or srcRootForCompilationRoot if it is defined.
simpleModuleName
Default:
falseType:
booleanKeep the module name simple (when using --directory)
skipFormat
Default:
falseType:
booleanSkip formatting files
skipTsConfig
Default:
falseType:
booleanDo not update tsconfig.base.json for development experience.
standaloneConfig
Default:
falseType:
booleanSplit the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
strict
Default:
falseType:
booleanWhether to enable tsconfig strict mode or not.
tags
Alias(es): t
Type:
stringAdd tags to the library (used for linting)
testEnvironment
Default:
jsdomType:
stringPossible values:
jsdom, nodeThe test environment to use if unitTestRunner is set to jest
unitTestRunner
Default:
jestType:
stringPossible values:
jest, noneTest runner to use for unit tests