@nx/next:library
Create a React Library for an Nx workspace.
Examples
❯
nx g lib libs/my-lib
Usage
1nx generate library ...
21nx g lib ... #same
2By 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/next:library ...
2Show what will be generated without writing to disk:
1nx g library ... --dry-run
2Options
directory
dirRequired
string
A directory where the lib is placed.
name
string
Pattern:
(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$Library name
appProject
a
string
The application project to add the library route to.
buildable
boolean
Default:
falseGenerate a buildable library.
component
boolean
Default:
trueGenerate a default component.
globalCss
boolean
Default:
falseWhen true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is *.css rather than *.module.css).
importPath
string
The library name used to import it, like @myorg/my-awesome-lib.
js
boolean
Default:
falseGenerate JavaScript files rather than TypeScript files.
linter
string
Default:
eslintAccepted values:
eslintThe tool to use for running lint checks.
publishable
boolean
Create a publishable library.
routing
boolean
Generate library with routes.
style
s
string
Default:
cssThe file extension to be used for style files.
skipFormat
boolean
Default:
falseSkip formatting files.
skipTsConfig
boolean
Default:
falseDo not update tsconfig.json for development experience.
strict
boolean
Default:
trueWhether to enable tsconfig strict mode or not.
setParserOptionsProject
boolean
Default:
falseWhether or not to configure the ESLint parserOptions.project option. We do not do this by default for lint performance reasons.
tags
t
string
Add tags to the library (used for linting).
unitTestRunner
string
Default:
vitestAccepted values:
vitest, jest, noneTest runner to use for unit tests.
skipPackageJson
Internal
boolean
Default:
falseDo not add dependencies to package.json.