@nrwl/node:library
Create a Node Library for an Nx workspace.
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
buildable
falseGenerate a buildable library.
babelJest
falseUse babel instead of ts-jest.
compiler
tsctsc, swcThe compiler used by the build and test targets.
directory
A directory where the lib is placed
importPath
The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.
js
falseGenerate JavaScript files rather than TypeScript files.
linter
eslinteslint, tslintThe tool to use for running lint checks.
name
Library name
publishable
Create a publishable library.
pascalCaseFiles
falseUse pascal case file names.
rootDir
Sets the rootDir for TypeScript compilation. When not defined, it uses the project's root property, or srcRootForCompilationRoot if it is defined.
simpleModuleName
falseKeep the module name simple (when using --directory).
skipFormat
falseSkip formatting files.
skipTsConfig
falseDo not update tsconfig.base.json for development experience.
strict
falseWhether to enable tsconfig strict mode or not.
standaloneConfig
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json.
setParserOptionsProject
falseWhether or not to configure the ESLint parserOptions.project. We do not do this by default for lint performance reasons.
tags
Add tags to the library (used for linting).
testEnvironment
jsdomjsdom, nodeThe test environment to use if unitTestRunner is set to jest.
unitTestRunner
jestjest, noneTest runner to use for unit tests.