-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(nx-plugin): add new package for creating nx plugins
- Loading branch information
Showing
71 changed files
with
2,327 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ | |
"nest", | ||
"next", | ||
"node", | ||
"nx-plugin", | ||
"storybook", | ||
"web", | ||
"workspace" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,6 +7,7 @@ | |
"nest", | ||
"next", | ||
"node", | ||
"nx-plugin", | ||
"react", | ||
"storybook", | ||
"web", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ | |
"nest", | ||
"next", | ||
"node", | ||
"nx-plugin", | ||
"storybook", | ||
"web", | ||
"workspace" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,6 +7,7 @@ | |
"nest", | ||
"next", | ||
"node", | ||
"nx-plugin", | ||
"react", | ||
"storybook", | ||
"web", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Oops, something went wrong.