Skip to content

Commit

Permalink
feat(nx-plugin): add new package for creating nx plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
Cammisuli authored and vsavkin committed Jan 21, 2020
1 parent ca69622 commit fe98e29
Show file tree
Hide file tree
Showing 71 changed files with 2,327 additions and 17 deletions.
1 change: 1 addition & 0 deletions .cz-config.js
Expand Up @@ -21,6 +21,7 @@ module.exports = {
{ name: 'docs', description: 'anything related to docs infrastructure' },
{ name: 'nextjs', description: 'anything Next specific' },
{ name: 'node', description: 'anything Node specific' },
{ name: 'nx-plugin', description: 'anything Nx Plugin specific' },
{ name: 'react', description: 'anything React specific' },
{ name: 'storybook', description: 'anything Storybook specific' },
{
Expand Down
25 changes: 25 additions & 0 deletions docs/angular/api-nx-plugin/builders/e2e.md
@@ -0,0 +1,25 @@
# e2e

Creates and runs an e2e for a Nx Plugin

Builder properties can be configured in angular.json when defining the builder, or when invoking it.

## Properties

### jestConfig

Type: `string`

Jest config file

### target

Type: `string`

the target Nx Plugin project and build

### tsSpecConfig

Type: `string`

Spec tsconfig file
91 changes: 91 additions & 0 deletions docs/angular/api-nx-plugin/schematics/plugin.md
@@ -0,0 +1,91 @@
# plugin

Create a Nx Plugin

## Usage

```bash
ng generate plugin ...
```

By default, Nx will search for `plugin` in the default collection provisioned in `angular.json`.

You can specify the collection explicitly as follows:

```bash
ng g @nrwl/nx-plugin:plugin ...
```

Show what will be generated without writing to disk:

```bash
ng g plugin ... --dry-run
```

### Examples

Generate libs/plugins/my-plugin:

```bash
ng g plugin my-plugin --directory=plugins
```

## Options

### directory

Alias(es): d

Type: `string`

A directory where the plugin is placed

### linter

Default: `tslint`

Type: `string`

Possible values: `eslint`, `tslint`

The tool to use for running lint checks.

### name

Type: `string`

Plugin name

### skipFormat

Default: `false`

Type: `boolean`

Skip formatting files

### skipTsConfig

Default: `false`

Type: `boolean`

Do not update tsconfig.json for development experience.

### tags

Alias(es): t

Type: `string`

Add tags to the library (used for linting)

### unitTestRunner

Default: `jest`

Type: `string`

Possible values: `jest`, `none`

Test runner to use for unit tests
1 change: 1 addition & 0 deletions docs/angular/builders.json
Expand Up @@ -6,6 +6,7 @@
"nest",
"next",
"node",
"nx-plugin",
"storybook",
"web",
"workspace"
Expand Down
1 change: 1 addition & 0 deletions docs/angular/schematics.json
Expand Up @@ -7,6 +7,7 @@
"nest",
"next",
"node",
"nx-plugin",
"react",
"storybook",
"web",
Expand Down
26 changes: 26 additions & 0 deletions docs/react/api-nx-plugin/builders/e2e.md
@@ -0,0 +1,26 @@
# e2e

Creates and runs an e2e for a Nx Plugin

Builder properties can be configured in workspace.json when defining the builder, or when invoking it.
Read more about how to use builders and the CLI here: https://nx.dev/react/guides/cli.

## Properties

### jestConfig

Type: `string`

Jest config file

### target

Type: `string`

the target Nx Plugin project and build

### tsSpecConfig

Type: `string`

Spec tsconfig file
91 changes: 91 additions & 0 deletions docs/react/api-nx-plugin/schematics/plugin.md
@@ -0,0 +1,91 @@
# plugin

Create a Nx Plugin

## Usage

```bash
nx generate plugin ...
```

By default, Nx will search for `plugin` in the default collection provisioned in `workspace.json`.

You can specify the collection explicitly as follows:

```bash
nx g @nrwl/nx-plugin:plugin ...
```

Show what will be generated without writing to disk:

```bash
nx g plugin ... --dry-run
```

### Examples

Generate libs/plugins/my-plugin:

```bash
nx g plugin my-plugin --directory=plugins
```

## Options

### directory

Alias(es): d

Type: `string`

A directory where the plugin is placed

### linter

Default: `tslint`

Type: `string`

Possible values: `eslint`, `tslint`

The tool to use for running lint checks.

### name

Type: `string`

Plugin name

### skipFormat

Default: `false`

Type: `boolean`

Skip formatting files

### skipTsConfig

Default: `false`

Type: `boolean`

Do not update tsconfig.json for development experience.

### tags

Alias(es): t

Type: `string`

Add tags to the library (used for linting)

### unitTestRunner

Default: `jest`

Type: `string`

Possible values: `jest`, `none`

Test runner to use for unit tests
1 change: 1 addition & 0 deletions docs/react/builders.json
Expand Up @@ -6,6 +6,7 @@
"nest",
"next",
"node",
"nx-plugin",
"storybook",
"web",
"workspace"
Expand Down
1 change: 1 addition & 0 deletions docs/react/schematics.json
Expand Up @@ -7,6 +7,7 @@
"nest",
"next",
"node",
"nx-plugin",
"react",
"storybook",
"web",
Expand Down
26 changes: 26 additions & 0 deletions docs/web/api-nx-plugin/builders/e2e.md
@@ -0,0 +1,26 @@
# e2e

Creates and runs an e2e for a Nx Plugin

Builder properties can be configured in workspace.json when defining the builder, or when invoking it.
Read more about how to use builders and the CLI here: https://nx.dev/web/guides/cli.

## Properties

### jestConfig

Type: `string`

Jest config file

### target

Type: `string`

the target Nx Plugin project and build

### tsSpecConfig

Type: `string`

Spec tsconfig file
91 changes: 91 additions & 0 deletions docs/web/api-nx-plugin/schematics/plugin.md
@@ -0,0 +1,91 @@
# plugin

Create a Nx Plugin

## Usage

```bash
nx generate plugin ...
```

By default, Nx will search for `plugin` in the default collection provisioned in `workspace.json`.

You can specify the collection explicitly as follows:

```bash
nx g @nrwl/nx-plugin:plugin ...
```

Show what will be generated without writing to disk:

```bash
nx g plugin ... --dry-run
```

### Examples

Generate libs/plugins/my-plugin:

```bash
nx g plugin my-plugin --directory=plugins
```

## Options

### directory

Alias(es): d

Type: `string`

A directory where the plugin is placed

### linter

Default: `tslint`

Type: `string`

Possible values: `eslint`, `tslint`

The tool to use for running lint checks.

### name

Type: `string`

Plugin name

### skipFormat

Default: `false`

Type: `boolean`

Skip formatting files

### skipTsConfig

Default: `false`

Type: `boolean`

Do not update tsconfig.json for development experience.

### tags

Alias(es): t

Type: `string`

Add tags to the library (used for linting)

### unitTestRunner

Default: `jest`

Type: `string`

Possible values: `jest`, `none`

Test runner to use for unit tests

0 comments on commit fe98e29

Please sign in to comment.