@nrwl/nx-plugin:create-package

Create a framework package that uses Nx CLI.

Usage

nx generate create-package ...

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

You can specify the collection explicitly as follows:

nx g @nrwl/nx-plugin:create-package ...

Show what will be generated without writing to disk:

nx g create-package ... --dry-run

Options

name

Required
string

The package name of cli, e.g. create-framework-package. Note this must be a valid NPM name to be published.

project

pRequired
string

The name of the generator project.

compiler

string
Default: tsc
Accepted values: tsc, swc

The compiler used by the build and test targets.

directory

string

A directory where the app is placed.

importPath

string

How the plugin will be published, like create-framework-app. Note this must be a valid NPM name. Will use name if not provided.

linter

string
Default: eslint
Accepted values: eslint

The tool to use for running lint checks.

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

unitTestRunner

string
Default: jest
Accepted values: jest, none

Test runner to use for unit tests.

skipFormat

boolean
Default: false

Skip formatting files.

skipTsConfig

boolean
Default: false

Do not update tsconfig.json for development experience.