@nx/eslintSee schema

@nx/eslint:workspace-rule

Create a new Workspace Lint Rule.

This command will generate a new workspace lint rule called my-custom-rule. The new rule will be generated in tools/eslint-rules/rules folder:

❯

nx g @nx/eslint:workspace-rule my-custom-rule

Usage

1nx generate workspace-rule ... 2

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

You can specify the collection explicitly as follows:

1nx g @nx/eslint:workspace-rule ... 2

Show what will be generated without writing to disk:

1nx g workspace-rule ... --dry-run 2

Options

directory

dirRequired
string
Default: rules

Create the rule under this directory within tools/eslint-rules/ (can be nested).

name

Required
string

The name of the new rule.