@nx/pluginSee schema

@nx/plugin:create-package

Create a framework package that uses Nx CLI.

Examples

Create an executable that initializes an Nx workspace with {my-plugin}'s preset:

1nx g @nx/plugin:create-package create-my-plugin --project my-plugin 2

Usage

1nx generate create-package ... 2

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

You can specify the collection explicitly as follows:

1nx g @nx/plugin:create-package ... 2

Show what will be generated without writing to disk:

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

Options

directory

Required
string

A directory where the app is placed.

name

Required
string
Pattern: create-.+|^@.+/create(?:-.+)?

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.

e2eProject

string

The name of the e2e project.

linter

string
Accepted values: none, eslint

The tool to use for running lint checks.

tags

t
string

Add tags to the library (used for linting).

unitTestRunner

string
Accepted values: none, jest, vitest

Test runner to use for unit tests.

useProjectJson

boolean

Use a project.json configuration file instead of inlining the Nx configuration in the package.json file.

skipFormat

Internal
boolean
Default: false

Skip formatting files.