miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(nxdev): remove gitted docs (#8819)

Browse Source
This commit is contained in:
Benjamin Cabanes 2022-02-03 08:52:54 -05:00 committed by GitHub
parent babd4bdf8d
commit f62b7091d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
348 changed files with 17 additions and 34916 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -13,3 +13,4 @@ jest.debug.config.js
/.nx-cache /.nx-cache
/.verdaccio/build/local-registry /.verdaccio/build/local-registry
dep-graph/client/src/assets/environment.js dep-graph/client/src/assets/environment.js
/nx-dev/nx-dev/public/documentation

9
CONTRIBUTING.md
View File

@ -117,15 +117,14 @@ We would love for you to contribute to our documentation as well! Please feel we
#### Documentation Pages #### Documentation Pages
Our documentation pages can be found within this repo under the `docs` directory. Pages that we consider framework specific are nested in their own subdirectories - otherwise they should be nested within the `docs/shared` directory. Our documentation pages can be found within this repo under the `docs` directory.
The `docs/map.json` file is considered our source of truth for our site's structure, and should be updated when adding a new page to our documentation to ensure that it is included in the documentation site. We also run automated scripts based on this `map.json` data to safeguard against common human errors that could break our site. The `docs/map.json` file is considered our source of truth for our site's structure, and should be updated when adding a new page to our documentation to ensure that it is included in the documentation site. We also run automated scripts based on this `map.json` data to safeguard against common human errors that could break our site.
#### Nx-Dev Application #### Nx-Dev Application
Our public `nx.dev` documentation site is a [Next.js](https://nextjs.org/) application, that can be found in the `nx-dev` directory of this repo. Our public `nx.dev` documentation site is a [Next.js](https://nextjs.org/) application, that can be found in the `nx-dev` directory of this repo.
The documentation site is consuming the `docs/` directly by copy-ing its content while deploying, so the website is always in sync and reflects the latest version of `docs/`.
The `nx-dev/nx-dev/public/documentation` directory contains `.md` files that are generated from the `docs` directory when new releases are cut. As such, these should not be changed when submitting a change to existing docs.
Jump to [Running the Documentation Site Locally](#running-the-documentation-site-locally) to see how to preview your changes while serving. Jump to [Running the Documentation Site Locally](#running-the-documentation-site-locally) to see how to preview your changes while serving.
@ -153,10 +152,6 @@ npx nx serve nx-dev
You can then access the application locally at `localhost:4200`. You can then access the application locally at `localhost:4200`.
By default, the site displays the `Latest` cut release of the docs. To see your current changes in the docs be sure to select `Preview` from the version selection box of the site.
<img src="https://raw.githubusercontent.com/nrwl/nx/master/images/selecting-preview-from-version-selection-box.png" width="600" alt="Selecting Preview from Version Selection box">
#### Troubleshooting: `JavaScript heap out of memory` #### Troubleshooting: `JavaScript heap out of memory`
If you see an error that states: `FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory`, you need to [increase the max memory size of V8's old memory section](https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-megabytes): If you see an error that states: `FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory`, you need to [increase the max memory size of V8's old memory section](https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-megabytes):

BIN
images/selecting-preview-from-version-selection-box.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 131 KiB

11
nx-dev/nx-dev/next.config.js
View File

@ -1,5 +1,16 @@
// nx-ignore-next-line // nx-ignore-next-line
const withNx = require('@nrwl/next/plugins/with-nx'); const withNx = require('@nrwl/next/plugins/with-nx');
const { copy } = require('fs-extra');
const path = require('node:path');
/**
* TODO@ben: Temporary solution before Nextjs' assets management tasks is up and running
*/
copy(
path.resolve(__dirname + '/../../docs'),
path.resolve(__dirname + '/public/documentation'),
{ overwrite: true }
);
const redirects = { const redirects = {
'/core-concepts/configuration': '/configuration/projectjson', '/core-concepts/configuration': '/configuration/projectjson',

2
nx-dev/nx-dev/pages/_app.tsx
View File

@ -4,8 +4,8 @@ import Head from 'next/head';
import { useRouter } from 'next/router'; import { useRouter } from 'next/router';
import { DefaultSeo } from 'next-seo'; import { DefaultSeo } from 'next-seo';
import { sendPageViewEvent } from '@nrwl/nx-dev/feature-analytics'; import { sendPageViewEvent } from '@nrwl/nx-dev/feature-analytics';
import '../styles/main.css';
import Script from 'next/script'; import Script from 'next/script';
import '../styles/main.css';
export default function CustomApp({ Component, pageProps }: AppProps) { export default function CustomApp({ Component, pageProps }: AppProps) {
const router = useRouter(); const router = useRouter();

17
nx-dev/nx-dev/project.json
View File

@ -23,17 +23,6 @@
"command": "npx next-sitemap --config ./nx-dev/nx-dev/next-sitemap.js" "command": "npx next-sitemap --config ./nx-dev/nx-dev/next-sitemap.js"
} }
}, },
"serve": {
"executor": "@nrwl/workspace:run-commands",
"outputs": [],
"options": {
"commands": [
"npx ts-node -P ./scripts/tsconfig.scripts.json ./scripts/documentation/nx-dev-docs-latest-sync.ts --watch",
"nx run nx-dev:serve-nextjs"
],
"parallel": true
}
},
"sync-documentation": { "sync-documentation": {
"executor": "@nrwl/workspace:run-commands", "executor": "@nrwl/workspace:run-commands",
"outputs": ["nx-dev/nx-dev/public/documentation"], "outputs": ["nx-dev/nx-dev/public/documentation"],
@ -52,7 +41,7 @@
"production": {} "production": {}
} }
}, },
"serve-nextjs": { "serve": {
"executor": "@nrwl/next:server", "executor": "@nrwl/next:server",
"options": { "options": {
"buildTarget": "nx-dev:build-base", "buildTarget": "nx-dev:build-base",
@ -70,9 +59,7 @@
"outputs": ["nx-dev/nx-dev/public/documentation"], "outputs": ["nx-dev/nx-dev/public/documentation"],
"options": { "options": {
"commands": [ "commands": [
"rm -r nx-dev/nx-dev/public/documentation", "echo \"🛑️ REPLACE ME WITH STANDARD BUILD COMMAND 🛑\"",
"cp -R docs nx-dev/nx-dev/public/",
"mv nx-dev/nx-dev/public/docs nx-dev/nx-dev/public/documentation",
"nx run nx-dev:build" "nx run nx-dev:build"
], ],
"parallel": false "parallel": false

12
nx-dev/nx-dev/public/documentation/builders.json
View File

@ -1,12 +0,0 @@
[
"cypress",
"express",
"jest",
"linter",
"nest",
"node",
"storybook",
"web",
"workspace",
"js"
]

38
nx-dev/nx-dev/public/documentation/generated/api-angular/executors/delegate-build.md
View File

@ -1,38 +0,0 @@
---
title: '@nrwl/angular:delegate-build executor'
description: 'Delegates the build to a different target while supporting incremental builds.'
---
# @nrwl/angular:delegate-build
Delegates the build to a different target while supporting incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### buildTarget (_**required**_)
Type: `string`
Build target used for building the application after its dependencies have been built.
### outputPath (_**required**_)
Type: `string`
The full path for the output directory, relative to the workspace root.
### tsConfig (_**required**_)
Type: `string`
The full path for the TypeScript configuration file, relative to the workspace root.
### watch
Default: `false`
Type: `boolean`
Whether to run a build when any file changes.

56
nx-dev/nx-dev/public/documentation/generated/api-angular/executors/ng-packagr-lite.md
View File

@ -1,56 +0,0 @@
---
title: '@nrwl/angular:ng-packagr-lite executor'
description: 'Builds a library with support for incremental builds.'
---
# @nrwl/angular:ng-packagr-lite
Builds a library with support for incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### project (_**required**_)
Type: `string`
The file path for the ng-packagr configuration file, relative to the workspace root.
### buildableProjectDepsInPackageJsonType
Default: `peerDependencies`
Type: `string`
Possible values: `dependencies`, `peerDependencies`
When `updateBuildableProjectDepsInPackageJson` is `true`, this adds dependencies to either `peerDependencies` or `dependencies`.
### tailwindConfig
Type: `string`
The full path for the Tailwind configuration file, relative to the workspace root. If not provided and a `tailwind.config.js` file exists in the project or workspace root, it will be used. Otherwise, Tailwind will not be configured.
### tsConfig
Type: `string`
The full path for the TypeScript configuration file, relative to the workspace root.
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Whether to update the buildable project dependencies in package.json.
### watch
Default: `false`
Type: `boolean`
Whether to run a build when any file changes.

56
nx-dev/nx-dev/public/documentation/generated/api-angular/executors/package.md
View File

@ -1,56 +0,0 @@
---
title: '@nrwl/angular:package executor'
description: 'Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.'
---
# @nrwl/angular:package
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### project (_**required**_)
Type: `string`
The file path for the ng-packagr configuration file, relative to the workspace root.
### buildableProjectDepsInPackageJsonType
Default: `peerDependencies`
Type: `string`
Possible values: `dependencies`, `peerDependencies`
When `updateBuildableProjectDepsInPackageJson` is `true`, this adds dependencies to either `peerDependencies` or `dependencies`.
### tailwindConfig
Type: `string`
The full path for the Tailwind configuration file, relative to the workspace root. If not provided and a `tailwind.config.js` file exists in the project or workspace root, it will be used. Otherwise, Tailwind will not be configured.
### tsConfig
Type: `string`
The full path for the TypeScript configuration file, relative to the workspace root.
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Whether to update the buildable project dependencies in package.json.
### watch
Default: `false`
Type: `boolean`
Whether to run a build when any file changes.

300
nx-dev/nx-dev/public/documentation/generated/api-angular/executors/webpack-browser.md
View File

@ -1,300 +0,0 @@
---
title: '@nrwl/angular:webpack-browser executor'
description: 'Builds a browser application with support for incremental builds and custom webpack configuration.'
---
# @nrwl/angular:webpack-browser
Builds a browser application with support for incremental builds and custom webpack configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### index (_**required**_)
Type: `string`
Configures the generation of the application's HTML index.
### main (_**required**_)
Type: `string`
The full path for the main entry point to the app, relative to the current workspace.
### outputPath (_**required**_)
Type: `string`
The full path for the new output directory, relative to the current workspace.
By default, writes output to a folder named dist/ in the current project.
### tsConfig (_**required**_)
Type: `string`
The full path for the TypeScript configuration file, relative to the current workspace.
### allowedCommonJsDependencies
Type: `array`
A list of CommonJS packages that are allowed to be used without a build time warning.
### aot
Default: `true`
Type: `boolean`
Build using Ahead of Time compilation.
### assets
Type: `array`
List of static application assets.
### baseHref
Type: `string`
Base url for the application being built.
### budgets
Type: `array`
Budget thresholds to ensure parts of your application stay within boundaries which you set.
### buildOptimizer
Default: `true`
Type: `boolean`
Enables '@angular-devkit/build-optimizer' optimizations when using the 'aot' option.
### commonChunk
Default: `true`
Type: `boolean`
Generate a seperate bundle containing code used across multiple bundles.
### crossOrigin
Default: `none`
Type: `string`
Possible values: `none`, `anonymous`, `use-credentials`
Define the crossorigin attribute setting of elements that provide CORS support.
### deleteOutputPath
Default: `true`
Type: `boolean`
Delete the output path before building.
### ~~deployUrl~~
Type: `string`
**Deprecated:** Use "baseHref" option, "APP_BASE_HREF" DI token or a combination of both instead. For more information, see https://angular.io/guide/deployment#the-deploy-url.
URL where files will be deployed.
### extractLicenses
Default: `true`
Type: `boolean`
Extract all licenses in a separate file.
### fileReplacements
Type: `array`
Replace compilation source files with other compilation source files in the build.
### i18nMissingTranslation
Default: `warning`
Type: `string`
Possible values: `warning`, `error`, `ignore`
How to handle missing translations for i18n.
### inlineStyleLanguage
Default: `css`
Type: `string`
Possible values: `css`, `less`, `sass`, `scss`
The stylesheet language to use for the application's inline component styles.
### localize
Type: `boolean | boolean[] `
Translate the bundles in one or more locales.
### namedChunks
Default: `false`
Type: `boolean`
Use file name for lazy loaded chunks.
### ngswConfigPath
Type: `string`
Path to ngsw-config.json.
### optimization
Default: `true`
Type: `boolean`
Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code elimination, inlining of critical CSS and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-configuration.
### outputHashing
Default: `none`
Type: `string`
Possible values: `none`, `all`, `media`, `bundles`
Define the output filename cache-busting hashing mode.
### poll
Type: `number`
Enable and define the file watching poll time period in milliseconds.
### polyfills
Type: `string`
The full path for the polyfills file, relative to the current workspace.
### preserveSymlinks
Type: `boolean`
Do not use the real path when resolving modules. If unset then will default to `true` if NodeJS option --preserve-symlinks is set.
### progress
Default: `true`
Type: `boolean`
Log progress to the console while building.
### resourcesOutputPath
Type: `string`
The path where style resources will be placed, relative to outputPath.
### scripts
Type: `array`
Global scripts to be included in the build.
### serviceWorker
Default: `false`
Type: `boolean`
Generates a service worker config for production builds.
### ~~showCircularDependencies~~
Default: `false`
Type: `boolean`
**Deprecated:** The recommended method to detect circular dependencies in project code is to use either a lint rule or other external tooling.
Show circular dependency warnings on builds.
### sourceMap
Default: `false`
Type: `boolean`
Output source maps for scripts and styles. For more information, see https://angular.io/guide/workspace-config#source-map-configuration.
### statsJson
Default: `false`
Type: `boolean`
Generates a 'stats.json' file which can be analyzed using tools such as 'webpack-bundle-analyzer'.
### styles
Type: `array`
Global styles to be included in the build.
### subresourceIntegrity
Default: `false`
Type: `boolean`
Enables the use of subresource integrity validation.
### vendorChunk
Default: `false`
Type: `boolean`
Generate a seperate bundle containing only vendor libraries. This option should only used for development.
### verbose
Default: `false`
Type: `boolean`
Adds more details to output logging.
### watch
Default: `false`
Type: `boolean`
Run build when files change.
### webWorkerTsConfig
Type: `string`
TypeScript configuration for Web Worker modules.

132
nx-dev/nx-dev/public/documentation/generated/api-angular/executors/webpack-server.md
View File

@ -1,132 +0,0 @@
---
title: '@nrwl/angular:webpack-server executor'
description: 'Serves a browser application with support for a custom webpack configuration.'
---
# @nrwl/angular:webpack-server
Serves a browser application with support for a custom webpack configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### browserTarget (_**required**_)
Type: `string`
A browser builder target to serve in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`.
### allowedHosts
Type: `array`
List of hosts that are allowed to access the dev server.
### disableHostCheck
Default: `false`
Type: `boolean`
Don't verify connected clients are part of allowed hosts.
### hmr
Default: `false`
Type: `boolean`
Enable hot module replacement.
### host
Default: `localhost`
Type: `string`
Host to listen on.
### liveReload
Default: `true`
Type: `boolean`
Whether to reload the page on change, using live-reload.
### open
Alias(es): o
Default: `false`
Type: `boolean`
Opens the url in default browser.
### poll
Type: `number`
Enable and define the file watching poll time period in milliseconds.
### port
Default: `4200`
Type: `number`
Port to listen on.
### proxyConfig
Type: `string`
Proxy configuration file. For more information, see https://angular.io/guide/build#proxying-to-a-backend-server.
### publicHost
Type: `string`
The URL that the browser client (or live-reload client, if enabled) should use to connect to the development server. Use for a complex dev server setup, such as one with reverse proxies.
### servePath
Type: `string`
The pathname where the app will be served.
### ssl
Default: `false`
Type: `boolean`
Serve using HTTPS.
### sslCert
Type: `string`
SSL certificate to use for serving HTTPS.
### sslKey
Type: `string`
SSL key to use for serving HTTPS.
### verbose
Type: `boolean`
Adds more details to output logging.
### watch
Default: `true`
Type: `boolean`
Rebuild on change.

234
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/application.md
View File

@ -1,234 +0,0 @@
---
title: '@nrwl/angular:application generator'
description: 'Creates an Angular application.'
---
# @nrwl/angular:application
Creates an Angular application.
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the application.
### addTailwind
Default: `false`
Type: `boolean`
Whether to configure TailwindCSS for the application.
### backendProject
Type: `string`
Backend project that provides data to this application. This sets up `proxy.config.json`.
### directory
Type: `string`
The directory of the new application.
### e2eTestRunner
Default: `cypress`
Type: `string`
Possible values: `protractor`, `cypress`, `none`
Test runner to use for end to end (e2e) tests.
### host
Type: `string`
The name of the host application that the remote application will be consumed by.
### inlineStyle
Alias(es): s
Default: `false`
Type: `boolean`
Specifies if the style will be in the ts file.
### inlineTemplate
Alias(es): t
Default: `false`
Type: `boolean`
Specifies if the template will be in the ts file.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `none`
The tool to use for running lint checks.
### mfe
Default: `false`
Type: `boolean`
Generate a Module Federation configuration for the application
### mfeType
Default: `remote`
Type: `string`
Possible values: `host`, `remote`
Type of application to generate the Module Federation configuration for.
### port
Type: `number`
The port at which the remote application should be served.
### prefix
Alias(es): p
Type: `string`
The prefix to apply to generated selectors.
### remotes
Type: `array`
A list of remote application names that the host application should consume.
### routing
Default: `false`
Type: `boolean`
Generate a routing module.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to `package.json`.
### skipTests
Alias(es): S
Default: `false`
Type: `boolean`
Skip creating spec files.
### standaloneConfig
Type: `boolean`
Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.
### strict
Default: `true`
Type: `boolean`
Create an application with stricter type checking and build optimization options.
### style
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `sass`, `less`
The file extension to be used for style files.
### tags
Type: `string`
Add tags to the application (used for linting).
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `karma`, `jest`, `none`
Test runner to use for unit tests.
### viewEncapsulation
Type: `string`
Possible values: `Emulated`, `Native`, `None`
Specifies the view encapsulation strategy.

80
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/convert-tslint-to-eslint.md
View File

@ -1,80 +0,0 @@
---
title: '@nrwl/angular:convert-tslint-to-eslint generator'
description: 'Converts a project from TSLint to ESLint.'
---
# @nrwl/angular:convert-tslint-to-eslint
Converts a project from TSLint to ESLint.
## Usage
```bash
nx generate convert-tslint-to-eslint ...
```
By default, Nx will search for `convert-tslint-to-eslint` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:convert-tslint-to-eslint ...
```
Show what will be generated without writing to disk:
```bash
nx g convert-tslint-to-eslint ... --dry-run
```
### Examples
The following will first configure the project, `myapp`, the same way a _new_ project is configured i.e. It will use Nx's new recommended ESLint config. By default, this also adds the existing TSLint configuration on top of the default ESLint config from Nx to continue checking what it checks today. This is done by migrating TSLint rules to their equivalent ESLint rules to the best of its abilities. Some TSLint rules may not have ESLint equivalents and will be reported during the conversion:
```bash
nx g convert-tslint-to-eslint myapp
```
If your TSLint config isn't extremely important to you, ignoring it makes this process more deterministic. Unlike the prior example, this will discard the existing TSLint configuration, meaning that the project will only have the Nx's latest recommended ESLint configuration which may be good enough for some workspaces:
```bash
nx g convert-tslint-to-eslint myapp --ignoreExistingTslintConfig=true
```
By default, this process removes the TSLint related dependencies and configuration once no more projects use TSLint. This can be disabled with the following flag to keep TSLint related dependencies and configuration in the repo:
```bash
nx g convert-tslint-to-eslint myapp --removeTSLintIfNoMoreTSLintTargets=false
```
## Options
### project (_**required**_)
Type: `string`
The name of the Angular project to convert. Please note, if the project is an Angular app with an associated Cypress e2e project, it will also attempt to convert that.
### ignoreExistingTslintConfig
Default: `false`
Type: `boolean`
If true, it will not use existing TSLint config as a reference, it will just reset the project with the latest recommended ESLint config.
### removeTSLintIfNoMoreTSLintTargets
Default: `true`
Type: `boolean`
If this conversion leaves no more TSLint usage in the workspace, it will remove TSLint and related dependencies and configuration.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.

64
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/downgrade-module.md
View File

@ -1,64 +0,0 @@
---
title: '@nrwl/angular:downgrade-module generator'
description: 'Sets up a Downgrade Module.'
---
# @nrwl/angular:downgrade-module
Sets up a Downgrade Module.
## Usage
```bash
nx generate downgrade-module ...
```
By default, Nx will search for `downgrade-module` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:downgrade-module ...
```
Show what will be generated without writing to disk:
```bash
nx g downgrade-module ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the main AngularJS module.
### project (_**required**_)
Type: `string`
The name of the project.
### angularJsImport
Type: `string`
Import expression of the AngularJS application (e.g., `--angularJsImport=some_node_module/my_app`).
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add `@angular/upgrade` to `package.json` (e.g., `--skipPackageJson`).

44
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/karma-project.md
View File

@ -1,44 +0,0 @@
---
title: '@nrwl/angular:karma-project generator'
description: 'Adds Karma configuration to a project.'
---
# @nrwl/angular:karma-project
Adds Karma configuration to a project.
## Usage
```bash
nx generate karma-project ...
```
By default, Nx will search for `karma-project` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:karma-project ...
```
Show what will be generated without writing to disk:
```bash
nx g karma-project ... --dry-run
```
## Options
### project (_**required**_)
Type: `string`
The name of the project.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.

38
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/karma.md
View File

@ -1,38 +0,0 @@
---
title: '@nrwl/angular:karma generator'
description: 'Adds Karma configuration to a workspace.'
---
# @nrwl/angular:karma
Adds Karma configuration to a workspace.
## Usage
```bash
nx generate karma ...
```
By default, Nx will search for `karma` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:karma ...
```
Show what will be generated without writing to disk:
```bash
nx g karma ... --dry-run
```
## Options
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to `package.json`.

54
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/library-secondary-entry-point.md
View File

@ -1,54 +0,0 @@
---
title: '@nrwl/angular:library-secondary-entry-point generator'
description: 'Creates a secondary entry point for an Angular publishable library.'
---
# @nrwl/angular:library-secondary-entry-point
Creates a secondary entry point for an Angular publishable library.
## Usage
```bash
nx generate library-secondary-entry-point ...
```
```bash
nx g secondary-entry-point ... # same
```
By default, Nx will search for `library-secondary-entry-point` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:library-secondary-entry-point ...
```
Show what will be generated without writing to disk:
```bash
nx g library-secondary-entry-point ... --dry-run
```
## Options
### library (_**required**_)
Type: `string`
The name of the library to create the secondary entry point for.
### name (_**required**_)
Type: `string`
The name of the secondary entry point.
### skipModule
Default: `false`
Type: `boolean`
Skip generating a module for the secondary entry point.

210
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/library.md
View File

@ -1,210 +0,0 @@
---
title: '@nrwl/angular:library generator'
description: 'Creates an Angular library.'
---
# @nrwl/angular:library
Creates an Angular library.
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the library.
### addModuleSpec
Default: `false`
Type: `boolean`
Add a module spec file.
### addTailwind
Default: `false`
Type: `boolean`
Whether to configure TailwindCSS for the application. It can only be used with buildable and publishable libraries. Non-buildable libraries will use the application's Tailwind configuration.
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### compilationMode
Type: `string`
Possible values: `full`, `partial`
Specifies the compilation mode to use. If not specified, it will default to `partial` for publishable libraries and to `full` for buildable libraries. The `full` value can not be used for publishable libraries.
### directory
Type: `string`
A directory where the library is placed.
### importPath
Type: `string`
The library name used to import it, like `@myorg/my-awesome-lib`. Must be a valid npm name.
### lazy
Default: `false`
Type: `boolean`
Add `RouterModule.forChild` when set to true, and a simple array of routes when set to false.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `none`
The tool to use for running lint checks.
### parentModule
Type: `string`
Update the router configuration of the parent module using `loadChildren` or `children`, depending on what `lazy` is set to.
### prefix
Alias(es): p
Type: `string`
The prefix to apply to generated selectors.
### publishable
Default: `false`
Type: `boolean`
Generate a publishable library.
### routing
Default: `false`
Type: `boolean`
Add router configuration. See `lazy` for more information.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### simpleModuleName
Default: `false`
Type: `boolean`
Keep the module name simple (when using `--directory`).
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipModule
Default: `false`
Type: `boolean`
Whether to skip the creation of a default module when generating the library.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to `package.json`.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update `tsconfig.json` for development experience.
### standaloneConfig
Type: `boolean`
Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.
### strict
Default: `true`
Type: `boolean`
Create a library with stricter type checking and build optimization options.
### tags
Type: `string`
Add tags to the library (used for linting).
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `karma`, `jest`, `none`
Test runner to use for unit tests.

80
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/move.md
View File

@ -1,80 +0,0 @@
---
title: '@nrwl/angular:move generator'
description: 'Moves an Angular application or library to another folder within the workspace and updates the project configuration.'
---
# @nrwl/angular:move
Moves an Angular application or library to another folder within the workspace and updates the project configuration.
## Usage
```bash
nx generate move ...
```
```bash
nx g mv ... # same
```
By default, Nx will search for `move` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:move ...
```
Show what will be generated without writing to disk:
```bash
nx g move ... --dry-run
```
### Examples
Move libs/my-feature-lib to libs/shared/my-feature-lib:
```bash
nx g @nrwl/angular:move --project my-feature-lib shared/my-feature-lib
```
## Options
### destination (_**required**_)
Type: `string`
The folder to move the Angular project into.
### projectName (_**required**_)
Alias(es): project
Type: `string`
The name of the Angular project to move.
### importPath
Type: `string`
The new import path to use in the `tsconfig.base.json`.
### skipFormat
Alias(es): skip-format
Default: `false`
Type: `boolean`
Skip formatting files.
### updateImportPath
Default: `true`
Type: `boolean`
Update the import path to reflect the new location.

124
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/ngrx.md
View File

@ -1,124 +0,0 @@
---
title: '@nrwl/angular:ngrx generator'
description: 'Adds NgRx support to an application or library.'
---
# @nrwl/angular:ngrx
Adds NgRx support to an application or library.
## Usage
```bash
nx generate ngrx ...
```
By default, Nx will search for `ngrx` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:ngrx ...
```
Show what will be generated without writing to disk:
```bash
nx g ngrx ... --dry-run
```
## Options
### module (_**required**_)
Type: `string`
The path to the `NgModule` where the feature state will be registered. The host directory will create/use the new state directory.
### name (_**required**_)
Type: `string`
Name of the NgRx feature state, such as `products` or `users`. Recommended to use the plural form of the name.
### barrels
Default: `false`
Type: `boolean`
Use barrels to re-export actions, state and selectors.
### directory
Default: `+state`
Type: `string`
The name of the folder used to contain/group the generated NgRx files.
### facade
Default: `false`
Type: `boolean`
Create a Facade class for the the feature.
### minimal
Default: `true`
Type: `boolean`
Only register the root state management setup or feature state.
### root
Default: `false`
Type: `boolean`
Setup root or feature state management with NgRx.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipImport
Default: `false`
Type: `boolean`
Generate NgRx feature files without registering the feature in the NgModule.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not update the `package.json` with NgRx dependencies.
### syntax
Default: `creators`
Type: `string`
Possible values: `classes`, `creators`
Specifies whether to use class-based or creator functions for actions, reducers, and effects.
### useDataPersistence
Default: `false`
Type: `boolean`
Generate NgRx Effects with the `DataPersistence` helper service. Set to false to use plain effects data persistence operators.

94
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/scam-directive.md
View File

@ -1,94 +0,0 @@
---
title: '@nrwl/angular:scam-directive generator'
description: 'Generate a directive with an accompanying Single Component Angular Module (SCAM).'
---
# @nrwl/angular:scam-directive
Generate a directive with an accompanying Single Component Angular Module (SCAM).
## Usage
```bash
nx generate scam-directive ...
```
By default, Nx will search for `scam-directive` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:scam-directive ...
```
Show what will be generated without writing to disk:
```bash
nx g scam-directive ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the directive.
### export
Default: `false`
Type: `boolean`
Specifies if the SCAM should be exported from the project's entry point (normally `index.ts`). It only applies to libraries.
### flat
Default: `true`
Type: `boolean`
Create the new files at the top level of the current project.
### inlineScam
Default: `true`
Type: `boolean`
Create the NgModule in the same file as the Directive.
### path (**hidden**)
Type: `string`
The path at which to create the directive file, relative to the current workspace. Default is a folder with the same name as the directive in the project root.
### prefix
Alias(es): p
Type: `string`
The prefix to apply to the generated directive selector.
### project
Type: `string`
The name of the project.
### selector
Type: `string`
The HTML selector to use for this directive.
### skipTests
Default: `false`
Type: `boolean`
Do not create "spec.ts" test files for the new directive.

80
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/scam-pipe.md
View File

@ -1,80 +0,0 @@
---
title: '@nrwl/angular:scam-pipe generator'
description: 'Generate a pipe with an accompanying Single Component Angular Module (SCAM).'
---
# @nrwl/angular:scam-pipe
Generate a pipe with an accompanying Single Component Angular Module (SCAM).
## Usage
```bash
nx generate scam-pipe ...
```
By default, Nx will search for `scam-pipe` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:scam-pipe ...
```
Show what will be generated without writing to disk:
```bash
nx g scam-pipe ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the pipe.
### export
Default: `false`
Type: `boolean`
Specifies if the SCAM should be exported from the project's entry point (normally `index.ts`). It only applies to libraries.
### flat
Default: `true`
Type: `boolean`
Create the new files at the top level of the current project.
### inlineScam
Default: `true`
Type: `boolean`
Create the NgModule in the same file as the Pipe.
### path (**hidden**)
Type: `string`
The path at which to create the pipe file, relative to the current workspace. Default is a folder with the same name as the pipe in the project root.
### project
Type: `string`
The name of the project.
### skipTests
Default: `false`
Type: `boolean`
Do not create "spec.ts" test files for the new pipe.

172
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/scam.md
View File

@ -1,172 +0,0 @@
---
title: '@nrwl/angular:scam generator'
description: 'Generate a component with an accompanying Single Component Angular Module (SCAM).'
---
# @nrwl/angular:scam
Generate a component with an accompanying Single Component Angular Module (SCAM).
## Usage
```bash
nx generate scam ...
```
By default, Nx will search for `scam` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:scam ...
```
Show what will be generated without writing to disk:
```bash
nx g scam ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### changeDetection
Alias(es): c
Default: `Default`
Type: `string`
Possible values: `Default`, `OnPush`
The change detection strategy to use in the new component.
### displayBlock
Alias(es): b
Default: `false`
Type: `boolean`
Specifies if the style will contain `:host { display: block; }`.
### export
Default: `false`
Type: `boolean`
Specifies if the SCAM should be exported from the project's entry point (normally `index.ts`). It only applies to libraries.
### flat
Default: `false`
Type: `boolean`
Create the new files at the top level of the current project.
### inlineScam
Default: `true`
Type: `boolean`
Create the NgModule in the same file as the Component.
### inlineStyle
Alias(es): s
Default: `false`
Type: `boolean`
Include styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file.
### inlineTemplate
Alias(es): t
Default: `false`
Type: `boolean`
Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file.
### path (**hidden**)
Type: `string`
The path at which to create the component file, relative to the current workspace. Default is a folder with the same name as the component in the project root.
### prefix
Alias(es): p
Type: `string`
The prefix to apply to the generated component selector.
### project
Type: `string`
The name of the project.
### selector
Type: `string`
The HTML selector to use for this component.
### skipSelector
Default: `false`
Type: `boolean`
Specifies if the component should have a selector or not.
### skipTests
Default: `false`
Type: `boolean`
Do not create "spec.ts" test files for the new component.
### style
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `sass`, `less`, `none`
The file extension or preprocessor to use for style files, or 'none' to skip generating the style file.
### type
Default: `component`
Type: `string`
Adds a developer-defined type to the filename, in the format "name.type.ts".
### viewEncapsulation
Alias(es): v
Type: `string`
Possible values: `Emulated`, `None`, `ShadowDom`
The view encapsulation strategy to use in the new component.

84
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/setup-mfe.md
View File

@ -1,84 +0,0 @@
---
title: '@nrwl/angular:setup-mfe generator'
description: 'Generate a Module Federation configuration for a given Angular application.'
---
# @nrwl/angular:setup-mfe
Generate a Module Federation configuration for a given Angular application.
## Usage
```bash
nx generate setup-mfe ...
```
By default, Nx will search for `setup-mfe` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:setup-mfe ...
```
Show what will be generated without writing to disk:
```bash
nx g setup-mfe ... --dry-run
```
## Options
### appName (_**required**_)
Type: `string`
The name of the application to generate the Module Federation configuration for.
### mfeType (_**required**_)
Default: `remote`
Type: `string`
Possible values: `host`, `remote`
Type of application to generate the Module Federation configuration for.
### host
Type: `string`
The name of the host application that the remote application will be consumed by.
### port
Type: `number`
The port at which the remote application should be served.
### remotes
Type: `array`
A list of remote application names that the host application should consume.
### routing
Type: `boolean`
Generate a routing setup to allow a host application to route to the remote application.
### skipFormat
Type: `boolean`
Skip formatting the workspace after the generator completes.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to `package.json`.

64
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/setup-tailwind.md
View File

@ -1,64 +0,0 @@
---
title: '@nrwl/angular:setup-tailwind generator'
description: 'Configures TailwindCSS for an application or a buildable/publishable library.'
---
# @nrwl/angular:setup-tailwind
Configures TailwindCSS for an application or a buildable/publishable library.
## Usage
```bash
nx generate setup-tailwind ...
```
By default, Nx will search for `setup-tailwind` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:setup-tailwind ...
```
Show what will be generated without writing to disk:
```bash
nx g setup-tailwind ... --dry-run
```
## Options
### project (_**required**_)
Type: `string`
The name of the project to add the TailwindCSS setup for.
### buildTarget
Default: `build`
Type: `string`
The name of the target used to build the project. This option only applies to buildable/publishable libraries.
### skipFormat
Type: `boolean`
Skips formatting the workspace after the generator completes.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to `package.json`.
### stylesEntryPoint
Type: `string`
Path to the styles entry point relative to the workspace root. If not provided the generator will do its best to find it and it will error if it can't. This option only applies to applications.

48
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/stories.md
View File

@ -1,48 +0,0 @@
---
title: '@nrwl/angular:stories generator'
description: 'Creates stories/specs for all components declared in a project.'
---
# @nrwl/angular:stories
Creates stories/specs for all components declared in a project.
## Usage
```bash
nx generate stories ...
```
By default, Nx will search for `stories` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:stories ...
```
Show what will be generated without writing to disk:
```bash
nx g stories ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the project.
### cypressProject
Type: `string`
The Cypress project to generate the stories under. This is inferred from `name` by default.
### generateCypressSpecs
Type: `boolean`
Specifies whether to automatically generate `*.spec.ts` files in the Cypress e2e app generated by the `cypress-configure` generator.

76
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/storybook-configuration.md
View File

@ -1,76 +0,0 @@
---
title: '@nrwl/angular:storybook-configuration generator'
description: 'Adds Storybook configuration to a project.'
---
# @nrwl/angular:storybook-configuration
Adds Storybook configuration to a project.
## Usage
```bash
nx generate storybook-configuration ...
```
By default, Nx will search for `storybook-configuration` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:storybook-configuration ...
```
Show what will be generated without writing to disk:
```bash
nx g storybook-configuration ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the project.
### configureCypress
Default: `true`
Type: `boolean`
Specifies whether to configure Cypress or not.
### cypressDirectory
Type: `string`
A directory where the Cypress project will be placed. Placed at the root by default.
### generateCypressSpecs
Default: `true`
Type: `boolean`
Specifies whether to automatically generate `*.spec.ts` files in the generated Cypress e2e app.
### generateStories
Default: `true`
Type: `boolean`
Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `none`
The tool to use for running lint checks.

52
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/storybook-migrate-defaults-5-to-6.md
View File

@ -1,52 +0,0 @@
---
title: '@nrwl/angular:storybook-migrate-defaults-5-to-6 generator'
description: 'Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.'
---
# @nrwl/angular:storybook-migrate-defaults-5-to-6
Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.
## Usage
```bash
nx generate storybook-migrate-defaults-5-to-6 ...
```
By default, Nx will search for `storybook-migrate-defaults-5-to-6` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:storybook-migrate-defaults-5-to-6 ...
```
Show what will be generated without writing to disk:
```bash
nx g storybook-migrate-defaults-5-to-6 ... --dry-run
```
## Options
### all
Default: `true`
Type: `boolean`
Generate new Storybook configurations for all Storybook instances across all applications and libraries.
### keepOld
Default: `true`
Type: `boolean`
Keep the old configuration files by placing them in a folder called `.old_storybook`.
### name
Type: `string`
Library or application name for which you want to generate the new Storybook configuration. Leave empty to upgrade all Storybook instances. Only use this if you want to do a gradual migration.

28
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/storybook-migrate-stories-to-6-2.md
View File

@ -1,28 +0,0 @@
---
title: '@nrwl/angular:storybook-migrate-stories-to-6-2 generator'
description: 'Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export.'
---
# @nrwl/angular:storybook-migrate-stories-to-6-2
Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export.
## Usage
```bash
nx generate storybook-migrate-stories-to-6-2 ...
```
By default, Nx will search for `storybook-migrate-stories-to-6-2` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:storybook-migrate-stories-to-6-2 ...
```
Show what will be generated without writing to disk:
```bash
nx g storybook-migrate-stories-to-6-2 ... --dry-run
```

78
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/upgrade-module.md
View File

@ -1,78 +0,0 @@
---
title: '@nrwl/angular:upgrade-module generator'
description: 'Sets up an Upgrade Module.'
---
# @nrwl/angular:upgrade-module
Sets up an Upgrade Module.
## Usage
```bash
nx generate upgrade-module ...
```
By default, Nx will search for `upgrade-module` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:upgrade-module ...
```
Show what will be generated without writing to disk:
```bash
nx g upgrade-module ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the main AngularJS module.
### project (_**required**_)
Type: `string`
The name of the project.
### angularJsCmpSelector
Type: `string`
The selector of an AngularJS component (e.g., `--angularJsCmpSelector=myComponent`).
### angularJsImport
Type: `string`
Import expression of the AngularJS application (e.g., `--angularJsImport=some_node_module/my_app`).
### router
Default: `false`
Type: `boolean`
Sets up router synchronization (e.g., `--router`).
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add `@angular/upgrade` to `package.json` (e.g., `--skipPackageJson`).

64
nx-dev/nx-dev/public/documentation/generated/api-angular/generators/web-worker.md
View File

@ -1,64 +0,0 @@
---
title: '@nrwl/angular:web-worker generator'
description: 'Creates a Web Worker.'
---
# @nrwl/angular:web-worker
Creates a Web Worker.
## Usage
```bash
nx generate web-worker ...
```
By default, Nx will search for `web-worker` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:web-worker ...
```
Show what will be generated without writing to disk:
```bash
nx g web-worker ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the worker.
### project (_**required**_)
Type: `string`
The name of the project.
### path
Type: `string`
The path at which to create the worker file, relative to the current workspace.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### snippet
Default: `true`
Type: `boolean`
Add a worker creation snippet in a sibling file of the same name.

164
nx-dev/nx-dev/public/documentation/generated/api-cypress/executors/cypress.md
View File

@ -1,164 +0,0 @@
---
title: '@nrwl/cypress:cypress executor'
description: 'Run Cypress e2e tests'
---
# @nrwl/cypress:cypress
Run Cypress e2e tests
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### cypressConfig (_**required**_)
Type: `string`
The path of the Cypress configuration json file.
### baseUrl
Type: `string`
The address (with the port) which your application is running on
### browser
Type: `string`
The browser to run tests in.
### ciBuildId
Type: `string | number `
A unique identifier for a run to enable grouping or parallelization.
### ~~copyFiles~~
Type: `string`
**Deprecated:** A regex string that is used to choose what additional integration files to copy to the dist folder
### devServerTarget
Type: `string`
Dev server target to run tests against.
### exit
Default: `true`
Type: `boolean`
Whether or not the Cypress Test Runner will stay open after running tests in a spec file
### group
Type: `string`
A named group for recorded runs in the Cypress dashboard.
### headed
Default: `false`
Type: `boolean`
Displays the browser instead of running headlessly. Set this to 'true' if your run depends on a Chrome extension being loaded.
### ~~headless~~
Default: `false`
Type: `boolean`
**Deprecated:** Hide the browser instead of running headed (default for cypress run).
### ignoreTestFiles
Type: `string`
A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using https://globster.xyz to test what files would match.
### key
Type: `string`
The key cypress should use to run tests in parallel/record the run (CI only)
### parallel
Default: `false`
Type: `boolean`
Whether or not Cypress should run its tests in parallel (CI only)
### record
Default: `false`
Type: `boolean`
Whether or not Cypress should record the results of the tests
### reporter
Type: `string`
The reporter used during cypress run
### reporterOptions
Type: `string`
The reporter options used. Supported options depend on the reporter.
### skipServe
Default: `false`
Type: `boolean`
Skip dev-server build.
### spec
Type: `string`
A comma delimited glob string that is provided to the Cypress runner to specify which spec files to run. i.e. '**examples/**,**actions.spec**
### tag
Alias(es): t
Type: `string`
A comma delimited list to identify a run with
### testingType
Default: `e2e`
Type: `string`
Possible values: `component`, `e2e`
Specify the type of tests to execute
### tsConfig
Type: `string`
The path of the Cypress tsconfig configuration json file.
### watch
Default: `false`
Type: `boolean`
Recompile and run tests when files change.

102
nx-dev/nx-dev/public/documentation/generated/api-cypress/generators/cypress-project.md
View File

@ -1,102 +0,0 @@
---
title: '@nrwl/cypress:cypress-project generator'
description: 'Add a Cypress E2E Project'
---
# @nrwl/cypress:cypress-project
Add a Cypress E2E Project
## Usage
```bash
nx generate cypress-project ...
```
By default, Nx will search for `cypress-project` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/cypress:cypress-project ...
```
Show what will be generated without writing to disk:
```bash
nx g cypress-project ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
Name of the E2E Project
### baseUrl
Type: `string`
The address (with the port) which your application is running on
### directory
Type: `string`
A directory where the project is placed
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`, `none`
The tool to use for running lint checks.
### project
Type: `string`
The name of the frontend project to test.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to `package.json`.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json

28
nx-dev/nx-dev/public/documentation/generated/api-detox/executors/build.md
View File

@ -1,28 +0,0 @@
---
title: '@nrwl/detox:build executor'
description: 'Run the command defined in build property of the specified configuration.'
---
# @nrwl/detox:build
Run the command defined in build property of the specified configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### detoxConfiguration
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it

188
nx-dev/nx-dev/public/documentation/generated/api-detox/executors/test.md
View File

@ -1,188 +0,0 @@
---
title: '@nrwl/detox:test executor'
description: 'Initiating your detox test suite.'
---
# @nrwl/detox:test
Initiating your detox test suite.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### detoxConfiguration (_**required**_)
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it
### appLaunchArgs
Type: `number`
Custom arguments to pass (through) onto the app every time it is launched.
### artifactsLocation
Alias(es): a
Type: `string`
Artifacts (logs, screenshots, etc) root directory.
### buildTarget
Type: `string`
Target which builds the application
### captureViewHierarchy
Type: `string`
[iOS Only] Capture \*.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls.
### cleanup
Type: `boolean`
Shutdown simulator when test is over, useful for CI scripts, to make sure detox exists cleanly with no residue
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### debugSynchronization
Alias(es): d
Type: `string`
Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete.
### deviceLaunchArgs
Type: `string`
A list of passthrough-arguments to use when (if) devices (Android emulator / iOS simulator) are launched by Detox.
### deviceName
Alias(es): n
Type: `string`
Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.
### forceAdbInstall
Type: `boolean`
Due to problems with the adb install command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of adb install, instead.
### gpu
Type: `boolean`
[Android Only] Launch Emulator with the specific -gpu [gpu mode] parameter.
### headless
Type: `boolean`
Android Only] Launch Emulator in headless mode. Useful when running on CI.
### inspectBrk
Type: `boolean`
Uses node's --inspect-brk flag to let users debug the jest/mocha test runner
### jestReportSpecs
Type: `boolean`
[Jest Only] Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.
### loglevel
Alias(es): l
Type: `string`
Log level: fatal, error, warn, info, verbose, trace
### noColor
Type: `boolean`
Disable colors in log output
### recordLogs
Type: `string`
Save logs during each test to artifacts directory. Pass "failing" to save logs of failing tests only.
### recordPerformance
Type: `string`
[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.
### recordTimeline
Type: `string`
[Jest Only] Record tests and events timeline, for visual display on the chrome://tracing tool.
### recordVideos
Type: `string`
Save screen recordings of each test to artifacts directory. Pass "failing" to save recordings of failing tests only.
### retries
Type: `number`
[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or <N> times at least.
### reuse
Type: `boolean`
Reuse existing installed app (do not delete + reinstall) for a faster run.
### runnerConfig
Alias(es): o
Type: `string`
Test runner config file, defaults to 'e2e/mocha.opts' for mocha and 'e2e/config.json' for jest.
### takeScreenshots
Type: `string`
Save screenshots before and after each test to artifacts directory. Pass "failing" to save screenshots of failing tests only.
### useCustomLogger
Type: `boolean`
Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to node.js / test-runner's implementation (e.g. Jest / Mocha).
### workers
Type: `number`
Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest).

86
nx-dev/nx-dev/public/documentation/generated/api-detox/generators/application.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/detox:application generator'
description: 'Create a detox application'
---
# @nrwl/detox:application
Create a detox application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/detox:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
Name of the E2E Project
### project (_**required**_)
Type: `string`
The name of the frontend project to test.
### directory
Type: `string`
A directory where the project is placed
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`, `none`
The tool to use for running lint checks.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

134
nx-dev/nx-dev/public/documentation/generated/api-express/generators/application.md
View File

@ -1,134 +0,0 @@
---
title: '@nrwl/express:application generator'
description: 'Create an express application'
---
# @nrwl/express:application
Create an express application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/express:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### babelJest
Default: `false`
Type: `boolean`
Use babel instead ts-jest
### directory
Type: `string`
The directory of the new application.
### frontendProject
Type: `string`
Frontend project that needs to access this application. This sets up proxy configuration.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case file names.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to package.json.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### tags
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

244
nx-dev/nx-dev/public/documentation/generated/api-jest/executors/jest.md
View File

@ -1,244 +0,0 @@
---
title: '@nrwl/jest:jest executor'
description: 'Run Jest unit tests'
---
# @nrwl/jest:jest
Run Jest unit tests
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### jestConfig (_**required**_)
Type: `string`
The path of the Jest configuration. (https://jestjs.io/docs/en/configuration)
### bail
Alias(es): b
Type: `number | boolean `
Exit the test suite immediately after `n` number of failing tests. (https://jestjs.io/docs/cli#--bail)
### changedSince
Type: `string`
Runs tests related to the changes since the provided branch or commit hash. If the current branch has diverged from the given branch, then only changes made locally will be tested. (https://jestjs.io/docs/cli#--changedsince)
### ci
Type: `boolean`
Whether to run Jest in continuous integration (CI) mode. This option is on by default in most popular CI environments. It will prevent snapshots from being written unless explicitly requested. (https://jestjs.io/docs/cli#--ci)
### clearCache
Type: `boolean`
Deletes the Jest cache directory and then exits without running tests. Will delete Jest's default cache directory. _Note: clearing the cache will reduce performance_.
### codeCoverage
Alias(es): coverage
Type: `boolean`
Indicates that test coverage information should be collected and reported in the output. (https://jestjs.io/docs/cli#--coverageboolean)
### color
Alias(es): colors
Type: `boolean`
Forces test results output color highlighting (even if stdout is not a TTY). Set to false if you would like to have no colors. (https://jestjs.io/docs/cli#--colors)
### colors
Type: `boolean`
Forces test results output highlighting even if stdout is not a TTY. (https://jestjs.io/docs/cli#--colors)
### config
Type: `string`
The path to a Jest config file specifying how to find and execute tests. If no rootDir is set in the config, the directory containing the config file is assumed to be the rootDir for the project. This can also be a JSON-encoded value which Jest will use as configuration
### coverageDirectory
Type: `string`
The directory where Jest should output its coverage files.
### coverageReporters
Type: `array`
A list of reporter names that Jest uses when writing coverage reports. Any istanbul reporter
### detectOpenHandles
Type: `boolean`
Attempt to collect and print open handles preventing Jest from exiting cleanly (https://jestjs.io/docs/cli#--detectopenhandles)
### findRelatedTests
Type: `string`
Find and run the tests that cover a comma separated list of source files that were passed in as arguments. (https://jestjs.io/docs/cli#--findrelatedtests-spaceseparatedlistofsourcefiles)
### json
Type: `boolean`
Prints the test results in JSON. This mode will send all other test output and user messages to stderr. (https://jestjs.io/docs/cli#--json)
### maxWorkers
Alias(es): w
Type: `number | string `
Specifies the maximum number of workers the worker-pool will spawn for running tests. This defaults to the number of the cores available on your machine. Useful for CI. (its usually best not to override this default) (https://jestjs.io/docs/cli#--maxworkersnumstring)
### onlyChanged
Alias(es): o
Type: `boolean`
Attempts to identify which tests to run based on which files have changed in the current repository. Only works if you're running tests in a git or hg repository at the moment. (https://jestjs.io/docs/cli#--onlychanged)
### outputFile
Type: `string`
Write test results to a file when the --json option is also specified. (https://jestjs.io/docs/cli#--outputfilefilename)
### passWithNoTests
Type: `boolean`
Will not fail if no tests are found (for example while using `--testPathPattern`.) (https://jestjs.io/docs/cli#--passwithnotests)
### reporters
Type: `array`
Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple reporters: jest --reporters="default" --reporters="jest-junit" (https://jestjs.io/docs/cli#--reporters)
### runInBand
Alias(es): i
Type: `boolean`
Run all tests serially in the current process (rather than creating a worker pool of child processes that run tests). This is sometimes useful for debugging, but such use cases are pretty rare. Useful for CI. (https://jestjs.io/docs/cli#--runinband)
### ~~setupFile~~
Type: `string`
**Deprecated:** The name of a setup file used by Jest. (use Jest config file https://jestjs.io/docs/en/configuration#setupfilesafterenv-array)
### showConfig
Type: `boolean`
Print your Jest config and then exits. (https://jestjs.io/docs/en/cli#--showconfig)
### silent
Type: `boolean`
Prevent tests from printing messages through the console. (https://jestjs.io/docs/cli#--silent)
### testFile
Type: `string`
The name of the file to test.
### testLocationInResults
Type: `boolean`
Adds a location field to test results. Used to report location of a test in a reporter. { "column": 4, "line": 5 } (https://jestjs.io/docs/cli#--testlocationinresults)
### testNamePattern
Alias(es): t
Type: `string`
Run only tests with a name that matches the regex pattern. (https://jestjs.io/docs/cli#--testnamepatternregex)
### testPathIgnorePatterns
Type: `array`
An array of regexp pattern strings that is matched against all tests paths before executing the test. Only run those tests with a path that does not match with the provided regexp expressions. (https://jestjs.io/docs/cli#--testpathignorepatternsregexarray)
### testPathPattern
Type: `array`
An array of regexp pattern strings that is matched against all tests paths before executing the test. (https://jestjs.io/docs/cli#--testpathpatternregex)
### testResultsProcessor
Type: `string`
Node module that implements a custom results processor. (https://jestjs.io/docs/en/configuration#testresultsprocessor-string)
### testTimeout
Type: `number`
Default timeout of a test in milliseconds. Default value: 5000. (https://jestjs.io/docs/cli#--testtimeoutnumber)
### ~~tsConfig~~
Type: `string`
**Deprecated:** The name of the Typescript configuration file. Set the tsconfig option in the jest config file.
### updateSnapshot
Alias(es): u
Type: `boolean`
Use this flag to re-record snapshots. Can be used together with a test suite pattern or with `--testNamePattern` to re-record snapshot for test matching the pattern. (https://jestjs.io/docs/cli#--updatesnapshot)
### useStderr
Type: `boolean`
Divert all output to stderr.
### verbose
Type: `boolean`
Display individual test results with the test suite hierarchy. (https://jestjs.io/docs/cli#--verbose)
### watch
Type: `boolean`
Watch files for changes and rerun tests related to changed files. If you want to re-run all tests when a file has changed, use the `--watchAll` option. (https://jestjs.io/docs/cli#--watch)
### watchAll
Type: `boolean`
Watch files for changes and rerun all tests when something changes. If you want to re-run only the tests that depend on the changed files, use the `--watch` option. (https://jestjs.io/docs/cli#--watchall)

68
nx-dev/nx-dev/public/documentation/generated/api-js/executors/node.md
View File

@ -1,68 +0,0 @@
---
title: '@nrwl/js:node executor'
description: 'Build Node.js applications'
---
# @nrwl/js:node
Build Node.js applications
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### buildTarget (_**required**_)
Type: `string`
The target to run to build you the app
### args
Type: `array`
Extra args when starting the app
### host
Default: `localhost`
Type: `string`
The host to inspect the process on
### inspect
Default: `inspect`
Type: `string | boolean `
Ensures the app is starting with debugging
### port
Default: `9229`
Type: `number`
The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes.
### runtimeArgs
Type: `array`
Extra args passed to the node process
### waitUntilTargets
Type: `array`
The targets to run to before starting the node app
### watch
Default: `true`
Type: `boolean`
Enable re-building when files change.

58
nx-dev/nx-dev/public/documentation/generated/api-js/executors/swc.md
View File

@ -1,58 +0,0 @@
---
title: '@nrwl/js:swc executor'
description: 'Build a project using SWC'
---
# @nrwl/js:swc
Build a project using SWC
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### main (_**required**_)
Type: `string`
The name of the main entry-point file.
### outputPath (_**required**_)
Type: `string`
The output path of the generated files.
### tsConfig (_**required**_)
Type: `string`
The path to the Typescript configuration file.
### assets
Type: `array`
List of static assets.
### skipTypeCheck
Default: `false`
Type: `boolean`
Whether to skip TypeScript type checking.
### swcExclude
Type: `array`
List of SWC Glob/Regex to be excluded from compilation (https://swc.rs/docs/configuration/compilation#exclude)
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.

50
nx-dev/nx-dev/public/documentation/generated/api-js/executors/tsc.md
View File

@ -1,50 +0,0 @@
---
title: '@nrwl/js:tsc executor'
description: 'Build a project using TypeScript.'
---
# @nrwl/js:tsc
Build a project using TypeScript.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### main (_**required**_)
Type: `string`
The name of the main entry-point file.
### outputPath (_**required**_)
Type: `string`
The output path of the generated files.
### tsConfig (_**required**_)
Type: `string`
The path to the Typescript configuration file.
### assets
Type: `array`
List of static assets.
### transformers
Type: `array`
List of TypeScript Transformer Plugins.
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.

166
nx-dev/nx-dev/public/documentation/generated/api-js/generators/application.md
View File

@ -1,166 +0,0 @@
---
title: '@nrwl/js:application generator'
description: 'Create a application'
---
# @nrwl/js:application
Create a application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/js:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### compiler
Default: `tsc`
Type: `string`
Possible values: `tsc`, `swc`
The compiler used by the build and test targets
### config
Default: `project`
Type: `string`
Possible values: `workspace`, `project`, `npm-scripts`
Determines how whether the project's executors should be configured in workspace.json, project.json or as npm scripts
### directory
Type: `string`
A directory where the lib is placed
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `none`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case file names.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### strict
Default: `true`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### tags
Type: `string`
Add tags to the library (used for linting)
### testEnvironment
Default: `jsdom`
Type: `string`
Possible values: `jsdom`, `node`
The test environment to use if unitTestRunner is set to jest
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

54
nx-dev/nx-dev/public/documentation/generated/api-js/generators/convert-to-swc.md
View File

@ -1,54 +0,0 @@
---
title: '@nrwl/js:convert-to-swc generator'
description: 'Convert a tsc library to swc'
---
# @nrwl/js:convert-to-swc
Convert a tsc library to swc
## Usage
```bash
nx generate convert-to-swc ...
```
```bash
nx g swc ... # same
```
By default, Nx will search for `convert-to-swc` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/js:convert-to-swc ...
```
Show what will be generated without writing to disk:
```bash
nx g convert-to-swc ... --dry-run
```
### Examples
Convert libs/myapp/mylib to swc:
```bash
nx g swc mylib
```
## Options
### project (_**required**_)
Type: `string`
Library name
### targets
Type: `array`
List of targets to convert

182
nx-dev/nx-dev/public/documentation/generated/api-js/generators/library.md
View File

@ -1,182 +0,0 @@
---
title: '@nrwl/js:library generator'
description: 'Create a library'
---
# @nrwl/js:library
Create a library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/js:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### buildable
Default: `true`
Type: `boolean`
Generate a buildable library.
### compiler
Default: `tsc`
Type: `string`
Possible values: `tsc`, `swc`
The compiler used by the build and test targets
### config
Default: `project`
Type: `string`
Possible values: `workspace`, `project`, `npm-scripts`
Determines how whether the project's executors should be configured in workspace.json, project.json or as npm scripts
### directory
Type: `string`
A directory where the lib is placed
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `none`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case file names.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### skipTypeCheck
Default: `false`
Type: `boolean`
Whether to skip TypeScript type checking for SWC compiler.
### strict
Default: `true`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### tags
Type: `string`
Add tags to the library (used for linting)
### testEnvironment
Default: `jsdom`
Type: `string`
Possible values: `jsdom`, `node`
The test environment to use if unitTestRunner is set to jest
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

112
nx-dev/nx-dev/public/documentation/generated/api-linter/executors/eslint.md
View File

@ -1,112 +0,0 @@
---
title: '@nrwl/linter:eslint executor'
description: 'Run ESLint on a project'
---
# @nrwl/linter:eslint
Run ESLint on a project
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### lintFilePatterns (_**required**_)
Type: `array`
One or more files/dirs/globs to pass directly to ESLint's lintFiles() method.
### cache
Default: `false`
Type: `boolean`
Only check changed files.
### cacheLocation
Type: `string`
Path to the cache file or directory.
### eslintConfig
Type: `string`
The name of the ESLint configuration file.
### fix
Default: `false`
Type: `boolean`
Fixes linting errors (may overwrite linted files).
### force
Default: `false`
Type: `boolean`
Succeeds even if there was linting errors.
### format
Default: `stylish`
Type: `string`
ESLint Output formatter (https://eslint.org/docs/user-guide/formatters).
### hasTypeAwareRules
Type: `boolean`
When set to true, the linter will invalidate its cache when any of its dependencies changes.
### ignorePath
Type: `string`
The path of the .eslintignore file.
### maxWarnings
Default: `-1`
Type: `number`
Number of warnings to trigger nonzero exit code - default: -1
### noEslintrc
Default: `false`
Type: `boolean`
The equivalent of the --no-eslintrc flag on the ESLint CLI, it is false by default
### outputFile
Type: `string`
File to write report to.
### quiet
Default: `false`
Type: `boolean`
Report errors only - default: false
### silent
Default: `false`
Type: `boolean`
Hide output text.

114
nx-dev/nx-dev/public/documentation/generated/api-linter/executors/lint.md
View File

@ -1,114 +0,0 @@
---
title: '@nrwl/linter:lint executor'
description: '**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0'
---
# @nrwl/linter:lint
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### linter (_**required**_)
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### cache
Default: `false`
Type: `boolean`
Only check changed files.
### cacheLocation
Type: `string`
Path to the cache file or directory.
### config
Type: `string`
The name of the configuration file.
### exclude
Type: `array`
Files to exclude from linting.
### files
Type: `array`
Files to include in linting.
### fix
Default: `false`
Type: `boolean`
Fixes linting errors (may overwrite linted files).
### force
Default: `false`
Type: `boolean`
Succeeds even if there was linting errors.
### format
Default: `stylish`
Type: `string`
ESLint Output formatter (https://eslint.org/docs/user-guide/formatters).
### maxWarnings
Default: `-1`
Type: `number`
Number of warnings to trigger nonzero exit code - default: -1
### outputFile
Type: `string`
File to write report to.
### quiet
Default: `false`
Type: `boolean`
Report errors only - default: false
### silent
Default: `false`
Type: `boolean`
Hide output text.
### tsConfig
Type: `string | string[] `
The name of the TypeScript configuration file.

60
nx-dev/nx-dev/public/documentation/generated/api-linter/generators/workspace-rule.md
View File

@ -1,60 +0,0 @@
---
title: '@nrwl/linter:workspace-rule generator'
description: 'Create a new workspace ESLint rule'
---
# @nrwl/linter:workspace-rule
Create a new workspace ESLint rule
## Usage
```bash
nx generate workspace-rule ...
```
By default, Nx will search for `workspace-rule` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/linter:workspace-rule ...
```
Show what will be generated without writing to disk:
```bash
nx g workspace-rule ... --dry-run
```
### Examples
Create a new workspace lint rule called my-custom-rule:
```bash
nx g @nrwl/linter:workspace-rule my-custom-rule
```
Create a new workspace lint rule located at tools/eslint-rules/a/b/c/my-custom-rule.ts:
```bash
nx g @nrwl/linter:workspace-rule --name=my-custom-rule --directory=a/b/c
```
## Options
### directory (_**required**_)
Alias(es): dir
Default: `rules`
Type: `string`
Create the rule under this directory within tools/eslint-rules/ (can be nested).
### name (_**required**_)
Type: `string`
The name of the new rule

108
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/application.md
View File

@ -1,108 +0,0 @@
---
title: '@nrwl/nest:application generator'
description: 'Create a NestJS application.'
---
# @nrwl/nest:application
Create a NestJS application.
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the application.
### directory
Type: `string`
The directory of the new application.
### frontendProject
Type: `string`
Frontend project that needs to access this application. This sets up proxy configuration.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `none`
The tool to use for running lint checks.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to package.json.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json.
### tags
Type: `string`
Add tags to the application (used for linting).
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/class.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:class generator'
description: 'Run the `class` NestJS generator with Nx project support.'
---
# @nrwl/nest:class
Run the `class` NestJS generator with Nx project support.
## Usage
```bash
nx generate class ...
```
By default, Nx will search for `class` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:class ...
```
Show what will be generated without writing to disk:
```bash
nx g class ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the class.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest class language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

100
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/controller.md
View File

@ -1,100 +0,0 @@
---
title: '@nrwl/nest:controller generator'
description: 'Run the `controller` NestJS generator with Nx project support.'
---
# @nrwl/nest:controller
Run the `controller` NestJS generator with Nx project support.
## Usage
```bash
nx generate controller ...
```
By default, Nx will search for `controller` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:controller ...
```
Show what will be generated without writing to disk:
```bash
nx g controller ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the controller.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest controller language.
### module
Type: `string`
Allows specification of the declaring module.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipImport
Default: `false`
Type: `boolean`
Flag to skip the module import.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

68
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/convert-tslint-to-eslint.md
View File

@ -1,68 +0,0 @@
---
title: '@nrwl/nest:convert-tslint-to-eslint generator'
description: 'Convert a project from TSLint to ESLint.'
---
# @nrwl/nest:convert-tslint-to-eslint
Convert a project from TSLint to ESLint.
## Usage
```bash
nx generate convert-tslint-to-eslint ...
```
By default, Nx will search for `convert-tslint-to-eslint` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:convert-tslint-to-eslint ...
```
Show what will be generated without writing to disk:
```bash
nx g convert-tslint-to-eslint ... --dry-run
```
### Examples
Convert the NestJS project `myapp` from TSLint to ESLint:
```bash
nx g convert-tslint-to-eslint myapp
```
## Options
### project (_**required**_)
Type: `string`
The name of the NestJS project to convert.
### ignoreExistingTslintConfig
Default: `false`
Type: `boolean`
If true we will not use existing TSLint config as a reference, we will just reset the project with the latest recommended ESLint config.
### removeTSLintIfNoMoreTSLintTargets
Default: `true`
Type: `boolean`
If this conversion leaves no more TSLint usage in the workspace, it will remove TSLint and related dependencies and configuration.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.

76
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/decorator.md
View File

@ -1,76 +0,0 @@
---
title: '@nrwl/nest:decorator generator'
description: 'Run the `decorator` NestJS generator with Nx project support.'
---
# @nrwl/nest:decorator
Run the `decorator` NestJS generator with Nx project support.
## Usage
```bash
nx generate decorator ...
```
By default, Nx will search for `decorator` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:decorator ...
```
Show what will be generated without writing to disk:
```bash
nx g decorator ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the decorator.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest decorator language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/filter.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:filter generator'
description: 'Run the `filter` NestJS generator with Nx project support.'
---
# @nrwl/nest:filter
Run the `filter` NestJS generator with Nx project support.
## Usage
```bash
nx generate filter ...
```
By default, Nx will search for `filter` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:filter ...
```
Show what will be generated without writing to disk:
```bash
nx g filter ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the filter.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest filter language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/gateway.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:gateway generator'
description: 'Run the `gateway` NestJS generator with Nx project support.'
---
# @nrwl/nest:gateway
Run the `gateway` NestJS generator with Nx project support.
## Usage
```bash
nx generate gateway ...
```
By default, Nx will search for `gateway` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:gateway ...
```
Show what will be generated without writing to disk:
```bash
nx g gateway ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the gateway.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest gateway language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/guard.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:guard generator'
description: 'Run the `guard` NestJS generator with Nx project support.'
---
# @nrwl/nest:guard
Run the `guard` NestJS generator with Nx project support.
## Usage
```bash
nx generate guard ...
```
By default, Nx will search for `guard` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:guard ...
```
Show what will be generated without writing to disk:
```bash
nx g guard ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the guard.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest guard language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/interceptor.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:interceptor generator'
description: 'Run the `interceptor` NestJS generator with Nx project support.'
---
# @nrwl/nest:interceptor
Run the `interceptor` NestJS generator with Nx project support.
## Usage
```bash
nx generate interceptor ...
```
By default, Nx will search for `interceptor` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:interceptor ...
```
Show what will be generated without writing to disk:
```bash
nx g interceptor ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the interceptor.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest interceptor language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

68
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/interface.md
View File

@ -1,68 +0,0 @@
---
title: '@nrwl/nest:interface generator'
description: 'Run the `interface` NestJS generator with Nx project support.'
---
# @nrwl/nest:interface
Run the `interface` NestJS generator with Nx project support.
## Usage
```bash
nx generate interface ...
```
By default, Nx will search for `interface` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:interface ...
```
Show what will be generated without writing to disk:
```bash
nx g interface ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the interface.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.

186
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/library.md
View File

@ -1,186 +0,0 @@
---
title: '@nrwl/nest:library generator'
description: 'Create a new NestJS library.'
---
# @nrwl/nest:library
Create a new NestJS library.
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name.
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### controller
Default: `false`
Type: `boolean`
Include a controller with the library.
### directory
Alias(es): dir
Type: `string`
A directory where the library is placed.
### global
Default: `false`
Type: `boolean`
Add the Global decorator to the generated module.
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `none`
The tool to use for running lint checks.
### publishable
Type: `boolean`
Create a publishable library.
### service
Default: `false`
Type: `boolean`
Include a service with the library.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.base.json for development experience.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### strict
Default: `false`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### tags
Alias(es): t
Type: `string`
Add tags to the library (used for linting).
### target
Default: `es6`
Type: `string`
Possible values: `es5`, `es6`, `esnext`, `es2015`, `es2016`, `es2017`, `es2018`, `es2019`, `es2020`
The ES target, Nest suggest using es6 or higher.
### testEnvironment
Default: `node`
Type: `string`
Possible values: `jsdom`, `node`
The test environment for jest, for node applications this should stay as node unless doing DOM testing.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/middleware.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:middleware generator'
description: 'Run the `middleware` NestJS generator with Nx project support.'
---
# @nrwl/nest:middleware
Run the `middleware` NestJS generator with Nx project support.
## Usage
```bash
nx generate middleware ...
```
By default, Nx will search for `middleware` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:middleware ...
```
Show what will be generated without writing to disk:
```bash
nx g middleware ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the middleware.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest middleware language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

90
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/module.md
View File

@ -1,90 +0,0 @@
---
title: '@nrwl/nest:module generator'
description: 'Run the `module` NestJS generator with Nx project support.'
---
# @nrwl/nest:module
Run the `module` NestJS generator with Nx project support.
## Usage
```bash
nx generate module ...
```
By default, Nx will search for `module` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:module ...
```
Show what will be generated without writing to disk:
```bash
nx g module ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the module.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest module language.
### module
Type: `string`
The path to import the module.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipImport
Default: `false`
Type: `boolean`
Flag to skip the module import.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/pipe.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:pipe generator'
description: 'Run the `pipe` NestJS generator with Nx project support.'
---
# @nrwl/nest:pipe
Run the `pipe` NestJS generator with Nx project support.
## Usage
```bash
nx generate pipe ...
```
By default, Nx will search for `pipe` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:pipe ...
```
Show what will be generated without writing to disk:
```bash
nx g pipe ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the pipe.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest pipe language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/provider.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:provider generator'
description: 'Run the `provider` NestJS generator with Nx project support.'
---
# @nrwl/nest:provider
Run the `provider` NestJS generator with Nx project support.
## Usage
```bash
nx generate provider ...
```
By default, Nx will search for `provider` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:provider ...
```
Show what will be generated without writing to disk:
```bash
nx g provider ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the provider.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `true`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest provider language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/resolver.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:resolver generator'
description: 'Run the `resolver` NestJS generator with Nx project support.'
---
# @nrwl/nest:resolver
Run the `resolver` NestJS generator with Nx project support.
## Usage
```bash
nx generate resolver ...
```
By default, Nx will search for `resolver` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:resolver ...
```
Show what will be generated without writing to disk:
```bash
nx g resolver ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the resolver.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest resolver language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

112
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/resource.md
View File

@ -1,112 +0,0 @@
---
title: '@nrwl/nest:resource generator'
description: 'Run the `resource` NestJS generator with Nx project support.'
---
# @nrwl/nest:resource
Run the `resource` NestJS generator with Nx project support.
## Usage
```bash
nx generate resource ...
```
By default, Nx will search for `resource` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:resource ...
```
Show what will be generated without writing to disk:
```bash
nx g resource ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the resource.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### crud
Default: `true`
Type: `boolean`
When true, CRUD entry points are generated.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest class language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipImport
Default: `false`
Type: `boolean`
Flag to skip the module import.
### type
Default: `rest`
Type: `string`
Possible values: `rest`, `graphql-code-first`, `graphql-schema-first`, `microservice`, `ws`
The transport layer.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

86
nx-dev/nx-dev/public/documentation/generated/api-nest/generators/service.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/nest:service generator'
description: 'Run the `service` NestJS generator with Nx project support.'
---
# @nrwl/nest:service
Run the `service` NestJS generator with Nx project support.
## Usage
```bash
nx generate service ...
```
By default, Nx will search for `service` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nest:service ...
```
Show what will be generated without writing to disk:
```bash
nx g service ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
The name of the service.
### project (_**required**_)
Alias(es): p
Type: `string`
The Nest project to target.
### directory
Alias(es): dir,path
Type: `string`
Directory where the generated files are placed.
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### language
Type: `string`
Possible values: `js`, `ts`
Nest service language.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

56
nx-dev/nx-dev/public/documentation/generated/api-next/executors/build.md
View File

@ -1,56 +0,0 @@
---
title: '@nrwl/next:build executor'
description: 'Build a Next.js app'
---
# @nrwl/next:build
Build a Next.js app
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### outputPath (_**required**_)
Type: `string`
The output path of the generated files.
### root (_**required**_)
Type: `string`
The source root
### buildLibsFromSource
Default: `true`
Type: `boolean`
Read buildable libraries from source instead of building them separately.
### fileReplacements
Type: `object[]`
Replace files with other files in the build.
#### replace
Type: `string`
The file to be replaced.
#### with
Type: `string`
The file to replace with.
### nextConfig
Type: `string`
Path (relative to workspace root) to a function which takes phase, config, and builder options, and returns the resulting config. This is an advanced option and should not be used with a normal Next.js config file (i.e. next.config.js).

40
nx-dev/nx-dev/public/documentation/generated/api-next/executors/export.md
View File

@ -1,40 +0,0 @@
---
title: '@nrwl/next:export executor'
description: 'Export a Next.js app. The exported application is located at dist/$outputPath/exported.'
---
# @nrwl/next:export
Export a Next.js app. The exported application is located at dist/$outputPath/exported.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### buildLibsFromSource
Default: `true`
Type: `boolean`
Read buildable libraries from source instead of building them separately.
### buildTarget
Type: `string`
Target which builds the application
### silent
Default: `false`
Type: `boolean`
Hide progress or not (default is false)
### threads
Type: `number`
Number of worker threads to utilize (defaults to the number of CPUs)

76
nx-dev/nx-dev/public/documentation/generated/api-next/executors/server.md
View File

@ -1,76 +0,0 @@
---
title: '@nrwl/next:server executor'
description: 'Serve a Next.js app'
---
# @nrwl/next:server
Serve a Next.js app
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### buildTarget (_**required**_)
Type: `string`
Target which builds the application
### buildLibsFromSource
Default: `true`
Type: `boolean`
Read buildable libraries from source instead of building them separately.
### customServerPath
Type: `string`
Use a custom server script
### dev
Default: `true`
Type: `boolean`
Serve the application in the dev mode
### hostname
Type: `string`
Hostname on which the application is served.
### port
Default: `4200`
Type: `number`
Port to listen on.
### proxyConfig
Type: `string`
Path to the proxy configuration file.
### quiet
Default: `false`
Type: `boolean`
Hide error messages containing server information.
### staticMarkup
Default: `false`
Type: `boolean`
Static markup.

158
nx-dev/nx-dev/public/documentation/generated/api-next/generators/application.md
View File

@ -1,158 +0,0 @@
---
title: '@nrwl/next:application generator'
description: 'Create a Next.js application'
---
# @nrwl/next:application
Create a Next.js application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/next:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
### Examples
Generate apps/myorg/myapp and apps/myorg/myapp-e2e:
```bash
nx g app myapp --directory=myorg
```
## Options
### directory
Alias(es): d
Type: `string`
The directory of the new application.
### e2eTestRunner
Default: `cypress`
Type: `string`
Possible values: `cypress`, `none`
Test runner to use for end to end (e2e) tests
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### server
Type: `string`
The server script path to be used with next.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipWorkspaceJson
Default: `false`
Type: `boolean`
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style)
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### style
Alias(es): s
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `styled-jsx`
The file extension to be used for style files.
### swc
Default: `true`
Type: `boolean`
Enable the Rust-based compiler SWC to compile JS/TS files.
### tags
Alias(es): t
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

112
nx-dev/nx-dev/public/documentation/generated/api-next/generators/component.md
View File

@ -1,112 +0,0 @@
---
title: '@nrwl/next:component generator'
description: 'Create a React component'
---
# @nrwl/next:component
Create a React component
## Usage
```bash
nx generate component ...
```
By default, Nx will search for `component` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/next:component ...
```
Show what will be generated without writing to disk:
```bash
nx g component ... --dry-run
```
### Examples
Generate a component in the mylib library:
```bash
nx g component my-component --project=mylib
```
Generate a class component in the mylib library:
```bash
nx g component my-component --project=mylib --classComponent
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### directory
Alias(es): dir
Type: `string`
Create the component under this directory (can be nested).
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the component is exported from the project index.ts (if it exists).
### flat
Default: `false`
Type: `boolean`
Create component at the source root rather than its own directory.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### skipTests
Default: `false`
Type: `boolean`
When true, does not create "spec.ts" test files for the new component.
### style
Alias(es): s
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `styled-jsx`
The file extension to be used for style files.

106
nx-dev/nx-dev/public/documentation/generated/api-next/generators/page.md
View File

@ -1,106 +0,0 @@
---
title: '@nrwl/next:page generator'
description: 'Create a Next.js page component'
---
# @nrwl/next:page
Create a Next.js page component
## Usage
```bash
nx generate page ...
```
By default, Nx will search for `page` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/next:page ...
```
Show what will be generated without writing to disk:
```bash
nx g page ... --dry-run
```
### Examples
Generate a page in the my-app application:
```bash
nx nx g page my-new-page --project=my-app
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### directory
Alias(es): dir
Type: `string`
Create the page under this directory (can be nested). Will be created under 'pages/'.
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the component is exported from the project index.ts (if it exists).
### flat
Default: `false`
Type: `boolean`
Create component at the source root rather than its own directory.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### style
Alias(es): s
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `styled-jsx`, `none`
The file extension to be used for style files.
### withTests
Default: `false`
Type: `boolean`
When true, creates a "spec.ts" test file for the new page.

188
nx-dev/nx-dev/public/documentation/generated/api-node/executors/build.md
View File

@ -1,188 +0,0 @@
---
title: '@nrwl/node:build executor'
description: 'Build a Node application'
---
# @nrwl/node:build
Build a Node application
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### main (_**required**_)
Type: `string`
The name of the main entry-point file.
### tsConfig (_**required**_)
Type: `string`
The name of the Typescript configuration file.
### additionalEntryPoints
Type: `object[]`
#### entryName
Type: `string`
Name of the additional entry file
#### entryPath
Type: `string`
Path to the additional entry file
### assets
Type: `array`
List of static application assets.
### buildLibsFromSource
Default: `true`
Type: `boolean`
Read buildable libraries from source instead of building them separately.
### externalDependencies
Default: `all`
Type: `string | string[] `
Dependencies to keep external to the bundle. ("all" (default), "none", or an array of module names)
### extractLicenses
Default: `false`
Type: `boolean`
Extract all licenses in a separate file, in the case of production builds only.
### fileReplacements
Type: `object[]`
Replace files with other files in the build.
#### replace
Type: `string`
The file to be replaced.
#### with
Type: `string`
The file to replace with.
### generatePackageJson
Default: `false`
Type: `boolean`
Generates a package.json file with the project's node_module dependencies populated for installing in a container. If a package.json exists in the project's directory, it will be reused with dependencies populated.
### maxWorkers
Type: `number`
Number of workers to use for type checking. (defaults to # of CPUS - 2)
### memoryLimit
Type: `number`
Memory limit for type checking service process in MB. (defaults to 2048)
### optimization
Default: `false`
Type: `boolean`
Defines the optimization level of the build.
### outputFileName
Default: `main.js`
Type: `string`
Name of the main output file. (defaults to 'main.js')
### outputPath
Type: `string`
The output path of the generated files.
### poll
Type: `number`
Frequency of file watcher in ms.
### progress
Default: `false`
Type: `boolean`
Log progress to the console while building.
### sourceMap
Default: `true`
Type: `boolean`
Produce source maps.
### statsJson
Default: `false`
Type: `boolean`
Generates a 'stats.json' file which can be analyzed using tools such as: 'webpack-bundle-analyzer' or <https://webpack.github.io/analyse>.
### tsPlugins
Type: `array`
List of TypeScript Compiler Plugins.
### verbose
Default: `false`
Type: `boolean`
Emits verbose output
### watch
Default: `false`
Type: `boolean`
Run build when files change.
### webpackConfig
Type: `array[] | string `
Path to a function which takes a webpack config, context and returns the resulting webpack config

68
nx-dev/nx-dev/public/documentation/generated/api-node/executors/execute.md
View File

@ -1,68 +0,0 @@
---
title: '@nrwl/node:execute executor'
description: 'Execute a Node application'
---
# @nrwl/node:execute
Execute a Node application
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### buildTarget (_**required**_)
Type: `string`
The target to run to build you the app
### args
Type: `array`
Extra args when starting the app
### host
Default: `localhost`
Type: `string`
The host to inspect the process on
### inspect
Default: `inspect`
Type: `string | boolean `
Ensures the app is starting with debugging
### port
Default: `9229`
Type: `number`
The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes.
### runtimeArgs
Type: `array`
Extra args passed to the node process
### waitUntilTargets
Type: `array`
The targets to run to before starting the node app
### watch
Default: `true`
Type: `boolean`
Run build when files change

102
nx-dev/nx-dev/public/documentation/generated/api-node/executors/package.md
View File

@ -1,102 +0,0 @@
---
title: '@nrwl/node:package executor'
description: 'Package a Node library'
---
# @nrwl/node:package
Package a Node library
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### main (_**required**_)
Type: `string`
The name of the main entry-point file.
### tsConfig (_**required**_)
Type: `string`
The name of the Typescript configuration file.
### assets
Type: `array`
List of static library assets.
### buildableProjectDepsInPackageJsonType
Default: `dependencies`
Type: `string`
Possible values: `dependencies`, `peerDependencies`
When updateBuildableProjectDepsInPackageJson is true, this adds dependencies to either `peerDependencies` or `dependencies`
### cli
Type: `boolean`
Adds a CLI wrapper to main entry-point file.
### deleteOutputPath
Default: `true`
Type: `boolean`
Delete the output path before building.
### outputPath
Type: `string`
The output path of the generated files.
### packageJson
Type: `string`
The name of the package.json file
### sourceMap
Default: `true`
Type: `boolean`
Output sourcemaps.
### srcRootForCompilationRoot
Type: `string`
Sets the rootDir for TypeScript compilation. When not defined, it uses the project's root property
### tsPlugins
Type: `array`
List of TypeScript Compiler Plugins.
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Update buildable project dependencies in package.json
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.

134
nx-dev/nx-dev/public/documentation/generated/api-node/generators/application.md
View File

@ -1,134 +0,0 @@
---
title: '@nrwl/node:application generator'
description: 'Create a node application'
---
# @nrwl/node:application
Create a node application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/node:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### babelJest
Default: `false`
Type: `boolean`
Use babel instead ts-jest
### directory
Type: `string`
The directory of the new application.
### frontendProject
Type: `string`
Frontend project that needs to access this application. This sets up proxy configuration.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case file names.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to package.json.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### tags
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

194
nx-dev/nx-dev/public/documentation/generated/api-node/generators/library.md
View File

@ -1,194 +0,0 @@
---
title: '@nrwl/node:library generator'
description: 'Create a library'
---
# @nrwl/node:library
Create a library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/node:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### babelJest
Default: `false`
Type: `boolean`
Use babel instead ts-jest
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### directory
Alias(es): dir
Type: `string`
A directory where the lib is placed
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib. Must be a valid npm name.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case file names.
### publishable
Type: `boolean`
Create a publishable library.
### rootDir
Alias(es): srcRootForCompilationRoot
Type: `string`
Sets the rootDir for TypeScript compilation. When not defined, it uses the project's root property, or srcRootForCompilationRoot if it is defined.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### simpleModuleName
Default: `false`
Type: `boolean`
Keep the module name simple (when using --directory)
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.base.json for development experience.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### strict
Default: `false`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### tags
Alias(es): t
Type: `string`
Add tags to the library (used for linting)
### testEnvironment
Default: `jsdom`
Type: `string`
Possible values: `jsdom`, `node`
The test environment to use if unitTestRunner is set to jest
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

1646
nx-dev/nx-dev/public/documentation/generated/api-nx-devkit/index.md
View File

File diff suppressed because it is too large Load Diff

118
nx-dev/nx-dev/public/documentation/generated/api-nx-devkit/ngcli_adapter.md
View File

@ -1,118 +0,0 @@
# Module: ngcli-adapter
## Table of contents
### Ng CLI Adapter Classes
- [NxScopedHost](../../nx-devkit/ngcli_adapter#nxscopedhost)
### Functions
- [mockSchematicsForTesting](../../nx-devkit/ngcli_adapter#mockschematicsfortesting)
- [overrideCollectionResolutionForTesting](../../nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
- [wrapAngularDevkitSchematic](../../nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
## Ng CLI Adapter Classes
### NxScopedHost
• **NxScopedHost**: `Object`
## Functions
### mockSchematicsForTesting
▸ **mockSchematicsForTesting**(`schematics`): `void`
If you have an Nx Devkit generator invoking the wrapped Angular Devkit schematic,
and you don't want the Angular Devkit schematic to run, you can mock it up using this function.
Unfortunately, there are some edge cases in the Nx-Angular devkit integration that
can be seen in the unit tests context. This function is useful for handling that as well.
In this case, you can mock it up.
Example:
```typescript
mockSchematicsForTesting({
'mycollection:myschematic': (tree, params) => {
tree.write('README.md');
},
});
```
#### Parameters
| Name | Type |
| :----------- | :------- |
| `schematics` | `Object` |
#### Returns
`void`
---
### overrideCollectionResolutionForTesting
▸ **overrideCollectionResolutionForTesting**(`collections`): `void`
By default, Angular Devkit schematic collections will be resolved using the Node resolution.
This doesn't work if you are testing schematics that refer to other schematics in the
same repo.
This function can can be used to override the resolution behaviour.
Example:
```typescript
overrideCollectionResolutionForTesting({
'@nrwl/workspace': path.join(
__dirname,
'../../../../workspace/generators.json'
),
'@nrwl/angular': path.join(__dirname, '../../../../angular/generators.json'),
'@nrwl/linter': path.join(__dirname, '../../../../linter/generators.json'),
});
```
#### Parameters
| Name | Type |
| :------------ | :------- |
| `collections` | `Object` |
#### Returns
`void`
---
### wrapAngularDevkitSchematic
▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
#### Parameters
| Name | Type |
| :--------------- | :------- |
| `collectionName` | `string` |
| `generatorName` | `string` |
#### Returns
`fn`
▸ (`host`, `generatorOptions`): `Promise`<`any`\>
##### Parameters
| Name | Type |
| :----------------- | :----------------------------------- |
| `host` | [`Tree`](../../nx-devkit/index#tree) |
| `generatorOptions` | `Object` |
##### Returns
`Promise`<`any`\>

32
nx-dev/nx-dev/public/documentation/generated/api-nx-plugin/executors/e2e.md
View File

@ -1,32 +0,0 @@
---
title: '@nrwl/nx-plugin:e2e executor'
description: 'Creates and runs the e2e tests for an Nx Plugin.'
---
# @nrwl/nx-plugin:e2e
Creates and runs the e2e tests for an Nx Plugin.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### jestConfig (_**required**_)
Type: `string`
Jest config file.
### target (_**required**_)
Type: `string`
The build target for the Nx Plugin project.
### ~~tsSpecConfig~~
Type: `string`
**Deprecated:** Use the `tsconfig` property for `ts-jest` in the e2e project `jest.config.js` file. It will be removed in the next major release.
The tsconfig file for specs.

70
nx-dev/nx-dev/public/documentation/generated/api-nx-plugin/generators/executor.md
View File

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

70
nx-dev/nx-dev/public/documentation/generated/api-nx-plugin/generators/generator.md
View File

@ -1,70 +0,0 @@
---
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 `workspace.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

78
nx-dev/nx-dev/public/documentation/generated/api-nx-plugin/generators/migration.md
View File

@ -1,78 +0,0 @@
---
title: '@nrwl/nx-plugin:migration generator'
description: 'Create a migration for an Nx Plugin'
---
# @nrwl/nx-plugin:migration
Create a migration for an Nx Plugin
## Usage
```bash
nx generate migration ...
```
By default, Nx will search for `migration` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/nx-plugin:migration ...
```
Show what will be generated without writing to disk:
```bash
nx g migration ... --dry-run
```
### Examples
Generate libs/my-plugin/src/migrations/my-migration:
```bash
nx g migration my-migration --project=my-plugin --version=1.0.0
```
## Options
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### version (_**required**_)
Alias(es): v
Type: `string`
Version to use for the migration
### description
Alias(es): d
Type: `string`
Migration description
### name
Type: `string`
Migration name
### packageJsonUpdates
Alias(es): p
Default: `false`
Type: `boolean`
Whether or not to include package.json updates

116
nx-dev/nx-dev/public/documentation/generated/api-nx-plugin/generators/plugin.md
View File

@ -1,116 +0,0 @@
---
title: '@nrwl/nx-plugin:plugin generator'
description: 'Create a Nx Plugin'
---
# @nrwl/nx-plugin: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 --importPath=@myorg/my-plugin
```
## Options
### name (_**required**_)
Type: `string`
Plugin name
### directory
Alias(es): d
Type: `string`
A directory where the plugin is placed
### importPath
Type: `string`
How the plugin will be published, like @myorg/my-awesome-plugin. Note this must be a valid npm name
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### 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

18
nx-dev/nx-dev/public/documentation/generated/api-react-native/executors/build-android.md
View File

@ -1,18 +0,0 @@
---
title: '@nrwl/react-native:build-android executor'
description: 'Release Build for Android.'
---
# @nrwl/react-native:build-android
Release Build for Android.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### apk
Type: `boolean`
Generate apk file(s) rather than a bundle (.aab).

50
nx-dev/nx-dev/public/documentation/generated/api-react-native/executors/bundle.md
View File

@ -1,50 +0,0 @@
---
title: '@nrwl/react-native:bundle executor'
description: 'Builds the JavaScript bundle for offline use.'
---
# @nrwl/react-native:bundle
Builds the JavaScript bundle for offline use.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### bundleOutput (_**required**_)
Type: `string`
The output path of the generated files.
### entryFile (_**required**_)
Type: `string`
The entry file relative to project root.
### platform (_**required**_)
Type: `string`
Platform to build for (ios, android).
### dev
Default: `true`
Type: `boolean`
Generate a development build.
### maxWorkers
Type: `number`
The number of workers we should parallelize the transformer on.
### sourceMap
Type: `boolean`
Whether source maps should be generated or not.

10
nx-dev/nx-dev/public/documentation/generated/api-react-native/executors/ensure-symlink.md
View File

@ -1,10 +0,0 @@
---
title: '@nrwl/react-native:ensure-symlink executor'
description: "Ensure workspace node_modules is symlink under app's node_modules folder."
---
# @nrwl/react-native:ensure-symlink
Ensure workspace node_modules is symlink under app's node_modules folder.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.

98
nx-dev/nx-dev/public/documentation/generated/api-react-native/executors/run-android.md
View File

@ -1,98 +0,0 @@
---
title: '@nrwl/react-native:run-android executor'
description: 'Runs Android application.'
---
# @nrwl/react-native:run-android
Runs Android application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### appId
Type: `string`
Specify an applicationId to launch after build. If not specified, 'package' from AndroidManifest.xml will be used.
### appIdSuffix
Type: `string`
Specify an applicationIdSuffix to launch after build.
### deviceId
Type: `string`
Builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).
### jetifier
Default: `true`
Type: `boolean`
Run jetifier – the AndroidX transition tool. By default it runs before Gradle to ease working with libraries that don't support AndroidX yet.
### mainActivity
Default: `MainActivity`
Type: `string`
Name of the activity to start.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### resetCache
Default: `false`
Type: `boolean`
Resets metro cache
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink).
### tasks
Type: `string`
Run custom gradle tasks. If this argument is provided, then --variant option is ignored. Example: yarn react-native run-android --tasks clean,installDebug.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### variant
Default: `debug`
Type: `string`
Specify your app's build variant (e.g. debug, release).

86
nx-dev/nx-dev/public/documentation/generated/api-react-native/executors/run-ios.md
View File

@ -1,86 +0,0 @@
---
title: '@nrwl/react-native:run-ios executor'
description: 'Runs iOS application.'
---
# @nrwl/react-native:run-ios
Runs iOS application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### device
Type: `string`
Explicitly set device to use by name. The value is not required if you have a single device connected.
### install
Default: `true`
Type: `boolean`
Runs 'pod install' for native modules before building iOS app.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### resetCache
Default: `false`
Type: `boolean`
Resets metro cache
### scheme
Type: `string`
Explicitly set the Xcode scheme to use
### simulator
Default: `iPhone X`
Type: `string`
Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: "iPhone X (12.1)"
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink). Always true when --install is used.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### xcodeConfiguration
Default: `Debug`
Type: `string`
Explicitly set the Xcode configuration to use

28
nx-dev/nx-dev/public/documentation/generated/api-react-native/executors/start.md
View File

@ -1,28 +0,0 @@
---
title: '@nrwl/react-native:start executor'
description: 'Starts the Javascript server that communicates with connected devices.'
---
# @nrwl/react-native:start
Starts the Javascript server that communicates with connected devices.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### port
Default: `8081`
Type: `number`
The port to listen on.
### resetCache
Default: `false`
Type: `boolean`
Resets metro cache.

18
nx-dev/nx-dev/public/documentation/generated/api-react-native/executors/sync-deps.md
View File

@ -1,18 +0,0 @@
---
title: '@nrwl/react-native:sync-deps executor'
description: 'Syncs dependencies to package.json (required for autolinking).'
---
# @nrwl/react-native:sync-deps
Syncs dependencies to package.json (required for autolinking).
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.
## Options
### include
Type: `string`
A comma-separated list of additional npm packages to include. e.g. 'nx sync-deps --include=react-native-gesture-handler,react-native-safe-area-context'

130
nx-dev/nx-dev/public/documentation/generated/api-react-native/generators/application.md
View File

@ -1,130 +0,0 @@
---
title: '@nrwl/react-native:application generator'
description: 'Create a React Native application'
---
# @nrwl/react-native:application
Create a React Native application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
### Examples
Generate apps/nested/myapp:
```bash
nx g app myapp --directory=nested
```
Use class components instead of functional components:
```bash
nx g app myapp --classComponent
```
## Options
### directory
Alias(es): d
Type: `string`
The directory of the new application.
### displayName
Type: `string`
The display name to show in the application. Defaults to name.
### e2eTestRunner
Default: `detox`
Type: `string`
Possible values: `detox`, `none`
Adds the specified e2e test runner
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### tags
Alias(es): t
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

124
nx-dev/nx-dev/public/documentation/generated/api-react-native/generators/component.md
View File

@ -1,124 +0,0 @@
---
title: '@nrwl/react-native:component generator'
description: 'Create a React Native component'
---
# @nrwl/react-native:component
Create a React Native component
## Usage
```bash
nx generate component ...
```
```bash
nx g c ... # same
```
By default, Nx will search for `component` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:component ...
```
Show what will be generated without writing to disk:
```bash
nx g component ... --dry-run
```
### Examples
Generate a component in the mylib library:
```bash
nx g component my-component --project=mylib
```
Generate a class component in the mylib library:
```bash
nx g component my-component --project=mylib --classComponent
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### classComponent
Alias(es): C
Default: `false`
Type: `boolean`
Use class components instead of functional component.
### directory
Alias(es): d
Type: `string`
Create the component under this directory (can be nested).
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the component is exported from the project index.ts (if it exists).
### flat
Default: `false`
Type: `boolean`
Create component at the source root rather than its own directory.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### skipTests
Default: `false`
Type: `boolean`
When true, does not create "spec.ts" test files for the new component.

162
nx-dev/nx-dev/public/documentation/generated/api-react-native/generators/library.md
View File

@ -1,162 +0,0 @@
---
title: '@nrwl/react-native:library generator'
description: 'Create a React Native library'
---
# @nrwl/react-native:library
Create a React Native library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### directory
Alias(es): d
Type: `string`
A directory where the lib is placed.
### globalCss
Default: `false`
Type: `boolean`
When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '_.css' rather than '_.module.css').
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### publishable
Type: `boolean`
Create a publishable library.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### strict
Default: `true`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### 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.

210
nx-dev/nx-dev/public/documentation/generated/api-react/generators/application.md
View File

@ -1,210 +0,0 @@
---
title: '@nrwl/react:application generator'
description: 'Create a React application'
---
# @nrwl/react:application
Create a React application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
### Examples
Generate apps/myorg/myapp and apps/myorg/myapp-e2e:
```bash
nx g app myapp --directory=myorg
```
Use class components instead of functional components:
```bash
nx g app myapp --classComponent
```
Set up React Router:
```bash
nx g app myapp --routing
```
## Options
### classComponent
Alias(es): C
Default: `false`
Type: `boolean`
Use class components instead of functional component.
### compiler
Default: `babel`
Type: `string`
Possible values: `babel`, `swc`
The compiler to use
### directory
Alias(es): dir
Type: `string`
The directory of the new application.
### e2eTestRunner
Default: `cypress`
Type: `string`
Possible values: `cypress`, `none`
Test runner to use for end to end (e2e) tests.
### globalCss
Default: `false`
Type: `boolean`
Default is false. When true, the component is generated with _.css/_.scss instead of _.module.css/_.module.scss
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### routing
Default: `false`
Type: `boolean`
Generate application with routes.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipWorkspaceJson
Default: `false`
Type: `boolean`
Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### strict
Default: `true`
Type: `boolean`
Creates an application with strict mode and strict type checking
### style
Alias(es): s
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `styled-jsx`, `none`
The file extension to be used for style files.
### tags
Alias(es): t
Type: `string`
Add tags to the application (used for linting).
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

56
nx-dev/nx-dev/public/documentation/generated/api-react/generators/component-cypress-spec.md
View File

@ -1,56 +0,0 @@
---
title: '@nrwl/react:component-cypress-spec generator'
description: 'Create a cypress spec for a ui component that has a story'
---
# @nrwl/react:component-cypress-spec
Create a cypress spec for a ui component that has a story
## Usage
```bash
nx generate component-cypress-spec ...
```
By default, Nx will search for `component-cypress-spec` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:component-cypress-spec ...
```
Show what will be generated without writing to disk:
```bash
nx g component-cypress-spec ... --dry-run
```
## Options
### componentPath (_**required**_)
Type: `string`
Relative path to the component file from the library root?
### project (_**required**_)
Type: `string`
The project name for which to generate tests.
### cypressProject
Type: `string`
The Cypress project to generate the stories under. By default, inferred from 'project'
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.

42
nx-dev/nx-dev/public/documentation/generated/api-react/generators/component-story.md
View File

@ -1,42 +0,0 @@
---
title: '@nrwl/react:component-story generator'
description: 'Generate storybook story for a react component'
---
# @nrwl/react:component-story
Generate storybook story for a react component
## Usage
```bash
nx generate component-story ...
```
By default, Nx will search for `component-story` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:component-story ...
```
Show what will be generated without writing to disk:
```bash
nx g component-story ... --dry-run
```
## Options
### componentPath (_**required**_)
Type: `string`
Relative path to the component file from the library root
### project (_**required**_)
Type: `string`
The project name where to add the components.

166
nx-dev/nx-dev/public/documentation/generated/api-react/generators/component.md
View File

@ -1,166 +0,0 @@
---
title: '@nrwl/react:component generator'
description: 'Create a React component'
---
# @nrwl/react:component
Create a React component
## Usage
```bash
nx generate component ...
```
```bash
nx g c ... # same
```
By default, Nx will search for `component` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:component ...
```
Show what will be generated without writing to disk:
```bash
nx g component ... --dry-run
```
### Examples
Generate a component in the mylib library:
```bash
nx g component my-component --project=mylib
```
Generate a class component in the mylib library:
```bash
nx g component my-component --project=mylib --classComponent
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### classComponent
Alias(es): C
Default: `false`
Type: `boolean`
Use class components instead of functional component.
### directory
Alias(es): dir
Type: `string`
Create the component under this directory (can be nested).
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the component is exported from the project index.ts (if it exists).
### fileName
Type: `string`
Create a component with this file name.
### flat
Default: `false`
Type: `boolean`
Create component at the source root rather than its own directory.
### globalCss
Default: `false`
Type: `boolean`
Default is false. When true, the component is generated with _.css/_.scss instead of _.module.css/_.module.scss
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### pascalCaseDirectory
Alias(es): R
Default: `false`
Type: `boolean`
Use pascal case directory name (e.g. App/App.tsx).
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### routing
Type: `boolean`
Generate a library with routes.
### skipTests
Default: `false`
Type: `boolean`
When true, does not create "spec.ts" test files for the new component.
### style
Alias(es): s
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `styled-jsx`, `none`
The file extension to be used for style files.

118
nx-dev/nx-dev/public/documentation/generated/api-react/generators/hook.md
View File

@ -1,118 +0,0 @@
---
title: '@nrwl/react:hook generator'
description: 'Create a hook'
---
# @nrwl/react:hook
Create a hook
## Usage
```bash
nx generate hook ...
```
```bash
nx g h ... # same
```
By default, Nx will search for `hook` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:hook ...
```
Show what will be generated without writing to disk:
```bash
nx g hook ... --dry-run
```
### Examples
Generate a hook in the mylib library:
```bash
nx g hook my-hook --project=mylib
```
## Options
### name (_**required**_)
Type: `string`
The name of the hook.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### directory
Alias(es): d
Type: `string`
Create the hook under this directory (can be nested).
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the hook is exported from the project index.ts (if it exists).
### flat
Default: `false`
Type: `boolean`
Create hook at the source root rather than its own directory.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### pascalCaseDirectory
Alias(es): R
Default: `false`
Type: `boolean`
Use pascal case directory name (e.g. useHook/useHook.ts).
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case hook file name (e.g. useHook.ts).
### skipTests
Default: `false`
Type: `boolean`
When true, does not create "spec.ts" test files for the new hook.

218
nx-dev/nx-dev/public/documentation/generated/api-react/generators/library.md
View File

@ -1,218 +0,0 @@
---
title: '@nrwl/react:library generator'
description: 'Create a React library'
---
# @nrwl/react:library
Create a React library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
Generate a library with routes and add them to myapp:
```bash
nx g lib mylib --appProject=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### appProject
Alias(es): a
Type: `string`
The application project to add the library route to.
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### compiler
Default: `babel`
Type: `string`
Possible values: `babel`, `swc`
Which compiler to use.
### component
Default: `true`
Type: `boolean`
Generate a default component.
### directory
Alias(es): dir
Type: `string`
A directory where the lib is placed.
### globalCss
Default: `false`
Type: `boolean`
When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '_.css' rather than '_.module.css').
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### publishable
Type: `boolean`
Create a publishable library.
### routing
Type: `boolean`
Generate library with routes.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### standaloneConfig
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
### strict
Default: `true`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### style
Alias(es): s
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `less`, `styled-components`, `@emotion/styled`, `styled-jsx`, `none`
The file extension to be used for style files.
### 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.

Some files were not shown because too many files have changed in this diff Show More