library
Create a library
Usage
nx generate library ...nx g lib ... # sameBy default, Nx will search for
library in the default collection provisioned in angular.json.You can specify the collection explicitly as follows:
nx g @nrwl/workspace: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
Type:
stringA directory where the lib is placed
importPath
Type:
stringThe library name used to import it, like @myorg/my-awesome-lib
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.
setParserOptionsProject
Default:
falseType:
booleanWhether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
skipBabelrc
Default:
falseType:
booleanDo not generate .babelrc file. Useful for Node libraries that are not compiled by Babel
skipFormat
Default:
falseType:
booleanSkip formatting files
skipTsConfig
Default:
falseType:
booleanDo not update tsconfig.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
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