71 lines
996 B
Markdown
71 lines
996 B
Markdown
---
|
|
title: '@nrwl/nx-plugin:generator generator'
|
|
description: 'Create a generator for an Nx Plugin'
|
|
---
|
|
|
|
# @nrwl/nx-plugin:generator
|
|
|
|
Create a generator for an Nx Plugin
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
nx generate generator ...
|
|
```
|
|
|
|
By default, Nx will search for `generator` in the default collection provisioned in `angular.json`.
|
|
|
|
You can specify the collection explicitly as follows:
|
|
|
|
```bash
|
|
nx g @nrwl/nx-plugin:generator ...
|
|
```
|
|
|
|
Show what will be generated without writing to disk:
|
|
|
|
```bash
|
|
nx g generator ... --dry-run
|
|
```
|
|
|
|
### Examples
|
|
|
|
Generate libs/my-plugin/src/generators/my-generator:
|
|
|
|
```bash
|
|
nx g generator my-generator --project=my-plugin
|
|
```
|
|
|
|
## Options
|
|
|
|
### name (_**required**_)
|
|
|
|
Type: `string`
|
|
|
|
Generator name
|
|
|
|
### project (_**required**_)
|
|
|
|
Alias(es): p
|
|
|
|
Type: `string`
|
|
|
|
The name of the project.
|
|
|
|
### description
|
|
|
|
Alias(es): d
|
|
|
|
Type: `string`
|
|
|
|
Generator description
|
|
|
|
### unitTestRunner
|
|
|
|
Default: `jest`
|
|
|
|
Type: `string`
|
|
|
|
Possible values: `jest`, `none`
|
|
|
|
Test runner to use for unit tests
|