@nx/nextSee schema

@nx/next:library

Create a React Library for an Nx workspace.

Examples

❯

nx g lib libs/my-lib

Usage

1nx generate library ... 2
1nx g lib ... #same 2

By 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 ... 2

Show what will be generated without writing to disk:

1nx g library ... --dry-run 2

Options

directory

dirRequired
string

A directory where the lib is placed.

linter

string
Default: eslint
Accepted values: eslint, none

The tool to use for running lint checks.

name

string
Pattern: (?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$

Library name

unitTestRunner

string
Default: vitest
Accepted values: vitest, jest, none

Test runner to use for unit tests.

appProject

a
string

The application project to add the library route to.

buildable

boolean
Default: false

Generate a buildable library.

component

boolean
Default: true

Generate a default component.

globalCss

boolean
Default: false

When 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: false

Generate JavaScript files rather than TypeScript files.

publishable

boolean

Create a publishable library.

routing

boolean

Generate library with routes.

style

s
string
Default: css

The file extension to be used for style files.

skipFormat

boolean
Default: false

Skip formatting files.

skipTsConfig

boolean
Default: false

Do not update tsconfig.json for development experience.

strict

boolean
Default: true

Whether to enable tsconfig strict mode or not.

setParserOptionsProject

boolean
Default: false

Whether 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).

skipPackageJson

Internal
boolean
Default: false

Do not add dependencies to package.json.