docs(misc): clean up api docs
This commit is contained in:
parent
baa8c23d0f
commit
93ebc835dc
@ -62,4 +62,4 @@ Default: `true`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Should the schematic update the import path to reflect the new location?
|
Should the generator update the import path to reflect the new location?
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g stories ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### name
|
### name
|
||||||
|
|
||||||
|
|||||||
@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic
|
Run the cypress-configure generator
|
||||||
|
|
||||||
### generateCypressSpecs
|
### generateCypressSpecs
|
||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### generateStories
|
### generateStories
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -90,7 +90,7 @@ Default: `false`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style)
|
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style)
|
||||||
|
|
||||||
### style
|
### style
|
||||||
|
|
||||||
|
|||||||
@ -38,13 +38,13 @@ Alias(es): d
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic description
|
Generator description
|
||||||
|
|
||||||
### name
|
### name
|
||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic name
|
Generator name
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -140,7 +140,7 @@ Default: `false`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style).
|
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).
|
||||||
|
|
||||||
### style
|
### style
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g stories ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic.
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator.
|
||||||
|
|
||||||
### js
|
### js
|
||||||
|
|
||||||
|
|||||||
@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic.
|
Run the cypress-configure generator.
|
||||||
|
|
||||||
### generateCypressSpecs
|
### generateCypressSpecs
|
||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### generateStories
|
### generateStories
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic
|
Run the cypress-configure generator
|
||||||
|
|
||||||
### js
|
### js
|
||||||
|
|
||||||
|
|||||||
@ -62,4 +62,4 @@ Default: `true`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Should the schematic update the import path to reflect the new location?
|
Should the generator update the import path to reflect the new location?
|
||||||
|
|||||||
@ -32,7 +32,7 @@ nx g workspace-generator ... --dry-run
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic name
|
Generator name
|
||||||
|
|
||||||
### skipFormat
|
### skipFormat
|
||||||
|
|
||||||
|
|||||||
@ -18,7 +18,7 @@ List the plugins installed in the current workspace:
|
|||||||
nx list
|
nx list
|
||||||
```
|
```
|
||||||
|
|
||||||
List the schematics and builders available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
|
List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
nx list @nrwl/web
|
nx list @nrwl/web
|
||||||
|
|||||||
@ -62,4 +62,4 @@ Default: `true`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Should the schematic update the import path to reflect the new location?
|
Should the generator update the import path to reflect the new location?
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g stories ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### name
|
### name
|
||||||
|
|
||||||
|
|||||||
@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic
|
Run the cypress-configure generator
|
||||||
|
|
||||||
### generateCypressSpecs
|
### generateCypressSpecs
|
||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### generateStories
|
### generateStories
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -90,7 +90,7 @@ Default: `false`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style)
|
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style)
|
||||||
|
|
||||||
### style
|
### style
|
||||||
|
|
||||||
|
|||||||
@ -38,13 +38,13 @@ Alias(es): d
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic description
|
Generator description
|
||||||
|
|
||||||
### name
|
### name
|
||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic name
|
Generator name
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -140,7 +140,7 @@ Default: `false`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style).
|
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).
|
||||||
|
|
||||||
### style
|
### style
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g stories ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic.
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator.
|
||||||
|
|
||||||
### js
|
### js
|
||||||
|
|
||||||
|
|||||||
@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic.
|
Run the cypress-configure generator.
|
||||||
|
|
||||||
### generateCypressSpecs
|
### generateCypressSpecs
|
||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### generateStories
|
### generateStories
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic
|
Run the cypress-configure generator
|
||||||
|
|
||||||
### js
|
### js
|
||||||
|
|
||||||
|
|||||||
@ -62,4 +62,4 @@ Default: `true`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Should the schematic update the import path to reflect the new location?
|
Should the generator update the import path to reflect the new location?
|
||||||
|
|||||||
@ -32,7 +32,7 @@ nx g workspace-generator ... --dry-run
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic name
|
Generator name
|
||||||
|
|
||||||
### skipFormat
|
### skipFormat
|
||||||
|
|
||||||
|
|||||||
@ -18,7 +18,7 @@ List the plugins installed in the current workspace:
|
|||||||
nx list
|
nx list
|
||||||
```
|
```
|
||||||
|
|
||||||
List the schematics and builders available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
|
List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
nx list @nrwl/web
|
nx list @nrwl/web
|
||||||
|
|||||||
@ -62,4 +62,4 @@ Default: `true`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Should the schematic update the import path to reflect the new location?
|
Should the generator update the import path to reflect the new location?
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g stories ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### name
|
### name
|
||||||
|
|
||||||
|
|||||||
@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic
|
Run the cypress-configure generator
|
||||||
|
|
||||||
### generateCypressSpecs
|
### generateCypressSpecs
|
||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### generateStories
|
### generateStories
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -44,7 +44,7 @@ Flag to indicate if a directory is created.
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
The name of generated schematic
|
The name of generated generator
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -90,7 +90,7 @@ Default: `false`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style)
|
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style)
|
||||||
|
|
||||||
### style
|
### style
|
||||||
|
|
||||||
|
|||||||
@ -38,13 +38,13 @@ Alias(es): d
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic description
|
Generator description
|
||||||
|
|
||||||
### name
|
### name
|
||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic name
|
Generator name
|
||||||
|
|
||||||
### project
|
### project
|
||||||
|
|
||||||
|
|||||||
@ -140,7 +140,7 @@ Default: `false`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style).
|
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).
|
||||||
|
|
||||||
### style
|
### style
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g stories ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic.
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator.
|
||||||
|
|
||||||
### js
|
### js
|
||||||
|
|
||||||
|
|||||||
@ -28,13 +28,13 @@ nx g storybook-configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic.
|
Run the cypress-configure generator.
|
||||||
|
|
||||||
### generateCypressSpecs
|
### generateCypressSpecs
|
||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure generator
|
||||||
|
|
||||||
### generateStories
|
### generateStories
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ nx g configuration ... --dry-run
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Run the cypress-configure schematic
|
Run the cypress-configure generator
|
||||||
|
|
||||||
### js
|
### js
|
||||||
|
|
||||||
|
|||||||
@ -62,4 +62,4 @@ Default: `true`
|
|||||||
|
|
||||||
Type: `boolean`
|
Type: `boolean`
|
||||||
|
|
||||||
Should the schematic update the import path to reflect the new location?
|
Should the generator update the import path to reflect the new location?
|
||||||
|
|||||||
@ -32,7 +32,7 @@ nx g workspace-generator ... --dry-run
|
|||||||
|
|
||||||
Type: `string`
|
Type: `string`
|
||||||
|
|
||||||
Schematic name
|
Generator name
|
||||||
|
|
||||||
### skipFormat
|
### skipFormat
|
||||||
|
|
||||||
|
|||||||
@ -18,7 +18,7 @@ List the plugins installed in the current workspace:
|
|||||||
nx list
|
nx list
|
||||||
```
|
```
|
||||||
|
|
||||||
List the schematics and builders available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
|
List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
nx list @nrwl/web
|
nx list @nrwl/web
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "SchematicsAngularModuleInit",
|
"id": "SchematicsAngularModuleInit",
|
||||||
"title": "Add Nx Schematics to Project and Convert Workspace",
|
"title": "Init Angular Plugin",
|
||||||
"description": "NOTE: Does not work in the --dry-run mode",
|
"description": "NOTE: Does not work in the --dry-run mode",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|||||||
@ -30,7 +30,7 @@
|
|||||||
},
|
},
|
||||||
"updateImportPath": {
|
"updateImportPath": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Should the schematic update the import path to reflect the new location?",
|
"description": "Should the generator update the import path to reflect the new location?",
|
||||||
"default": true
|
"default": true
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@ -14,7 +14,7 @@
|
|||||||
},
|
},
|
||||||
"generateCypressSpecs": {
|
"generateCypressSpecs": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure schematic"
|
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"required": ["name"]
|
"required": ["name"]
|
||||||
|
|||||||
@ -13,7 +13,7 @@
|
|||||||
},
|
},
|
||||||
"configureCypress": {
|
"configureCypress": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Run the cypress-configure schematic",
|
"description": "Run the cypress-configure generator",
|
||||||
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
|
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
|
||||||
},
|
},
|
||||||
"generateStories": {
|
"generateStories": {
|
||||||
@ -23,8 +23,8 @@
|
|||||||
},
|
},
|
||||||
"generateCypressSpecs": {
|
"generateCypressSpecs": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure schematic",
|
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator",
|
||||||
"x-prompt": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure schematic?"
|
"x-prompt": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator?"
|
||||||
},
|
},
|
||||||
"linter": {
|
"linter": {
|
||||||
"description": "The tool to use for running lint checks.",
|
"description": "The tool to use for running lint checks.",
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "Nx Cypress Project Schematics Schema",
|
"id": "Nx Cypress Project Generator Schema",
|
||||||
"title": "Create Cypress Configuration for the workspace",
|
"title": "Create Cypress Configuration for the workspace",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "NxExpressInit",
|
"id": "NxExpressInit",
|
||||||
"title": "Add Nx Express Schematics",
|
"title": "Init Express Plugin",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"unitTestRunner": {
|
"unitTestRunner": {
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "NxNestInit",
|
"id": "NxNestInit",
|
||||||
"title": "Add Nx Nest Schematics",
|
"title": "Init Nest Plugin",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"unitTestRunner": {
|
"unitTestRunner": {
|
||||||
|
|||||||
@ -6,7 +6,7 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"name": {
|
"name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The name of generated schematic",
|
"description": "The name of generated generator",
|
||||||
"$default": {
|
"$default": {
|
||||||
"$source": "argv",
|
"$source": "argv",
|
||||||
"index": 0
|
"index": 0
|
||||||
|
|||||||
@ -78,7 +78,7 @@
|
|||||||
"default": false
|
"default": false
|
||||||
},
|
},
|
||||||
"skipWorkspaceJson": {
|
"skipWorkspaceJson": {
|
||||||
"description": "Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style)",
|
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style)",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": false
|
"default": false
|
||||||
},
|
},
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "NxNextNgInit",
|
"id": "NxNextNgInit",
|
||||||
"title": "Add Nx Next Schematics",
|
"title": "Init Next Plugin",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"unitTestRunner": {
|
"unitTestRunner": {
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "NxNodeInit",
|
"id": "NxNodeInit",
|
||||||
"title": "Add Nx Node Schematics",
|
"title": "Init Node Plugin",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"unitTestRunner": {
|
"unitTestRunner": {
|
||||||
|
|||||||
@ -21,7 +21,7 @@
|
|||||||
},
|
},
|
||||||
"name": {
|
"name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Schematic name",
|
"description": "Generator name",
|
||||||
"$default": {
|
"$default": {
|
||||||
"$source": "argv",
|
"$source": "argv",
|
||||||
"index": 0
|
"index": 0
|
||||||
@ -30,7 +30,7 @@
|
|||||||
},
|
},
|
||||||
"description": {
|
"description": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Schematic description",
|
"description": "Generator description",
|
||||||
"alias": "d"
|
"alias": "d"
|
||||||
},
|
},
|
||||||
"unitTestRunner": {
|
"unitTestRunner": {
|
||||||
|
|||||||
@ -92,7 +92,7 @@
|
|||||||
"default": false
|
"default": false
|
||||||
},
|
},
|
||||||
"skipWorkspaceJson": {
|
"skipWorkspaceJson": {
|
||||||
"description": "Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style).",
|
"description": "Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": false
|
"default": false
|
||||||
},
|
},
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "NxReactNgInit",
|
"id": "NxReactNgInit",
|
||||||
"title": "Add Nx React Schematics",
|
"title": "Init React Plugin",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"unitTestRunner": {
|
"unitTestRunner": {
|
||||||
|
|||||||
@ -14,7 +14,7 @@
|
|||||||
},
|
},
|
||||||
"generateCypressSpecs": {
|
"generateCypressSpecs": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure schematic.",
|
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator.",
|
||||||
"x-prompt": "Do you want to generate Cypress specs as well?"
|
"x-prompt": "Do you want to generate Cypress specs as well?"
|
||||||
},
|
},
|
||||||
"js": {
|
"js": {
|
||||||
|
|||||||
@ -13,7 +13,7 @@
|
|||||||
},
|
},
|
||||||
"configureCypress": {
|
"configureCypress": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Run the cypress-configure schematic.",
|
"description": "Run the cypress-configure generator.",
|
||||||
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
|
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
|
||||||
},
|
},
|
||||||
"generateStories": {
|
"generateStories": {
|
||||||
@ -23,8 +23,8 @@
|
|||||||
},
|
},
|
||||||
"generateCypressSpecs": {
|
"generateCypressSpecs": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure schematic",
|
"description": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator",
|
||||||
"x-prompt": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure schematic?"
|
"x-prompt": "Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator?"
|
||||||
},
|
},
|
||||||
"js": {
|
"js": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
|
|||||||
@ -19,7 +19,7 @@
|
|||||||
},
|
},
|
||||||
"configureCypress": {
|
"configureCypress": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Run the cypress-configure schematic",
|
"description": "Run the cypress-configure generator",
|
||||||
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
|
"x-prompt": "Configure a cypress e2e app to run against the storybook instance?"
|
||||||
},
|
},
|
||||||
"linter": {
|
"linter": {
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "Nx Storybook Project Schematics Schema",
|
"id": "Init Storybook Plugin",
|
||||||
"title": "Add Storybook Configuration to the workspace",
|
"title": "Add Storybook Configuration to the workspace",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "NxWebInit",
|
"id": "NxWebInit",
|
||||||
"title": "Add Nx Web Schematics",
|
"title": "Init Web Plugin",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"unitTestRunner": {
|
"unitTestRunner": {
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "http://json-schema.org/schema",
|
"$schema": "http://json-schema.org/schema",
|
||||||
"id": "SchematicsNxNgAdd",
|
"id": "SchematicsNxNgAdd",
|
||||||
"title": "Add Nx Schematics to Project and Convert Workspace",
|
"title": "Init Workspace",
|
||||||
"description": "NOTE: Does not work in the --dry-run mode",
|
"description": "NOTE: Does not work in the --dry-run mode",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|||||||
@ -30,7 +30,7 @@
|
|||||||
},
|
},
|
||||||
"updateImportPath": {
|
"updateImportPath": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"description": "Should the schematic update the import path to reflect the new location?",
|
"description": "Should the generator update the import path to reflect the new location?",
|
||||||
"default": true
|
"default": true
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@ -1,17 +1,17 @@
|
|||||||
{
|
{
|
||||||
"cli": "nx",
|
"cli": "nx",
|
||||||
"id": "SchematicsNxWorkspaceSchematic",
|
"id": "SchematicsNxWorkspaceSchematic",
|
||||||
"title": "Create a custom schematic",
|
"title": "Create a custom generator",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"name": {
|
"name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Schematic name",
|
"description": "Generator name",
|
||||||
"$default": {
|
"$default": {
|
||||||
"$source": "argv",
|
"$source": "argv",
|
||||||
"index": 0
|
"index": 0
|
||||||
},
|
},
|
||||||
"x-prompt": "What name would you like to use for the workspace schematic?"
|
"x-prompt": "What name would you like to use for the workspace generator?"
|
||||||
},
|
},
|
||||||
"skipFormat": {
|
"skipFormat": {
|
||||||
"description": "Skip formatting files",
|
"description": "Skip formatting files",
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user