docs(nx): generate different flavours of nx docs

This commit is contained in:
Victor Savkin 2019-08-14 13:23:37 -04:00
parent 2c18f6aad7
commit 9a8f637899
179 changed files with 7024 additions and 203 deletions

View File

@ -8,7 +8,7 @@ Print applications affected by changes
affected:apps affected:apps
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Build applications and publishable libraries affected by changes
affected:build affected:build
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Graph dependencies affected by changes
affected:dep-graph affected:dep-graph
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Run e2e tests for the applications affected by changes
affected:e2e affected:e2e
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Print libraries affected by changes
affected:libs affected:libs
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Lint projects affected by changes
affected:lint affected:lint
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Test projects affected by changes
affected:test affected:test
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Run task for affected projects
affected affected
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Graph dependencies within workspace
dep-graph dep-graph
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Check for un-formatted files
format:check format:check
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Overwrite un-formatted files
format:write format:write
``` ```
## Options ## Options
### all ### all

View File

@ -8,7 +8,7 @@ Lint workspace or list of files
workspace-lint [files..] workspace-lint [files..]
``` ```
## Options ## Options
### help ### help

View File

@ -8,7 +8,7 @@ Runs a workspace schematic from the tools/schematics directory
workspace-schematic [name] workspace-schematic [name]
``` ```
## Options ## Options
### help ### help

View File

@ -0,0 +1,138 @@
# application
Create an Angular application
## Usage
```bash
nx generate application ...
```
## Options
### directory
Type: `string`
The directory of the new application.
### e2eTestRunner
Default: `cypress`
Type: `string`
Test runner to use for end to end (e2e) tests
### enableIvy
Default: `false`
Type: `boolean`
**EXPERIMENTAL** True to 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`
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.
### style
Default: `css`
Type: `string`
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`
Test runner to use for unit tests
### viewEncapsulation
Type: `string`
Specifies the view encapsulation strategy.

View File

@ -0,0 +1,46 @@
# downgrade-module
Setup Downgrade Module
## Usage
```bash
nx generate downgrade-module ...
```
## 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,18 @@
# karma-project
Add karma testing to a project
## Usage
```bash
nx generate karma-project ...
```
## Options
### project
Type: `string`
The name of the project.

View File

@ -0,0 +1,10 @@
# karma
Add karma configuration to a workspace
## Usage
```bash
nx generate karma ...
```

View File

@ -0,0 +1,116 @@
# library
Create an Angular library
## Usage
```bash
nx generate library ...
```
## Options
### directory
Type: `string`
A directory where the app is placed
### lazy
Default: `false`
Type: `boolean`
Add RouterModule.forChild when set to true, and a simple array of routes when set to false.
### 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 simple TS library when set to true.
### 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.
### style
Default: `css`
Type: `string`
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`
Test runner to use for unit tests

View File

@ -0,0 +1,44 @@
# ng-add [hidden]
Add @nrwl/angular to a project
## Usage
```bash
nx generate ng-add ...
```
## Options
### e2eTestRunner
Default: `cypress`
Type: `string`
Test runner to use for end to end (e2e) tests
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### skipInstall
Default: `false`
Type: `boolean`
Skip installing after adding @nrwl/workspace
### unitTestRunner
Default: `jest`
Type: `string`
Test runner to use for unit tests

View File

@ -0,0 +1,104 @@
# ngrx
Add an ngrx config to a project
## Usage
```bash
nx generate ngrx ...
```
## Options
### 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: `false`
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: `classes`
Type: `string`
Specifies whether to use class-based or creator functions for actions, reducers, and effects.

View File

@ -0,0 +1,60 @@
# upgrade-module
Add an upgrade module
## Usage
```bash
nx generate upgrade-module ...
```
## 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,93 @@
# cypress
Run Cypress e2e tests
## 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.
### 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
### 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
### 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
### 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,38 @@
# cypress-project [hidden]
Add a Cypress E2E Project
## Usage
```bash
nx generate cypress-project ...
```
## Options
### directory
Type: `string`
A directory where the project is placed
### linter
Default: `tslint`
Type: `string`
The tool to use for running lint checks.
### name
Type: `string`
Name of the E2E Project
### project
Type: `string`
The name of the frontend project to test.

View File

@ -0,0 +1,10 @@
# ng-add [hidden]
Add Cypress configuration to the workspace
## Usage
```bash
nx generate ng-add ...
```

View File

@ -0,0 +1,68 @@
# application
Create an express application
## Usage
```bash
nx generate application ...
```
## 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: `tslint`
Type: `string`
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`
Test runner to use for unit tests

