@nx/workspace:npm-package

Add a minimal npm package.

Usage

1nx generate npm-package ... 2

By default, Nx will search for npm-package in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/workspace:npm-package ... 2

Show what will be generated without writing to disk:

1nx g npm-package ... --dry-run 2

Options

name

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

Package name.

directory

dir
string

A directory where the package is placed.

projectNameAndRootFormat

string
Accepted values: as-provided, derived

Whether to generate the project name and root directory as provided (as-provided) or generate them composing their values and taking the configured layout into account (derived).