docs(core): add nextjs app for new nx.dev website (#5133)

Co-authored-by: ben <contact@benjamincabanes.com>
This commit is contained in:
Jack Hsu 2021-03-27 00:01:31 -04:00 committed by GitHub
parent a582bfd5a1
commit ed94c4e1ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1012 changed files with 101184 additions and 4964 deletions

View File

@ -12,7 +12,7 @@ import {
statSync, statSync,
writeFileSync, writeFileSync,
} from 'fs-extra'; } from 'fs-extra';
import * as isCI from 'is-ci'; import isCI = require('is-ci');
import * as path from 'path'; import * as path from 'path';
import { dirSync } from 'tmp'; import { dirSync } from 'tmp';

View File

@ -19,6 +19,10 @@ module.exports = {
'<rootDir>/packages/cli', '<rootDir>/packages/cli',
'<rootDir>/packages/angular', '<rootDir>/packages/angular',
'<rootDir>/packages/gatsby', '<rootDir>/packages/gatsby',
'<rootDir>/dep-graph/dep-graph-client', '<rootDir>/dep-graph/dep-graph',
'<rootDir>/nx-dev/nx-dev',
'<rootDir>/nx-dev/ui-common',
'<rootDir>/nx-dev/feature-doc-viewer',
'<rootDir>/nx-dev/data-access-documents',
], ],
}; };

View File