View File

@ -0,0 +1,20 @@
# ng-add [hidden]
Add @nrwl/express to a project
## Usage
```bash
nx generate ng-add ...
```
## Options
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,199 @@
# jest
Run Jest unit tests
## Properties
### bail
Alias(es): b
Type: `number`
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
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
### coverage
Type: `boolean`
Indicates that test coverage information should be collected and reported in the output. This option is also aliased by --collectCoverage. (https://jestjs.io/docs/en/cli#coverage)
### coverageDirectory
Type: `string`
An array of regexp pattern strings that are matched against all file paths before executing the test. If the file path matches any of the patterns, coverage information will be skipped.
### coverageReporters
Type: `string`
A list of reporter names that Jest uses when writing coverage reports. Any istanbul reporter
### 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`
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`
The name of a setup file used by Jest. (https://jestjs.io/docs/en/configuration#setupfilesafterenv-array)
### 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.
### 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: `string`
A regexp pattern string that is matched against all tests paths before executing the test. (https://jestjs.io/docs/en/cli#testpathpattern-regex)
### tsConfig
Type: `string`
The name of the Typescript configuration 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: `string`
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,50 @@
# jest-project [hidden]
Add Jest configuration to a project
## Usage
```bash
nx generate jest-project ...
```
## Options
### project
Type: `string`
The name of the project.
### setupFile
Default: `none`
Type: `string`
The setup file to be generated
### skipSerializers
Default: `false`
Type: `boolean`
Skips the serializers required to snapshot angular templates
### skipSetupFile
Default: `false`
Type: `boolean`
[Deprecated]: Skips the setup file required for angular. (Use --setup-file)
### supportTsx
Default: `false`
Type: `boolean`
Setup tsx support

View File

@ -0,0 +1,10 @@
# ng-add [hidden]
Add Jest configuration to the workspace
## Usage
```bash
nx generate ng-add ...
```

View File

@ -0,0 +1,53 @@
# lint
Lint a project
## Properties
### 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).
### format
Default: `prose`
Type: `string`
Output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist).
### linter
Default: `tslint`
Type: `string`
The tool to use for running lint checks.
### tsConfig
Type: `string`
The name of the TypeScript configuration file.

View File

@ -0,0 +1,68 @@
# application
Create a nest application
## Usage
```bash
nx generate application ...
```
## 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: `tslint`
Type: `string`
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`
Test runner to use for unit tests

View File

@ -0,0 +1,20 @@
# ng-add [hidden]
Add @nrwl/nest to a project
## Usage
```bash
nx generate ng-add ...
```
## Options
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,131 @@
# build
Build a Node application
## Properties
### assets
Type: `array`
List of static application assets.
### externalDependencies
Default: `all`
Type: `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: `array` of `object`
Replace files with other files in the build.
#### replace
Type: `string`
undefined
#### with
Type: `string`
undefined
### 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)
### optimization
Default: `false`
Type: `boolean`
Defines the optimization level of the build.
### 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,47 @@
# execute
Execute a Node application
## 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`
Ensures the app is starting with debugging
### port
Default: `7777`
Type: `number`
The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes.
### waitUntilTargets
Type: `array`
The targets to run to before starting the node app

View File

@ -0,0 +1,68 @@
# application
Create a node application
## Usage
```bash
nx generate application ...
```
## 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: `tslint`
Type: `string`
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`
Test runner to use for unit tests

View File

@ -0,0 +1,20 @@
# ng-add [hidden]
Add @nrwl/node to a project
## Usage
```bash
nx generate ng-add ...
```
## Options
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,118 @@
# application
Create an application
## Usage
```bash
nx generate application ...
```
## Options
### babel
Default: `false`
Type: `boolean`
Use Babel and TypeScript preset instead of ts-loader (Useful if you need Babel plugins)
### 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`
Test runner to use for end to end (e2e) tests
### linter
Default: `tslint`
Type: `string`
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
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`
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`
Test runner to use for unit tests

View File

@ -0,0 +1,88 @@
# component
Create a component
## Usage
```bash
nx generate component ...
```
## 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).
### 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`
The file extension to be used for style files.

View File

@ -0,0 +1,100 @@
# library
Create a library
## Usage
```bash
nx generate library ...
```
## Options
### appProject
Alias(es): a
Type: `string`
The application project to add the library route to
### directory
Alias(es): d
Type: `string`
A directory where the app is placed
### linter
Default: `tslint`
Type: `string`
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)
### 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`
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`
Test runner to use for unit tests

View File

@ -0,0 +1,20 @@
# ng-add [hidden]
Add @nrwl/react to a project
## Usage
```bash
nx generate ng-add ...
```
## Options
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,221 @@
# build
Build a application
## 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.
### commonChunk
Default: `true`
Type: `boolean`
Use a separate bundle containing code used across multiple bundles.
### deployUrl
Type: `string`
URL where the application will be deployed.
### differentialLoading
Default: `true`
Type: `boolean`
Enable differential loading for es5 browsers
### 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: `array` of `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)
### 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`
Define the output filename cache-busting hashing mode.
### 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,77 @@
# dev-server
Serve a web application
## Properties
### 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.
### 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,70 @@
# application
Create an application
## Usage
```bash
nx generate application ...
```
## Options
### directory
Type: `string`
The directory of the new application.
### e2eTestRunner
Default: `cypress`
Type: `string`
Test runner to use for end to end (e2e) tests
### linter
Default: `tslint`
Type: `string`
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`
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`
Test runner to use for unit tests