@ -1,4 +1,5 @@
const nxPreset = require('@nrwl/jest/preset'); const nxPreset = require('@nrwl/jest/preset');
module.exports = { module.exports = {
...nxPreset, ...nxPreset,
testTimeout: 30000, testTimeout: 30000,

3
nx-dev/README.md Normal file
View File

@ -0,0 +1,3 @@
# nx.dev
This folder contains the app and libs to power [nx.dev](https://nx.dev)).

View File

@ -0,0 +1,3 @@
{
"presets": ["@nrwl/web/babel"]
}

View File

@ -0,0 +1,21 @@
{
"extends": ["../../.eslintrc.json"],
"ignorePatterns": ["!**/*"],
"overrides": [
{
"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
"parserOptions": {
"project": ["nx-dev/data-access-documentation/tsconfig.*?.json"]
},
"rules": {}
},
{
"files": ["*.ts", "*.tsx"],
"rules": {}
},
{
"files": ["*.js", "*.jsx"],
"rules": {}
}
]
}

View File

@ -0,0 +1,11 @@
# documentation-api
This library provides the data necessary to display the latest and previous documentation.
The [`data`](./src/data) folder contains the version mapping as well as a snapshot of the latest and previous docs.
## Testing
```
nx test documentation-api
```

View File

@ -0,0 +1,15 @@
const nxPreset = require('@nrwl/jest/preset');
module.exports = {
...nxPreset,
displayName: 'nx-dev-data-access-documents',
globals: {
'ts-jest': {
tsConfig: '<rootDir>/tsconfig.spec.json',
},
},
transform: {
'^.+\\.[tj]sx?$': 'ts-jest',
},
moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
coverageDirectory: '../../../coverage/nx-dev/data-access-documents',
};

View File

@ -0,0 +1,35 @@
# ng-packagr-lite
Build an Angular library for incremental building
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### project
Type: `string`
The file path for the ng-packagr configuration file, relative to the current workspace.
### tsConfig
Type: `string`
The full path for the TypeScript configuration file, relative to the current workspace.
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Update buildable project dependencies in package.json
### watch
Default: `false`
Type: `boolean`
Run build when files change.

View File

@ -0,0 +1,45 @@
# package
Build and package an Angular library for publishing
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### buildableProjectDepsInPackageJsonType
Default: `peerDependencies`
Type: `string`
Possible values: `dependencies`, `peerDependencies`
When updateBuildableProjectDepsInPackageJson is true, this adds dependencies to either `peerDependencies` or `dependencies`
### project
Type: `string`
The file path for the ng-packagr configuration file, relative to the current workspace.
### tsConfig
Type: `string`
The full path for the TypeScript configuration file, relative to the current workspace.
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Update buildable project dependencies in package.json
### watch
Default: `false`
Type: `boolean`
Run build when files change.

View File

@ -0,0 +1,333 @@
# webpack-browser
Angular browser builder that supports incremental builds
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### allowedCommonJsDependencies
Type: `array`
A list of CommonJS packages that are allowed to be used without a build time warning.
### aot
Default: `false`
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: `false`
Type: `boolean`
Enables '@angular-devkit/build-optimizer' optimizations when using the 'aot' option.
### commonChunk
Default: `true`
Type: `boolean`
Use a separate 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`
URL where files will be deployed.
### experimentalRollupPass
Default: `false`
Type: `boolean`
Concatenate modules with Rollup before bundling them with Webpack.
### extractCss
Default: `false`
Type: `boolean`
Extract css from global styles into css files instead of js ones.
### extractLicenses
Default: `false`
Type: `boolean`
Extract all licenses in a separate file.
### fileReplacements
Type: `array`
Replace compilation source files with other compilation source files in the build.
### forkTypeChecker
Default: `true`
Type: `boolean`
Run the TypeScript type checker in a forked process.
### i18nFile
Type: `string`
Localization file to use for i18n.
### i18nFormat
Type: `string`
Format of the localization file specified with --i18n-file.
### i18nLocale
Type: `string`
Locale to use for i18n.
### i18nMissingTranslation
Default: `warning`
Type: `string`
Possible values: `warning`, `error`, `ignore`
How to handle missing translations for i18n.
### index
Type: `string`
Configures the generation of the application's HTML index.
### lazyModules
Type: `array`
List of additional NgModule files that will be lazy loaded. Lazy router modules will be discovered automatically.
### localize
Type: `boolean | boolean[] `
### main
Type: `string`
The full path for the main entry point to the app, relative to the current workspace.
### namedChunks
Default: `true`
Type: `boolean`
Use file name for lazy loaded chunks.
### ngswConfigPath
Type: `string`
Path to ngsw-config.json.
### optimization
Default: `false`
Type: `boolean`
Enables optimization of the build output.
### outputHashing
Default: `none`
Type: `string`
Possible values: `none`, `all`, `media`, `bundles`
Define the output filename cache-busting hashing mode.
### outputPath
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.
### 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
Type: `boolean`
Log progress to the console while building.
### rebaseRootRelativeCssUrls
Default: `false`
Type: `boolean`
Change root relative URLs in stylesheets to include base HREF and deploy URL. Use only for compatibility and transition. The behavior of this option is non-standard and will be removed in the next major release.
### 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: `true`
Type: `boolean`
Show circular dependency warnings on builds.
### sourceMap
Default: `true`
Type: `boolean`
Output sourcemaps.
### 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.
### tsConfig
Type: `string`
The full path for the TypeScript configuration file, relative to the current workspace.
### vendorChunk
Default: `true`
Type: `boolean`
Use a separate bundle containing only vendor libraries.
### 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.

View File

@ -0,0 +1,179 @@
# application
Create 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 `angular.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
### 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
### enableIvy
Default: `true`
Type: `boolean`
Create a new app that uses the Ivy rendering engine.
### 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: `tslint`
Type: `string`
Possible values: `tslint`, `eslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### prefix
Alias(es): p
Type: `string`
The prefix to apply to generated selectors.
### routing
Default: `false`
Type: `boolean`
Generates a routing module.
### 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.
### strict
Default: `false`
Type: `boolean`
Creates an application with stricter type checking and build optimization options.
### style
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `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.

View File

@ -0,0 +1,59 @@
# downgrade-module
Setup Downgrade Module
## Usage
```bash
nx generate downgrade-module ...
```
By default, Nx will search for `downgrade-module` in the default collection provisioned in `angular.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
### angularJsImport
Type: `string`
Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app).
### name
Type: `string`
The name of the main AngularJS module.
### project
Type: `string`
The name of the project
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add @angular/upgrade to package.json (e.g., --skipPackageJson)

View File

@ -0,0 +1,31 @@
# karma-project
Add karma testing to a project
## Usage
```bash
nx generate karma-project ...
```
By default, Nx will search for `karma-project` in the default collection provisioned in `angular.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
Type: `string`
The name of the project.

View File

@ -0,0 +1,23 @@
# karma
Add karma configuration to a workspace
## Usage
```bash
nx generate karma ...
```
By default, Nx will search for `karma` in the default collection provisioned in `angular.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
```

View File

@ -0,0 +1,177 @@
# library
Create 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 `angular.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
### addModuleSpec
Default: `false`
Type: `boolean`
Add a module spec file.
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### 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. 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: `tslint`
Type: `string`
Possible values: `tslint`, `eslint`
The tool to use for running lint checks.
### name
Type: `string`
Library name
### 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.
### simpleModuleName
Default: `false`
Type: `boolean`
Keep the module name simple (when using --directory)
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### 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.
### strict
Default: `false`
Type: `boolean`
Creates a library with stricter type checking and build optimization options.
### style
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `less`
The file extension to be used for style files.
### 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

View File

@ -0,0 +1,65 @@
# move
Move an Angular application or library to another folder
## Usage
```bash
nx generate move ...
```
```bash
nx g mv ... # same
```
By default, Nx will search for `move` in the default collection provisioned in `angular.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
Type: `string`
The folder to move the Angular project into
### importPath
Type: `string`
The new import path to use in the tsconfig.base.json
### projectName
Alias(es): project
Type: `string`
The name of the Angular project to move
### updateImportPath
Default: `true`
Type: `boolean`
Should the schematic update the import path to reflect the new location?

View File

@ -0,0 +1,135 @@
# ngrx
Add an ngrx config to a project
## Usage
```bash
nx generate ngrx ...
```
By default, Nx will search for `ngrx` in the default collection provisioned in `angular.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
### 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.
### module
Type: `string`
The path to NgModule where the feature state will be registered. The host directory will create/use the new state directory.
### name
Type: `string`
Name of the NgRx feature state, such as "products" or "users"). Recommended to use the plural form of the name.
### onlyAddFiles
Default: `false`
Type: `boolean`
**Deprecated**, use `skipImport`. Only add new NgRx files, without changing the module file (e.g., --onlyAddFiles).
### onlyEmptyRoot
Default: `false`
Type: `boolean`
**Deprecated**, use `minimal`. Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot).
### root
Default: `false`
Type: `boolean`
Setup root or feature state management with NgRx.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting of generated 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.

View File

@ -0,0 +1,37 @@
# stories
Create stories/specs for all components declared in a library
## Usage
```bash
nx generate stories ...
```
By default, Nx will search for `stories` in the default collection provisioned in `angular.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
### generateCypressSpecs
Type: `boolean`
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
### name
Type: `string`
Library or application name

View File

@ -0,0 +1,59 @@
# storybook-configuration
Create stories/specs for all components declared in a library
## Usage
```bash
nx generate storybook-configuration ...
```
By default, Nx will search for `storybook-configuration` in the default collection provisioned in `angular.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
### configureCypress
Type: `boolean`
Run the cypress-configure schematic
### generateCypressSpecs
Type: `boolean`
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
### generateStories
Type: `boolean`
Automatically generate \*.stories.ts files for components declared in this library
### linter
Default: `tslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
Library or application name

View File

@ -0,0 +1,73 @@
# upgrade-module
Add an upgrade module
## Usage
```bash
nx generate upgrade-module ...
```
By default, Nx will search for `upgrade-module` in the default collection provisioned in `angular.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
### 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).
### name
Type: `string`
The name of the main AngularJS module.
### project
Type: `string`
The name of the project
### 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)

View File

@ -0,0 +1,125 @@
# cypress
Run Cypress e2e tests
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### baseUrl
Type: `string`
Use this to pass directly the address of your distant server address with the port running your application
### browser
Type: `string`
The browser to run tests in.
### ciBuildId
Type: `string`
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
### cypressConfig
Type: `string`
The path of the Cypress configuration json file.
### 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.
### headless
Default: `false`
Type: `boolean`
Whether or not to open the Cypress application to run the tests. If set to 'true', will run in headless mode
### 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.
### 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**
### tsConfig
Type: `string`
The path of the Cypress tsconfig configuration json file.
### watch
Default: `false`
Type: `boolean`
Recompile and run tests when files change.

View File

@ -0,0 +1,115 @@
# 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 `angular.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.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to package.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

View File

@ -0,0 +1,221 @@
# jest
Run Jest unit tests
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### bail
Alias(es): b
Type: `number | boolean `
Exit the test suite immediately after `n` number of failing tests. (https://jestjs.io/docs/en/cli#bail)
### 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/en/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/en/cli#coverage)
### 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/en/cli#colors)
### colors
Type: `boolean`
Forces test results output highlighting even if stdout is not a TTY. (https://jestjs.io/docs/en/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/en/cli.html#--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/en/cli#findrelatedtests-spaceseparatedlistofsourcefiles)
### jestConfig
Type: `string`
The path of the Jest configuration. (https://jestjs.io/docs/en/configuration)
### 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/en/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/en/cli#maxworkers-num)
### 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/en/cli#onlychanged)
### outputFile
Type: `string`
Write test results to a file when the --json option is also specified. (https://jestjs.io/docs/en/cli#outputfile-filename)
### passWithNoTests
Type: `boolean`
Will not fail if no tests are found (for example while using `--testPathPattern`.) (https://jestjs.io/docs/en/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/en/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/en/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/en/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/en/cli#testlocationinresults)
### testNamePattern
Alias(es): t
Type: `string`
Run only tests with a name that matches the regex pattern. (https://jestjs.io/docs/en/cli#testnamepattern-regex)
### testPathPattern
Type: `array`
An array of regexp pattern strings that is matched against all tests paths before executing the test. (https://jestjs.io/docs/en/cli#testpathpattern-regex)
### testResultsProcessor
Type: `string`
Node module that implements a custom results processor. (https://jestjs.io/docs/en/configuration#testresultsprocessor-string)
### 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/en/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/en/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/en/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/en/cli#watchall)

View File

@ -0,0 +1,93 @@
# eslint
Run ESLint on a project
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### 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).
### ignorePath
Type: `string`
The path of the .eslintignore file.
### lintFilePatterns
Type: `array`
One or more files/dirs/globs to pass directly to ESLint's lintFiles() method.
### 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.

View File

@ -0,0 +1,109 @@
# lint
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### 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).
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### 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.

View File

@ -0,0 +1,89 @@
# application
Create a nest application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `angular.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
### 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`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to package.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

View File

@ -0,0 +1,65 @@
# class
Run the 'class' NestJs Schematic with Nx project support
## Usage
```bash
nx generate class ...
```
By default, Nx will search for `class` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# controller
Run the 'controller' NestJs Schematic with Nx project support
## Usage
```bash
nx generate controller ...
```
By default, Nx will search for `controller` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# decorator
Run the 'decorator' NestJs Schematic with Nx project support
## Usage
```bash
nx generate decorator ...
```
By default, Nx will search for `decorator` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# filter
Run the 'filter' NestJs Schematic with Nx project support
## Usage
```bash
nx generate filter ...
```
By default, Nx will search for `filter` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# gateway
Run the 'gateway' NestJs Schematic with Nx project support
## Usage
```bash
nx generate gateway ...
```
By default, Nx will search for `gateway` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# guard
Run the 'guard' NestJs Schematic with Nx project support
## Usage
```bash
nx generate guard ...
```
By default, Nx will search for `guard` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# interceptor
Run the 'interceptor' NestJs Schematic with Nx project support
## Usage
```bash
nx generate interceptor ...
```
By default, Nx will search for `interceptor` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# interface
Run the 'interface' NestJs Schematic with Nx project support
## Usage
```bash
nx generate interface ...
```
By default, Nx will search for `interface` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,159 @@
# library
Create a new nest library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `angular.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
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### controller
Default: `false`
Type: `boolean`
Include a controller with the library
### directory
Alias(es): d
Type: `string`
A directory where the app 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`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
Library name
### publishable
Type: `boolean`
Create a publishable library.
### service
Default: `false`
Type: `boolean`
Include a service with the library.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.base.json for development experience.
### 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

View File

@ -0,0 +1,65 @@
# middleware
Run the 'middleware' NestJs Schematic with Nx project support
## Usage
```bash
nx generate middleware ...
```
By default, Nx will search for `middleware` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# module
Run the 'module' NestJs Schematic with Nx project support
## Usage
```bash
nx generate module ...
```
By default, Nx will search for `module` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# pipe
Run the 'pipe' NestJs Schematic with Nx project support
## Usage
```bash
nx generate pipe ...
```
By default, Nx will search for `pipe` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# provider
Run the 'provider' NestJs Schematic with Nx project support
## Usage
```bash
nx generate provider ...
```
By default, Nx will search for `provider` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# resolver
Run the 'resolver' NestJs Schematic with Nx project support
## Usage
```bash
nx generate resolver ...
```
By default, Nx will search for `resolver` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,65 @@
# service
Run the 'service' NestJs Schematic with Nx project support
## Usage
```bash
nx generate service ...
```
By default, Nx will search for `service` in the default collection provisioned in `angular.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
### directory
Alias(es): d,path
Type: `string`
Directory where the generated files are placed
### flat
Default: `false`
Type: `boolean`
Flag to indicate if a directory is created.
### name
Type: `string`
The name of generated schematic
### project
Alias(es): p
Type: `string`
The nest project to target
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,43 @@
# build
Build a Next.js app
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### fileReplacements
Type: `object[]`
Replace files with other files in the build.
#### replace
Type: `string`
undefined
#### with
Type: `string`
undefined
### nextConfig
Type: `string`
Path to a function which takes phase, config, and builder options, and returns the resulting config.
### outputPath
Type: `string`
The output path of the generated files.
### root
Type: `string`
The source root

View File

@ -0,0 +1,27 @@
# export
Export a Next.js app. The exported application is located at dist/\$outputPath/exported.
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### 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)

View File

@ -0,0 +1,63 @@
# server
Serve a Next.js app
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### buildTarget
Type: `string`
Target which builds the application
### 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.

View File

@ -0,0 +1,123 @@
# 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 `angular.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
### 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.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipWorkspaceJson
Default: `false`
Type: `boolean`
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style)
### 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.
### 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

View File

@ -0,0 +1,107 @@
# component
Create a React component
## Usage
```bash
nx generate component ...
```
By default, Nx will search for `component` in the default collection provisioned in `angular.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
### 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.
### name
Type: `string`
The name of the component.
### project
Alias(es): p
Type: `string`
The name of the project.
### 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.

View File

@ -0,0 +1,107 @@
# 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 `angular.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 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
### directory
Alias(es): d
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.
### name
Type: `string`
The name of the component.
### project
Alias(es): p
Type: `string`
The name of the project.
### 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.

View File

@ -0,0 +1,161 @@
# build
Build a Node application
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### assets
Type: `array`
List of static application assets.
### buildLibsFromSource
Default: `false`
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`
undefined
#### with
Type: `string`
undefined
### 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.
### main
Type: `string`
The name of the main entry-point file.
### 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.
### 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.
### showCircularDependencies
Default: `true`
Type: `boolean`
Show circular dependency warnings on builds.
### 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.
### tsConfig
Type: `string`
The name of the Typescript configuration file.
### verbose
Default: `false`
Type: `boolean`
Emits verbose output
### watch
Default: `false`
Type: `boolean`
Run build when files change.
### webpackConfig
Type: `string`
Path to a function which takes a webpack config, context and returns the resulting webpack config

View File

@ -0,0 +1,63 @@
# execute
Execute a Node application
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### args
Type: `array`
Extra args when starting the app
### buildTarget
Type: `string`
The target to run to build you 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: `0`
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

View File

@ -0,0 +1,77 @@
# package
Package a Node library
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### 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`
### main
Type: `string`
The name of the main entry-point file.
### 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
### tsConfig
Type: `string`
The name of the Typescript configuration file.
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Update buildable project dependencies in package.json
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.

View File

@ -0,0 +1,115 @@
# 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 `angular.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.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to package.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

View File

@ -0,0 +1,159 @@
# 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 `angular.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
### babelJest
Default: `false`
Type: `boolean`
Use babel instead ts-jest
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### directory
Alias(es): d
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.
### name
Type: `string`
Library name
### 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.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.base.json for development experience.
### 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

View File

@ -0,0 +1,25 @@
# e2e
Creates and runs an e2e for a Nx Plugin
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### jestConfig
Type: `string`
Jest config file
### target
Type: `string`
the target Nx Plugin project and build
### tsSpecConfig
Type: `string`
[Deprecated] Spec tsconfig file

View File

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

View File

@ -0,0 +1,83 @@
# 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 `angular.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
### 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
### project
Alias(es): p
Type: `string`
The name of the project.
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests
### version
Alias(es): v
Type: `string`
Version to use for the migration

View File

@ -0,0 +1,97 @@
# plugin
Create a Nx Plugin
## Usage
```bash
nx generate plugin ...
```
By default, Nx will search for `plugin` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
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
### 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.
### name
Type: `string`
Plugin name
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### tags
Alias(es): t
Type: `string`
Add tags to the library (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

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

View File

@ -0,0 +1,165 @@
# application
Create an application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `angular.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.
### 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.
### 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.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipWorkspaceJson
Default: `false`
Type: `boolean`
Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style).
### 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.

View File

@ -0,0 +1,45 @@
# 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 `angular.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
Type: `string`
Relative path to the component file from the library root?
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### project
Type: `string`
The project name for which to generate tests.

View File

@ -0,0 +1,37 @@
# 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 `angular.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
Type: `string`
Relative path to the component file from the library root
### project
Type: `string`
The project name where to add the components.

View File

@ -0,0 +1,137 @@
# component
Create a component
## Usage
```bash
nx generate component ...
```
```bash
nx g c ... # same
```
By default, Nx will search for `component` in the default collection provisioned in `angular.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
### 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.
### name
Type: `string`
The name of the component.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### project
Alias(es): p
Type: `string`
The name of the project.
### 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.

View File

@ -0,0 +1,173 @@
# 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 `angular.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
### appProject
Alias(es): a
Type: `string`
The application project to add the library route to.
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### component
Default: `true`
Type: `boolean`
Generate a default component.
### directory
Alias(es): d
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`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
Library name
### 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.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### 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.

View File

@ -0,0 +1,67 @@
# redux
Create a redux slice for a project
## Usage
```bash
nx generate redux ...
```
```bash
nx g slice ... # same
```
By default, Nx will search for `redux` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:redux ...
```
Show what will be generated without writing to disk:
```bash
nx g redux ... --dry-run
```
## Options
### appProject
Alias(es): a
Type: `string`
The application project to add the slice to.
### directory
Alias(es): d
Type: `string`
The name of the folder used to contain/group the generated Redux files.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### name
Type: `string`
Redux slice name.
### project
Alias(es): p
Type: `string`
The name of the project to add the slice to. If it is an application, then the store configuration will be updated too.

View File

@ -0,0 +1,45 @@
# stories
Create stories/specs for all components declared in a library
## Usage
```bash
nx generate stories ...
```
By default, Nx will search for `stories` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:stories ...
```
Show what will be generated without writing to disk:
```bash
nx g stories ... --dry-run
```
## Options
### generateCypressSpecs
Type: `boolean`
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### project
Type: `string`
Library or application name

View File

@ -0,0 +1,67 @@
# storybook-configuration
Set up storybook for a react library
## Usage
```bash
nx generate storybook-configuration ...
```
By default, Nx will search for `storybook-configuration` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:storybook-configuration ...
```
Show what will be generated without writing to disk:
```bash
nx g storybook-configuration ... --dry-run
```
## Options
### configureCypress
Type: `boolean`
Run the cypress-configure schematic.
### generateCypressSpecs
Type: `boolean`
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
### generateStories
Type: `boolean`
Automatically generate \*.stories.ts files for components declared in this library.
### 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`
Library or application name

View File

@ -0,0 +1,37 @@
# build
Build Storybook
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### docsMode
Default: `false`
Type: `boolean`
Build a documentation-only site using addon-docs.
### outputPath
Type: `string`
The output path of the generated files.
### quiet
Default: `true`
Type: `boolean`
Suppress verbose build output.
### uiFramework (**hidden**)
Default: `@storybook/angular`
Type: `string`
Storybook framework npm package

View File

@ -0,0 +1,81 @@
# storybook
Serve Storybook
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### docsMode
Default: `false`
Type: `boolean`
Build a documentation-only site using addon-docs.
### host
Default: `localhost`
Type: `string`
Host to listen on.
### port
Default: `9009`
Type: `number`
Port to listen on.
### quiet
Default: `true`
Type: `boolean`
Suppress verbose build output.
### 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.
### staticDir
Type: `array`
Directory where to load static files from, array of strings
### uiFramework (**hidden**)
Default: `@storybook/angular`
Type: `string`
Storybook framework npm package
### watch
Default: `true`
Type: `boolean`
Watches for changes and rebuilds application

View File

@ -0,0 +1,63 @@
# configuration
Add storybook configuration to a ui library
## Usage
```bash
nx generate configuration ...
```
By default, Nx will search for `configuration` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/storybook:configuration ...
```
Show what will be generated without writing to disk:
```bash
nx g configuration ... --dry-run
```
## Options
### configureCypress
Type: `boolean`
Run the cypress-configure schematic
### 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`
Library name
### uiFramework
Type: `string`
Possible values: `@storybook/angular`, `@storybook/react`
Storybook UI Framework to use

View File

@ -0,0 +1,49 @@
# cypress-project
Add cypress e2e app to test a ui library that is set up for storybook
## Usage
```bash
nx generate cypress-project ...
```
By default, Nx will search for `cypress-project` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/storybook:cypress-project ...
```
Show what will be generated without writing to disk:
```bash
nx g cypress-project ... --dry-run
```
## Options
### 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`
Library name

View File

@ -0,0 +1,243 @@
# build
Build a application
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### assets
Type: `array`
List of static application assets.
### baseHref
Default: `/`
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.
### buildLibsFromSource
Default: `false`
Type: `boolean`
Read buildable libraries from source instead of building them separately.
### commonChunk
Default: `true`
Type: `boolean`
Use a separate bundle containing code used across multiple bundles.
### crossOrigin
Type: `string`
The crossorigin attribute to use for generated javascript script tags. One of 'none' | 'anonymous' | 'use-credentials'
### deployUrl
Type: `string`
URL where the application will be deployed.
### es2015Polyfills
Type: `string`
Conditional polyfills loaded in browsers which do not support ES2015.
### extractCss
Default: `false`
Type: `boolean`
Extract css into a .css file
### 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`
undefined
#### with
Type: `string`
undefined
### index
Type: `string`
HTML File which will be contain the application
### main
Type: `string`
The name of the main entry-point file.
### 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)
### namedChunks
Default: `true`
Type: `boolean`
Names the produced bundles according to their entry file
### optimization
Type: `boolean`
Enables optimization of the build output.
### outputHashing
Default: `none`
Type: `string`
Possible values: `none`, `all`, `media`, `bundles`
Define the output filename cache-busting hashing mode.
### outputPath
Type: `string`
The output path of the generated files.
### polyfills
Type: `string`
Polyfills to load before application
### progress
Default: `false`
Type: `boolean`
Log progress to the console while building.
### scripts
Type: `array`
External Scripts which will be included before the main application entry
### showCircularDependencies
Default: `true`
Type: `boolean`
Show circular dependency warnings on builds.
### sourceMap
Default: `true`
Type: `boolean`
Output sourcemaps.
### 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.
### styles
Type: `array`
External Styles which will be included with the application
### subresourceIntegrity
Default: `false`
Type: `boolean`
Enables the use of subresource integrity validation.
### tsConfig
Type: `string`
The name of the Typescript configuration file.
### vendorChunk
Default: `true`
Type: `boolean`
Use a separate bundle containing only vendor libraries.
### verbose
Default: `false`
Type: `boolean`
Emits verbose output
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.
### webpackConfig
Type: `string`
Path to a function which takes a webpack config, some context and returns the resulting webpack config

View File

@ -0,0 +1,105 @@
# dev-server
Serve a web application
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### allowedHosts
Type: `string`
This option allows you to whitelist services that are allowed to access the dev server.
### baseHref
Default: `/`
Type: `string`
Base url for the application being built.
### buildTarget
Type: `string`
Target which builds the application
### host
Default: `localhost`
Type: `string`
Host to listen on.
### liveReload
Default: `true`
Type: `boolean`
Whether to reload the page on change, using live-reload.
### maxWorkers
Type: `number`
Number of workers to use for type checking.
### memoryLimit
Type: `number`
Memory limit for type checking service process in MB.
### open
Default: `false`
Type: `boolean`
Open the application in the browser.
### port
Default: `4200`
Type: `number`
Port to listen on.
### publicHost
Type: `string`
Public URL where the application 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.
### watch
Default: `true`
Type: `boolean`
Watches for changes and rebuilds application

View File

@ -0,0 +1,113 @@
# package
Package a library
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Properties
### assets
Type: `array`
List of static assets.
### babelConfig
Type: `string`
(deprecated) Path to a function which takes a babel config and returns an updated babel config
### buildableProjectDepsInPackageJsonType
Default: `peerDependencies`
Type: `string`
Possible values: `dependencies`, `peerDependencies`
When updateBuildableProjectDepsInPackageJson is true, this adds dependencies to either `peerDependencies` or `dependencies`
### entryFile
Type: `string`
The path to the entry file, relative to project.
### external
Type: `array`
A list of external modules that will not be bundled (react, react-dom, etc.).
### extractCss
Default: `true`
Type: `boolean`
CSS files will be extracted to the output folder.
### globals
Type: `object[]`
A mapping of node modules to their UMD global names. Used by the UMD bundle
#### moduleId
Type: `string`
The node module to map from (e.g. `react-dom`).
#### global
Type: `string`
The global name to map to (e.g. `ReactDOM`).
### outputPath
Type: `string`
The output path of the generated files.
### project
Type: `string`
The path to package.json file.
### rollupConfig
Type: `string`
Path to a function which takes a rollup config and returns an updated rollup config
### tsConfig
Type: `string`
The path to tsconfig file.
### umdName
Type: `string`
The name of your module in UMD format. Defaulted to your project name.
### updateBuildableProjectDepsInPackageJson
Default: `true`
Type: `boolean`
Update buildable project dependencies in package.json
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.

View File

@ -0,0 +1,103 @@
# application
Create an application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/web: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.
### e2eTestRunner
Default: `cypress`
Type: `string`
Possible values: `cypress`, `none`
Test runner to use for end to end (e2e) tests
### 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.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### style
Default: `css`
Type: `string`
Possible values: `css`, `scss`, `styl`, `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: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,219 @@
# run-commands
Run any custom commands with Nx
Builder properties can be configured in angular.json when defining the builder, or when invoking it.
## Examples
`workspace.json`:
```json
//...
"frontend": {
"architect": {
//...
"ls-project-root": {
"builder": "@nrwl/workspace:run-commands",
"options": {
"command": "ls apps/frontend/src"
}
}
}
}
```
```bash
nx run frontend:ls-project-root
```
##### Chaining commands, interpolating args and setting the cwd
Let's say each of our workspace projects has some custom bash scripts in a `scripts` folder.
We want a simple way to create empty bash script files for a given project, that have the execute permissions already set.
Given that Nx knows our workspace structure, we should be able to give it a project and the name of our script, and it should take care of the rest.
The `commands` option accepts as many commands as you want. By default, they all run in parallel.
You can run them sequentially by setting `parallel: false`:
```json
"create-script": {
"builder": "@nrwl/workspace:run-commands",
"options": {
"commands": [
"mkdir -p scripts",
"touch scripts/{args.name}.sh",
"chmod +x scripts/{args.name}.sh"
],
"cwd": "apps/frontend",
"parallel": false
}
}
```
By setting the `cwd` option, each command will run in the `apps/frontend` folder.
We run the above with:
```bash
nx run frontend:create-script --args="--name=example"
```
or simply with:
```bash
nx run frontend:create-script --name=example
```
##### Arguments forwarding
When interpolation is not present in the command, all arguments are forwarded to the command by default.
This is useful when you need to pass raw argument strings to your command.
For example, when you run:
nx run frontend:webpack --args="--config=example.config.js"
```json
"webpack": {
"builder": "@nrwl/workspace:run-commands",
"options": {
"command": "webpack"
}
}
```
The above command will execute: `webpack --config=example.config.js`
This functionality can be disabled by using `commands` and expanding each `command` into an object
that sets the `forwardAllArgs` option to `false` as shown below:
```json
"webpack": {
"builder": "@nrwl/workspace:run-commands",
"options": {
"commands": [
{
"command": "webpack",
"forwardAllArgs": false
}
]
}
}
```
##### Custom **done** conditions
Normally, `run-commands` considers the commands done when all of them have finished running. If you don't need to wait until they're all done, you can set a special string, that considers the command finished the moment the string appears in `stdout` or `stderr`:
```json
"finish-when-ready": {
"builder": "@nrwl/workspace:run-commands",
"options": {
"command": "echo 'READY' && sleep 5 && echo 'FINISHED'",
"readyWhen": "READY"
}
}
```
```bash
nx run frontend:finish-when-ready
```
The above command will finish immediately, instead of waiting for 5 seconds.
##### Nx Affected
The true power of `run-commands` comes from the fact that it runs through `nx`, which knows about your dependency graph. So you can run **custom commands** only for the projects that have been affected by a change.
We can create some configurations to generate docs, and if run using `nx affected`, it will only generate documentation for the projects that have been changed:
```bash
nx affected --target=generate-docs
```
```json
//...
"frontend": {
"architect": {
//...
"generate-docs": {
"builder": "@nrwl/workspace:run-commands",
"options": {
"command": "npx compodoc -p apps/frontend/tsconfig.app.json"
}
}
}
},
"api": {
"architect": {
//...
"generate-docs": {
"builder": "@nrwl/workspace:run-commands",
"options": {
"command": "npx compodoc -p apps/api/tsconfig.app.json"
}
}
}
}
```
## Properties
### args
Type: `string`
Extra arguments. You can pass them as follows: nx run project:target --args='--wait=100'. You can then use {args.wait} syntax to interpolate them in the workspace config file. See example [above](#chaining-commands-interpolating-args-and-setting-the-cwd)
### color
Default: `false`
Type: `boolean`
Use colors when showing output of command
### command
Type: `string`
Command to run in child process
### commands
Type: `array`
### cwd
Type: `string`
Current working directory of the commands.
### envFile
Type: `string`
You may specify a custom .env file path
### outputPath
Type: `string | string[] `
Allows you to specify where the build artifacts are stored. This allows Nx Cloud to pick them up correctly, in the case that the build artifacts are placed somewhere other than the top level dist folder.
### parallel
Default: `true`
Type: `boolean`
Run commands in parallel
### readyWhen
Type: `string`
String to appear in stdout or stderr that indicates that the task is done. This option can only be used when parallel is set to true. If not specified, the task is done when all the child processes complete.

View File

@ -0,0 +1,133 @@
# 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 `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/workspace: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
### babelJest
Default: `false`
Type: `boolean`
Use babel instead ts-jest
### 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`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
Library name
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case file names.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### 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

View File

@ -0,0 +1,65 @@
# move
Move an application or library to another folder
## Usage
```bash
nx generate move ...
```
```bash
nx g mv ... # same
```
By default, Nx will search for `move` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/workspace: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/workspace:move --project my-feature-lib shared/my-feature-lib
```
## Options
### destination
Type: `string`
The folder to move the project into
### importPath
Type: `string`
The new import path to use in the tsconfig.base.json
### projectName
Alias(es): project
Type: `string`
The name of the project to move
### updateImportPath
Default: `true`
Type: `boolean`
Should the schematic update the import path to reflect the new location?

View File

@ -0,0 +1,71 @@
# remove
Remove an application or library
## Usage
```bash
nx generate remove ...
```
```bash
nx g rm ... # same
```
By default, Nx will search for `remove` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/workspace:remove ...
```
Show what will be generated without writing to disk:
```bash
nx g remove ... --dry-run
```
### Examples
Remove my-feature-lib from the workspace:
```bash
nx g @nrwl/workspace:remove my-feature-lib
```
Force removal of my-feature-lib from the workspace:
```bash
nx g @nrwl/workspace:remove my-feature-lib --forceRemove
```
## Options
### forceRemove
Alias(es): force-remove
Default: `false`
Type: `boolean`
When true, forces removal even if the project is still in use.
### projectName
Alias(es): project
Type: `string`
The name of the project to remove
### skipFormat
Alias(es): skip-format
Default: `false`
Type: `boolean`
Skip formatting files.

View File

@ -0,0 +1,67 @@
# run-commands
Generates a target to run any command in the terminal
## Usage
```bash
nx generate run-commands ...
```
```bash
nx g run-command ... # same
```
By default, Nx will search for `run-commands` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/workspace:run-commands ...
```
Show what will be generated without writing to disk:
```bash
nx g run-commands ... --dry-run
```
### Examples
Add the printhello target to my-feature-lib:
```bash
nx g @nrwl/workspace:run-commands printhello --project my-feature-lib --command 'echo hello'
```
## Options
### command
Type: `string`
Command to run
### cwd
Type: `string`
Current working directory of the command
### name
Type: `string`
Target name
### outputs
Type: `string`
Allows you to specify where the build artifacts are stored. This allows Nx Cloud to pick them up correctly, in the case that the build artifacts are placed somewhere other than the top level dist folder.
### project
Type: `string`
Project name

View File

@ -0,0 +1,39 @@
# workspace-schematic
Generates a workspace schematic
## Usage
```bash
nx generate workspace-schematic ...
```
By default, Nx will search for `workspace-schematic` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/workspace:workspace-schematic ...
```
Show what will be generated without writing to disk:
```bash
nx g workspace-schematic ... --dry-run
```
## Options
### name
Type: `string`
Schematic name
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,14 @@
[
"angular",
"cypress",
"express",
"jest",
"linter",
"nest",
"next",
"node",
"nx-plugin",
"storybook",
"web",
"workspace"
]

View File

@ -0,0 +1,99 @@
# affected:apps
Print applications affected by changes
## Usage
```bash
nx affected:apps
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Print the names of all the apps affected by changing the index.ts file:
```bash
nx affected:apps --files=libs/mylib/src/index.ts
```
Print the names of all the apps affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:apps --base=master --head=HEAD
```
Print the names of all the apps affected by the last commit on master:
```bash
nx affected:apps --base=master~1 --head=master
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### only-failed
Default: `false`
Isolate projects which previously failed
### plain
Produces a plain output for affected:apps and affected:libs
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,137 @@
# affected:build
Build applications and publishable libraries affected by changes
## Usage
```bash
nx affected:build
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Run build in parallel:
```bash
nx affected:build --parallel --maxParallel=5
```
Rerun the build target only for the projects that failed last time:
```bash
nx affected:build --only-failed
```
Run the build target for all projects:
```bash
nx affected:build --all
```
Run the build target for the affected projects and also all the projects the affected projects depend on.:
```bash
nx affected:build --with-deps
```
Run build for all the projects affected by changing the index.ts file:
```bash
nx affected:build --files=libs/mylib/src/index.ts
```
Run build for all the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:build --base=master --head=HEAD
```
Run build for all the projects affected by the last commit on master:
```bash
nx affected:build --base=master~1 --head=master
```
Run build for all the projects affected by the last commit on master and their dependencies:
```bash
nx affected:build --base=master~1 --head=master --with-deps
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### maxParallel
Default: `3`
Max number of parallel processes. This flag is ignored if the parallel option is set to `false`.
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,133 @@
# affected:dep-graph
Graph dependencies affected by changes
## Usage
```bash
nx affected:dep-graph
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Open the dep graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:
```bash
nx affected:dep-graph --files=libs/mylib/src/index.ts
```
Open the dep graph of the workspace in the browser, and highlight the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:dep-graph --base=master --head=HEAD
```
Save the dep graph of the workspace in a json file, and highlight the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:dep-graph --base=master --head=HEAD --file=output.json
```
Generate a static website with dep graph data in an html file, highlighting the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:dep-graph --base=master --head=HEAD --file=output.html
```
Open the dep graph of the workspace in the browser, and highlight the projects affected by the last commit on master:
```bash
nx affected:dep-graph --base=master~1 --head=master
```
Open the dep graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two:
```bash
nx affected:dep-graph --exclude=project-one,project-two
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### file
output file (e.g. --file=output.json or --file=dep-graph.html)
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### focus
Use to show the dependency graph for a particular project and every node that is either an ancestor or a descendant.
### groupByFolder
Group projects by folder in dependency graph
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### host
Bind the dep graph server to a specific ip address.
### only-failed
Default: `false`
Isolate projects which previously failed
### port
Bind the dep graph server to a specific port.
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,125 @@
# affected:e2e
Run e2e tests for the applications affected by changes
## Usage
```bash
nx affected:e2e
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Run tests in parallel:
```bash
nx affected:e2e --parallel --maxParallel=5
```
Rerun the test target only for the projects that failed last time:
```bash
nx affected:e2e --only-failed
```
Run the test target for all projects:
```bash
nx affected:e2e --all
```
Run tests for all the projects affected by changing the index.ts file:
```bash
nx affected:e2e --files=libs/mylib/src/index.ts
```
Run tests for all the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:e2e --base=master --head=HEAD
```
Run tests for all the projects affected by the last commit on master:
```bash
nx affected:e2e --base=master~1 --head=master
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### maxParallel
Default: `3`
Max number of parallel processes. This flag is ignored if the parallel option is set to `false`.
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,99 @@
# affected:libs
Print libraries affected by changes
## Usage
```bash
nx affected:libs
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Print the names of all the libs affected by changing the index.ts file:
```bash
nx affected:libs --files=libs/mylib/src/index.ts
```
Print the names of all the libs affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:libs --base=master --head=HEAD
```
Print the names of all the libs affected by the last commit on master:
```bash
nx affected:libs --base=master~1 --head=master
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### only-failed
Default: `false`
Isolate projects which previously failed
### plain
Produces a plain output for affected:apps and affected:libs
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,125 @@
# affected:lint
Lint projects affected by changes
## Usage
```bash
nx affected:lint
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Run lint in parallel:
```bash
nx affected:lint --parallel --maxParallel=5
```
Rerun the lint target only for the projects that failed last time:
```bash
nx affected:lint --only-failed
```
Run the lint target for all projects:
```bash
nx affected:lint --all
```
Run lint for all the projects affected by changing the index.ts file:
```bash
nx affected:lint --files=libs/mylib/src/index.ts
```
Run lint for all the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:lint --base=master --head=HEAD
```
Run lint for all the projects affected by the last commit on master:
```bash
nx affected:lint --base=master~1 --head=master
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### maxParallel
Default: `3`
Max number of parallel processes. This flag is ignored if the parallel option is set to `false`.
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,125 @@
# affected:test
Test projects affected by changes
## Usage
```bash
nx affected:test
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Run tests in parallel:
```bash
nx affected:test --parallel --maxParallel=5
```
Rerun the test target only for the projects that failed last time:
```bash
nx affected:test --only-failed
```
Run the test target for all projects:
```bash
nx affected:test --all
```
Run tests for all the projects affected by changing the index.ts file:
```bash
nx affected:test --files=libs/mylib/src/index.ts
```
Run tests for all the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected:test --base=master --head=HEAD
```
Run tests for all the projects affected by the last commit on master:
```bash
nx affected:test --base=master~1 --head=master
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### maxParallel
Default: `3`
Max number of parallel processes. This flag is ignored if the parallel option is set to `false`.
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,147 @@
# affected
Run task for affected projects
## Usage
```bash
nx affected
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Run custom target for all affected projects:
```bash
nx affected --target=custom-target
```
Run tests in parallel:
```bash
nx affected --target=test --parallel --maxParallel=5
```
Rerun the test target only for the projects that failed last time:
```bash
nx affected --target=test --only-failed
```
Run the test target for all projects:
```bash
nx affected --target=test --all
```
Run the test target for the affected projects and also all the projects the affected projects depend on.:
```bash
nx affected --target=test --with-deps
```
Run tests for all the projects affected by changing the index.ts file:
```bash
nx affected --target=test --files=libs/mylib/src/index.ts
```
Run tests for all the projects affected by the changes between master and HEAD (e.g., PR):
```bash
nx affected --target=test --base=master --head=HEAD
```
Run tests for all the projects affected by the last commit on master:
```bash
nx affected --target=test --base=master~1 --head=master
```
Run build for all the projects affected by the last commit on master and their dependencies:
```bash
nx affected --target=build --base=master~1 --head=master --with-deps
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### maxParallel
Default: `3`
Max number of parallel processes. This flag is ignored if the parallel option is set to `false`.
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### target
Task to run for affected projects
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,294 @@
# build
Compiles an application into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.
## Usage
The `build` command is a built-in alias to the [run command](/{{framework}}/cli/run).
These two commands are equivalent:
```bash
nx build <project> [options]
```
```bash
nx run <project>:build [options]
```
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Compile a `production` build of the `myapp` project:
```bash
nx build myapp --prod
```
## Options
The options below are common to the `build` command used within an Nx workspace. The Web and Angular-specifc build options are listed after these options.
### baseHref
Default: `/`
Base url for the application being built.
### commonChunk
Use a separate bundle containing code used across multiple bundles.
Default: `true`
### budgets
Budget thresholds to ensure parts of your application stay within boundaries which you set.
### namedChunks
Default: `true`
Names the produced bundles according to their entry file
### deployUrl
URL where the application will be deployed.
### es2015Polyfills
Conditional polyfills loaded in browsers which do not support ES2015.
### extractCss
Extract css into a .css file
### extractLicenses
Extract all licenses in a separate file, in the case of production builds only.
### index
HTML File which will be contain the application
### main
The name of the main entry-point file.
### tsConfig
The name of the Typescript configuration file.
### outputPath
The output path of the generated files.
### progress
Log progress to the console while building.
### optimization
Enables optimization of the build output.
### outputHashing
Default: `none`
Define the output filename cache-busting hashing mode.
### scripts
External Scripts which will be included before the main application entry.
### showCircularDependencies
Default: `true`
Show circular dependency warnings on builds.
### sourceMap
Default: `true`
Output sourcemaps.
### statsJson
Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https://webpack.github.io/
analyse.
### styles
External Styles which will be included with the application
### subresourceIntegrity
Enables the use of subresource integrity validation.
### vendorChunk
Default: `true`
Use a separate bundle containing only vendor libraries.
### verbose
Emits verbose output
### watch
Enable re-building when files change.
### help
Show help information
### version
Show version number
## Web-Build Options
### assets
List of static application assets.
### fileReplacements
Replace files with other files in the build.
### maxWorkers
Number of workers to use for type checking.
Default: `# of CPUS - 2`
### memoryLimit
Memory limit for type checking service process in MB.
Default: `2048`
### polyfills
Polyfills to load before application
### stylePreprocessorOptions
Options to pass to style preprocessors.
### webpackConfig
Path to a function which takes a webpack config, some context and returns the resulting webpack config
## Angular Options
### aot
Build using Ahead of Time compilation.
### buildEventLog
**EXPERIMENTAL** Output file path for Build Event Protocol events
### buildOptimizer
Enables `@angular-devkit/build-optimizer` optimizations when using the `--aot` option.
### configuration (-c)
A named build target, as specified in the "configurations" section of angular.json.
Each named target is accompanied by a configuration of option defaults for that target.
Setting this explicitly overrides the "--prod" flag
### crossOrigin
Define the crossorigin attribute setting of elements that provide CORS support.
### deleteOutputPath
Delete the output path before building.
### deployUrl
URL where files will be deployed.
### es5BrowserSupport
Enables conditionally loaded ES2015 polyfills.
### evalSourceMap
Output in-file eval sourcemaps.
### experimentalRollupPass
Concatenate modules with Rollup before bundling them with Webpack.
### forkTypeChecker
Run the TypeScript type checker in a forked process.
### i18nFile
Localization file to use for i18n.
### i18nFormat
Format of the localization file specified with --i18n-file.
### i18nLocale
Locale to use for i18n.
### i18nMissingTranslation
How to handle missing translations for i18n.
### localize
### ngswConfigPath
Path to ngsw-config.json.
### poll
Enable and define the file watching poll time period in milliseconds.
### polyfills
The full path for the polyfills file, relative to the current workspace.
### preserveSymlinks
Do not use the real path when resolving modules.
### rebaseRootRelativeCssUrls
Change root relative URLs in stylesheets to include base HREF and deploy URL. Use only for compatibility and transition. The behavior of this option is non-standard and will be removed in the next major release.
### resourcesOutputPath
The path where style resources will be placed, relative to outputPath.
### serviceWorker
Generates a service worker config for production builds.
### skipAppShell
Flag to prevent building an app shell.
### vendorSourceMap
Resolve vendor packages sourcemaps.
### verbose
Adds more details to output logging.
### webWorkerTsConfig
TypeScript configuration for Web Worker modules.

View File

@ -0,0 +1,89 @@
# dep-graph
Graph dependencies within workspace
## Usage
```bash
nx dep-graph
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Open the dep graph of the workspace in the browser:
```bash
nx dep-graph
```
Save the dep graph into a json file:
```bash
nx dep-graph --file=output.json
```
Generate a static website with dep graph into an html file, accompanied by an asset folder called static:
```bash
nx dep-graph --file=output.html
```
Show the graph where every node is either an ancestor or a descendant of todos-feature-main:
```bash
nx dep-graph --focus=todos-feature-main
```
Include project-one and project-two in the dep graph:
```bash
nx dep-graph --include=project-one,project-two
```
Exclude project-one and project-two from the dep graph:
```bash
nx dep-graph --exclude=project-one,project-two
```
Show the graph where every node is either an ancestor or a descendant of todos-feature-main, but exclude project-one and project-two:
```bash
nx dep-graph --focus=todos-feature-main --exclude=project-one,project-two
```
## Options
### exclude
List of projects delimited by commas to exclude from the dependency graph.
### file
output file (e.g. --file=output.json or --file=dep-graph.html)
### focus
Use to show the dependency graph for a particular project and every node that is either an ancestor or a descendant.
### groupByFolder
Group projects by folder in dependency graph
### help
Show help
### host
Bind the dep graph server to a specific ip address.
### port
Bind the dep graph server to a specific port.
### version
Show version number

View File

@ -0,0 +1,151 @@
# e2e
Builds and serves an app, then runs end-to-end tests using the configured E2E test runner.
## Usage
The `e2e` command is a built-in alias to the [run command](/{{framework}}/cli/run).
These two commands are equivalent:
```bash
nx e2e <project>
```
```bash
nx run <project>:e2e
```
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Run E2E test with a custom base url:
```bash
nx e2e myapp-e2e --base-url http://localhost:4201
```
Run E2E test with a specific target:
```bash
nx e2e myapp-e2e --configuration smoke
```
Run E2E test in watch mode:
```bash
nx e2e myapp-e2e --watch
```
## Common Options
The options below are common to the E2E commands used within an Nx workspace. Cypress and Protractor-specifc options are listed below.
### baseUrl
Use this to pass directly the address of your distant server address with the port running your application.
### configuration (-c)
A named build target, as specified in the "configurations" section of angular.json. Each named target is accompanied by a configuration of option defaults for that target. Setting this explicitly overrides the `--prod` option.
### devServerTarget
Dev server target to run tests against.
### prod
Shorthand for `--configuration=production`. When true, sets the build configuration to the production target. By default, the production target is set up in the workspace configuration such that all builds make use of bundling, limited tree-shaking, and also limited dead code elimination.
### version
Show version number
### watch
Open the Cypress test runner & autmatically run tests when files are updated
## Cypress Options
### browser
The browser to run tests in.
### ci-build-id
A unique identifier for a run to enable grouping or parallelization.
### ci-build-id
A unique identifier for a run to enable grouping or parallelization.
### cypress-config
The path of the Cypress configuration json file.
### exit
Whether or not the Cypress Test Runner will stay open after running tests in a spec file
### group
A named group for recorded runs in the Cypress dashboard.
### headless
Whether or not to open the Cypress application to run the tests. If set to 'true', will run in headless mode.
### help
Shows a help message for this command in the console.
### key
The key cypress should use to run tests in parallel/record the run (CI only).
### parallel
Whether or not Cypress should run its tests in parallel (CI only).
### record
Whether or not Cypress should record the results of the tests
### spec
A comma delimited glob string that is provided to the Cypress runner to specify which spec files to run. For example: '**examples/**,**actions.spec**
### ts-config
The path of the Cypress tsconfig configuration json file.
## Protractor Options
### element-explorer
Start Protractor's Element Explorer for debugging.
### host
Host to listen on.
### port
The port to use to serve the application.
### protractor-config
The name of the Protractor configuration file.
### specs
Override specs in the protractor config.
### suite
Override suite in the protractor config.
### webdriver-update
Try to update webdriver.

View File

@ -0,0 +1,81 @@
# format:check
Check for un-formatted files
## Usage
```bash
nx format:check
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### libs-and-apps
### only-failed
Default: `false`
Isolate projects which previously failed
### projects
Projects to format (comma delimited)
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,81 @@
# format:write
Overwrite un-formatted files
## Usage
```bash
nx format:write
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### libs-and-apps
### only-failed
Default: `false`
Isolate projects which previously failed
### projects
Projects to format (comma delimited)
### runner
This is the name of the tasks runner configured in nx.json
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,93 @@
# generate
Runs a schematic that generates and/or modifies files based on a schematic from a collection.
## Usage
```bash
nx generate <collection:schematic>
```
```bash
nx g <schematic>
```
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Generate a new Angular application:
```bash
nx generate @nrwl/angular:app myapp
```
Generate a new React application:
```bash
nx generate @nrwl/react:app myapp
```
Generate a new web component application:
```bash
nx generate @nrwl/web:app myapp
```
Generate a new Node application:
```bash
nx generate @nrwl/node:app myapp
```
Generate a new Angular library application:
```bash
nx generate @nrwl/angular:library mylibrary
```
Generate a new React library application:
```bash
nx generate @nrwl/react:library mylibrary
```
Generate a new Node library application:
```bash
nx generate @nrwl/node:library mylibrary
```
## Options
### defaults
Default: `false`
When true, disables interactive input prompts for options with a default.
### dryRun
Default: `false`
When true, disables interactive input prompts for options with a default.
### force
Default: `false`
When true, forces overwriting of existing files.
### interactive
Default: `true`
When false, disables interactive input prompts.
### help
Show help and display available schematics in the default collection.
### version
Show version number

View File

@ -0,0 +1,105 @@
# lint
Runs linting tools on application code in a given project folder using the configured linter.
## Usage
The `lint` command is a built-in alias to the [run command](/{{framework}}/cli/run).
These two commands are equivalent:
```bash
nx lint <project> [options]
```
```bash
nx run <project>:lint [options]
```
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Run lint checks for the `myapp` project and fix linter errors:
```bash
nx lint myapp --fix
```
## Common Options
The options below are common to the `lint` command used within an Nx workspace. The ESLint and Angular-specifc lint options are listed after these options.
### exclude
Files to exclude from linting.
### files
Files to include in linting.
### fix
Fixes linting errors (may overwrite linted files).
### force
Succeeds even if there was linting errors.
### format
ESLint Output formatter (https://eslint.org/docs/user-guide/formatters). (default: stylish)
### silent
Hide output text.
### tsConfig
The name of the TypeScript configuration file.
### help
Show help information
### version
Show version number
## ESLint Options
### cache
Only check changed files.
### cacheLocation
Path to the cache file or directory.
### config
The name of the configuration file.
### linter
The tool to use for running lint checks.
Default: `tslint`
### outputFile
File to write report to.
## Angular-TSLint Options
### configuration (-c)
The linting configuration to use.
### tslint-config
The name of the TSLint configuration file.
### type-check
Controls the type check for linting.

View File

@ -0,0 +1,41 @@
# list
Lists installed plugins, capabilities of installed plugins and other available plugins.
## Usage
```bash
nx list
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
List the plugins installed in the current workspace:
```bash
nx list
```
List the schematics and builders available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
```bash
nx list @nrwl/web
```
## Options
### help
Show help
### plugin
Default: `null`
The name of an installed plugin to query
### version
Show version number

View File

@ -0,0 +1,60 @@
# migrate
Creates a migrations file or runs migrations from the migrations file.
- Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)
- Run migrations (e.g., nx migrate --run-migrations=migrations.json)
## Usage
```bash
nx migrate
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Update @nrwl/workspace to "next". This will update other packages and will generate migrations.json.:
```bash
nx migrate next
```
Update @nrwl/workspace to "9.0.0". This will update other packages and will generate migrations.json.:
```bash
nx migrate 9.0.0
```
Update @nrwl/workspace and generate the list of migrations starting with version 8.0.0 of @nrwl/workspace and @nrwl/node, regardless of what installed locally.:
```bash
nx migrate @nrwl/workspace@9.0.0 --from="@nrwl/workspace@8.0.0,@nrwl/node@8.0.0"
```
Update @nrwl/workspace to "9.0.0". If it tries to update @nrwl/react or @nrwl/angular, use version "9.0.1".:
```bash
nx migrate @nrwl/workspace@9.0.0 --to="@nrwl/react@9.0.1,@nrwl/angular@9.0.1"
```
Update another-package to "12.0.0". This will update other packages and will generate migrations.json file.:
```bash
nx migrate another-package@12.0.0
```
Run migrations from the migrations.json file. You can modify migrations.json and run this command many times.:
```bash
nx migrate --run-migrations=migrations.json
```
## Options
### help
Show help
### version
Show version number

View File

@ -0,0 +1,115 @@
# print-affected
Graph execution plan
## Usage
```bash
nx print-affected
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
### Examples
Print information about affected projects and the dependency graph.:
```bash
nx print-affected
```
Print information about the projects affected by the changes between master and HEAD (e.g,. PR).:
```bash
nx print-affected --base=master --head=HEAD
```
Prints information about the affected projects and a list of tasks to test them.:
```bash
nx print-affected --target=test
```
Prints information about the affected projects and a list of tasks to build them and their dependencies.:
```bash
nx print-affected --target=build --with-deps
```
Prints the projects property from the print-affected output.:
```bash
nx print-affected --target=build --select=projects
```
Prints the tasks.target.project property from the print-affected output.:
```bash
nx print-affected --target=build --select=tasks.target.project
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### configuration
This is the configuration to use when performing tasks on projects
### exclude
Default: ``
Exclude certain projects from being processed
### files
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head
Latest commit of the current branch (usually HEAD)
### help
Show help
### only-failed
Default: `false`
Isolate projects which previously failed
### runner
This is the name of the tasks runner configured in nx.json
### select
### skip-nx-cache
Default: `false`
Rerun the tasks even when the results are available in the cache
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,21 @@
# report
Reports useful version numbers to copy into the Nx issue template
## Usage
```bash
nx report
```
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
## Options
### help
Show help
### version
Show version number

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