View File

@ -0,0 +1,20 @@
# ng-add [hidden]
Add @nrwl/web to a project
## Usage
```bash
nx generate ng-add ...
```
## Options
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,35 @@
# run-commands
Run commands
## Properties
### args
Type: `string`
Extra arguments. You can pass them as follows: ng run project:target --args='--wait=100'. You can them use {args.wait} syntax to interpolate them in the workspace config file.
### commands
Type: `array` of `object`
#### command
Type: `string`
Command to run in child process
### 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,59 @@
# affected:apps
Print applications affected by changes
## Usage
```bash
affected:apps
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,71 @@
# affected:build
Build applications and publishable libraries affected by changes
## Usage
```bash
affected:build
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,63 @@
# affected:dep-graph
Graph dependencies affected by changes
## Usage
```bash
affected:dep-graph
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### file
output file (e.g. --file=.vis/output.json)
### files
A 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
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,71 @@
# affected:e2e
Run e2e tests for the applications affected by changes
## Usage
```bash
affected:e2e
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,59 @@
# affected:libs
Print libraries affected by changes
## Usage
```bash
affected:libs
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,71 @@
# affected:lint
Lint projects affected by changes
## Usage
```bash
affected:lint
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,71 @@
# affected:test
Test projects affected by changes
## Usage
```bash
affected:test
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,75 @@
# affected
Run task for affected projects
## Usage
```bash
affected
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### 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,63 @@
# dep-graph
Graph dependencies within workspace
## Usage
```bash
dep-graph
```
## Options
### all
All projects
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### file
output file (e.g. --file=.vis/output.json)
### files
A 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
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,61 @@
# format:check
Check for un-formatted files
## Usage
```bash
format:check
```
## Options
### all
All projects
### apps-and-libs
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,61 @@
# format:write
Overwrite un-formatted files
## Usage
```bash
format:write
```
## Options
### all
All projects
### apps-and-libs
### base
Base of the current branch (usually master)
### exclude
Default: ``
Exclude certain projects from being processed
### files
A 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
### uncommitted
Uncommitted changes
### untracked
Untracked changes
### verbose
Print additional error stack trace on failure
### version
Show version number

View File

@ -0,0 +1,19 @@
# workspace-lint [files..]
Lint workspace or list of files
## Usage
```bash
workspace-lint [files..]
```
## Options
### help
Show help
### version
Show version number

View File

@ -0,0 +1,27 @@
# workspace-schematic [name]
Runs a workspace schematic from the tools/schematics directory
## Usage
```bash
workspace-schematic [name]
```
## Options
### help
Show help
### list-schematics
List the available workspace-schematics
### name
The name of your schematic`
### version
Show version number

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