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

chore(tools): documentation properties sorted

Browse Source
This commit is contained in:
ben 2019-03-08 17:28:01 -05:00 committed by Victor Savkin
parent a84d6715a4
commit 7e776f3f9c
36 changed files with 1208 additions and 1182 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/api-builders/cypress.md
View File

@ -4,26 +4,24 @@ 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.
### cypressConfig
Type: `string`
The path of the Cypress configuration json file.
### watch
Default: `false`
Type: `boolean`
Recompile and run tests when files change.
### tsConfig
Type: `string`
The path of the Cypress tsconfig configuration json file.
### devServerTarget
Type: `string`
@ -54,14 +52,16 @@ Type: `boolean`
Whether or not Cypress should record the results of the tests
### baseUrl
### tsConfig
Type: `string`
Use this to pass directly the address of your distant server address with the port running your application
The path of the Cypress tsconfig configuration json file.
### browser
### watch
Type: `string`
Default: `false`
The browser to run tests in.
Type: `boolean`
Recompile and run tests when files change.

96
docs/api-builders/jest.md
View File

@ -4,13 +4,23 @@ Run Jest unit tests
## Properties
### updateSnapshot
Alias(es): u
### bail
Type: `boolean`
Re-record all failing snapshots. (https://jestjs.io/docs/en/cli#updatesnapshot)
Exit the test suite immediately upon the first failing test suite. (https://jestjs.io/docs/en/cli#bail)
### ci
Type: `boolean`
Fail on missing snapshots. (https://jestjs.io/docs/en/cli#ci)
### codeCoverage
Type: `boolean`
Export a code coverage report. (https://jestjs.io/docs/en/cli#coverage)
### jestConfig
@ -18,19 +28,11 @@ Type: `string`
The path of the Jest configuration. (https://jestjs.io/docs/en/configuration.html)
### setupFile
### maxWorkers
Type: `string`
Type: `number`
The name of a setup file used by Jest. (https://jestjs.io/docs/en/configuration.html#setuptestframeworkscriptfile-string)
### watch
Default: `false`
Type: `boolean`
Run tests when files change. (https://jestjs.io/docs/en/cli#watch)
Max number of workers to run tests across. Useful for CI. (https://jestjs.io/docs/en/cli.html#maxworkers-num)
### onlyChanged
@ -46,47 +48,23 @@ Type: `boolean`
Allow test suite to pass when no test files are found. (https://jestjs.io/docs/en/cli#passwithnotests)
### codeCoverage
Type: `boolean`
Export a code coverage report. (https://jestjs.io/docs/en/cli#coverage)
### tsConfig
Type: `string`
The name of the Typescript configuration file.
### ci
Type: `boolean`
Fail on missing snapshots. (https://jestjs.io/docs/en/cli#ci)
### bail
Type: `boolean`
Exit the test suite immediately upon the first failing test suite. (https://jestjs.io/docs/en/cli#bail)
### silent
Type: `boolean`
Prevent tests from printing messages through the console. (https://jestjs.io/docs/en/cli#silent)
### runInBand
Type: `boolean`
Run tests in a single process as opposed to multiple workers. Useful for CI. (https://jestjs.io/docs/en/cli.html#runinband)
### maxWorkers
### setupFile
Type: `number`
Type: `string`
Max number of workers to run tests across. Useful for CI. (https://jestjs.io/docs/en/cli.html#maxworkers-num)
The name of a setup file used by Jest. (https://jestjs.io/docs/en/configuration.html#setuptestframeworkscriptfile-string)
### silent
Type: `boolean`
Prevent tests from printing messages through the console. (https://jestjs.io/docs/en/cli#silent)
### testNamePattern
@ -95,3 +73,25 @@ Alias(es): t
Type: `string`
Run only tests with a name that matches the regex. (https://jestjs.io/docs/en/cli.html#testnamepattern-regex)
### tsConfig
Type: `string`
The name of the Typescript configuration file.
### updateSnapshot
Alias(es): u
Type: `boolean`
Re-record all failing snapshots. (https://jestjs.io/docs/en/cli#updatesnapshot)
### watch
Default: `false`
Type: `boolean`
Run tests when files change. (https://jestjs.io/docs/en/cli#watch)

106
docs/api-builders/node-build.md
View File

@ -12,56 +12,6 @@ Type: `string`
Dependencies to keep external to the bundle. ("all" (default), "none", or an array of module names)
### main
Type: `string`
The name of the main entry-point file.
### watch
Default: `false`
Type: `boolean`
Run build when files change.
### poll
Type: `number`
Frequency of file watcher in ms.
### sourceMap
Default: `true`
Type: `boolean`
Produce source maps.
### progress
Default: `false`
Type: `boolean`
Log progress to the console while building.
### tsConfig
Type: `string`
The name of the Typescript configuration file.
### 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.
### extractLicenses
Default: `false`
@ -70,6 +20,18 @@ Type: `boolean`
Extract all licenses in a separate file, in the case of production builds only.
### 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`
@ -78,6 +40,20 @@ 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`
@ -86,11 +62,35 @@ Type: `boolean`
Show circular dependency warnings on builds.
### maxWorkers
### sourceMap
Type: `number`
Default: `true`
Number of workers to use for type checking. (defaults to # of CPUS - 2)
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.
### watch
Default: `false`
Type: `boolean`
Run build when files change.
### webpackConfig

32
docs/api-builders/node-execute.md
View File

@ -4,26 +4,18 @@ 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
### waitUntilTargets
Type: `array`
The targets to run to before starting the node app
### port
Default: `7777`
Type: `number`
The port to inspect the process on
### inspect
Default: `inspect`
@ -32,8 +24,16 @@ Type: `string`
Ensures the app is starting with debugging
### args
### port
Default: `7777`
Type: `number`
The port to inspect the process on
### waitUntilTargets
Type: `array`
Extra args when starting the app
The targets to run to before starting the node app

226
docs/api-builders/web-build.md
View File

@ -4,28 +4,6 @@ Build a web application
## Properties
### namedChunks
Default: `true`
Type: `boolean`
Names the produced bundles according to their entry file
### main
Type: `string`
The name of the main entry-point file.
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.
### baseHref
Default: `/`
@ -34,20 +12,6 @@ Type: `string`
Base url for the application being built.
### deployUrl
Type: `string`
URL where the application will be deployed.
### vendorChunk
Default: `true`
Type: `boolean`
Use a separate bundle containing only vendor libraries.
### commonChunk
Default: `true`
@ -56,59 +20,17 @@ Type: `boolean`
Use a separate bundle containing code used across multiple bundles.
### sourceMap
Default: `true`
Type: `boolean`
Output sourcemaps.
### progress
Default: `false`
Type: `boolean`
Log progress to the console while building.
### index
### deployUrl
Type: `string`
HTML File which will be contain the application
URL where the application will be deployed.
### scripts
Type: `array`
External Scripts which will be included before the main application entry
### styles
Type: `array`
External Styles which will be included with the application
### tsConfig
### es2015Polyfills
Type: `string`
The name of the Typescript configuration file.
### outputHashing
Default: `none`
Type: `string`
Define the output filename cache-busting hashing mode.
### optimization
Type: `boolean`
Enables optimization of the build output.
Conditional polyfills loaded in browsers which do not support ES2015.
### extractCss
@ -118,34 +40,6 @@ Type: `boolean`
Extract css into a .css file
### es2015Polyfills
Type: `string`
Conditional polyfills loaded in browsers which do not support ES2015.
### subresourceIntegrity
Default: `false`
Type: `boolean`
Enables the use of subresource integrity validation.
### polyfills
Type: `string`
Polyfills to load before application
### 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.
### extractLicenses
Default: `false`
@ -154,6 +48,66 @@ Type: `boolean`
Extract all licenses in a separate file, in the case of production builds only.
### 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`
@ -162,11 +116,57 @@ Type: `boolean`
Show circular dependency warnings on builds.
### maxWorkers
### sourceMap
Type: `number`
Default: `true`
Number of workers to use for type checking. (defaults to # of CPUS - 2)
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.
### watch
Default: `false`
Type: `boolean`
Enable re-building when files change.
### webpackConfig

84
docs/api-builders/web-dev-server.md
View File

@ -10,14 +10,6 @@ Type: `string`
Target which builds the application
### port
Default: `4200`
Type: `number`
Port to listen on.
### host
Default: `localhost`
@ -26,34 +18,6 @@ Type: `string`
Host to listen on.
### ssl
Default: `false`
Type: `boolean`
Serve using HTTPS.
### sslKey
Type: `string`
SSL key to use for serving HTTPS.
### sslCert
Type: `string`
SSL certificate to use for serving HTTPS.
### watch
Default: `true`
Type: `boolean`
Watches for changes and rebuilds application
### liveReload
Default: `true`
@ -62,12 +26,6 @@ Type: `boolean`
Whether to reload the page on change, using live-reload.
### publicHost
Type: `string`
Public URL where the application will be served
### open
Default: `false`
@ -75,3 +33,45 @@ 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

72
docs/api-npmscripts/affected-apps.md
View File

@ -10,31 +10,51 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,26 +64,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
Show version number

72
docs/api-npmscripts/affected-build.md
View File

@ -10,31 +10,51 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,26 +64,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
Show version number

80
docs/api-npmscripts/affected-dep-graph.md
View File

@ -10,31 +10,55 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,30 +68,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
Show version number

72
docs/api-npmscripts/affected-e2e.md
View File

@ -10,31 +10,51 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,26 +64,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
Show version number

72
docs/api-npmscripts/affected-libs.md
View File

@ -10,31 +10,51 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,26 +64,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
Show version number

80
docs/api-npmscripts/affected-lint.md
View File

@ -10,31 +10,55 @@ affected:lint
## 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,30 +68,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
Show version number

72
docs/api-npmscripts/affected-test.md
View File

@ -10,31 +10,51 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,26 +64,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
Show version number

72
docs/api-npmscripts/affected.md
View File

@ -10,31 +10,51 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,26 +64,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
Show version number

80
docs/api-npmscripts/dep-graph.md
View File

@ -10,31 +10,55 @@ 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,30 +68,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
Show version number

84
docs/api-npmscripts/format-check.md
View File

@ -10,31 +10,57 @@ 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
### 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,32 +70,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
### apps-and-libs
Show version number

84
docs/api-npmscripts/format-write.md
View File

@ -10,31 +10,57 @@ 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
### 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,32 +70,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
### apps-and-libs
Show version number

84
docs/api-npmscripts/lint-files.md
View File

@ -10,31 +10,57 @@ lint [files..]
## Options
### all
All projects
### apps-and-libs
### 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,32 +70,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
### apps-and-libs
Show version number

84
docs/api-npmscripts/update-check.md
View File

@ -10,31 +10,57 @@ update:check
## Options
### all
All projects
### apps-and-libs
### 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,32 +70,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
### apps-and-libs
Show version number

84
docs/api-npmscripts/update-skip.md
View File

@ -10,31 +10,57 @@ update:skip
## Options
### all
All projects
### apps-and-libs
### 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,32 +70,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
### apps-and-libs
Show version number

84
docs/api-npmscripts/update.md
View File

@ -10,31 +10,57 @@ update
## Options
### all
All projects
### apps-and-libs
### 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
### version
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
### maxParallel
Default: `3`
Max number of parallel processes
### files
### only-failed
A list of files delimited by commas
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,32 +70,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
### apps-and-libs
Show version number

96
docs/api-npmscripts/workspace-schematic-name.md
View File

@ -10,21 +10,41 @@ workspace-schematic [name]
## Options
### all
All projects
### apps-and-libs
### 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
### version
### list-schematics
Show version number
### quiet
### parallel
Default: `false`
Parallelize the command
List the available workspace-schematics
### maxParallel
@ -32,9 +52,23 @@ Default: `3`
Max number of parallel processes
### files
### name
A list of files delimited by commas
The name of your schematic`
### only-failed
Default: `false`
Isolate projects which previously failed
### parallel
Default: `false`
Parallelize the command
### quiet
### uncommitted
@ -44,40 +78,6 @@ Uncommitted changes
Untracked changes
### all
### version
All projects
### base
Base of the current branch (usually master)
### head
Latest commit of the current branch (usually HEAD)
### exclude
Default: ``
Exclude certain projects from being processed
### only-failed
Default: `false`
Isolate projects which previously failed
### file
output file (e.g. --file=.vis/output.json)
### apps-and-libs
### list-schematics
List the available workspace-schematics
### name
The name of your schematic`
Show version number

92
docs/api-schematics/application.md
View File

@ -11,13 +11,19 @@ ng generate application ...
## Options
### prefix
Alias(es): p
### directory
Type: `string`
The prefix to apply to generated selectors.
The directory of the new application.
### e2eTestRunner
Default: `cypress`
Type: `string`
Test runner to use for end to end (e2e) tests
### framework
@ -27,12 +33,6 @@ Type: `string`
The Framework for the application.
### directory
Type: `string`
The directory of the new application.
### inlineStyle
Alias(es): s
@ -53,11 +53,19 @@ Type: `boolean`
Specifies if the template will be in the ts file.
### viewEncapsulation
### name
Type: `string`
Specifies the view encapsulation strategy.
The name of the application.
### prefix
Alias(es): p
Type: `string`
The prefix to apply to generated selectors.
### routing
@ -67,30 +75,6 @@ Type: `boolean`
Generates a routing module.
### name
Type: `string`
The name of the application.
### style
Default: `css`
Type: `string`
The file extension to be used for style files.
### skipTests
Alias(es): S
Default: `false`
Type: `boolean`
Skip creating spec files.
### skipFormat
Default: `false`
@ -107,6 +91,30 @@ 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`
@ -115,16 +123,8 @@ Type: `string`
Test runner to use for unit tests
### e2eTestRunner
Default: `cypress`
### viewEncapsulation
Type: `string`
Test runner to use for end to end (e2e) tests
### tags
Type: `string`
Add tags to the application (used for linting)
Specifies the view encapsulation strategy.

8
docs/api-schematics/downgrade-module.md
View File

@ -11,11 +11,11 @@ ng generate downgrade-module ...
## Options
### project
### angularJsImport
Type: `string`
The name of the project
Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app).
### name
@ -23,11 +23,11 @@ Type: `string`
The name of the main AngularJS module.
### angularJsImport
### project
Type: `string`
Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app).
The name of the project
### skipFormat

16
docs/api-schematics/jest-project.md
View File

@ -17,14 +17,6 @@ Type: `string`
The name of the project.
### skipSetupFile
Default: `false`
Type: `boolean`
[Deprecated]: Skips the setup file required for angular. (Use --setup-file)
### setupFile
Default: `angular`
@ -41,6 +33,14 @@ 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`

156
docs/api-schematics/library.md
View File

@ -11,19 +11,11 @@ ng generate library ...
## Options
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### name
### directory
Type: `string`
Library name
A directory where the app is placed
### framework
@ -33,74 +25,6 @@ Type: `string`
The framework this library uses
### publishable
Default: `false`
Type: `boolean`
Generate a simple TS library when set to true.
### prefix
Alias(es): p
Type: `string`
The prefix to apply to generated selectors.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### simpleModuleName
Default: `false`
Type: `boolean`
Keep the module name simple (when using --directory)
### skipPackageJson
Default: `false`
Type: `boolean`
Do not add dependencies to package.json.
### directory
Type: `string`
A directory where the app is placed
### parentModule
Type: `string`
Update the router configuration of the parent module using loadChildren or children, depending on what `lazy` is set to.
### style
Default: `css`
Type: `string`
The file extension to be used for style files.
### routing
Default: `false`
Type: `boolean`
Add router configuration. See lazy for more information.
### lazy
Default: `false`
@ -117,6 +41,82 @@ Type: `boolean`
[Deprecated]: Include an NgModule in the library.
### 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`

12
docs/api-schematics/ng-add.md
View File

@ -11,6 +11,12 @@ ng generate ng-add ...
## Options
### name
Type: `string`
Project name.
### npmScope
Type: `string`
@ -24,9 +30,3 @@ Default: `false`
Type: `boolean`
Skip installing after adding @nrwl/schematics
### name
Type: `string`
Project name.

40
docs/api-schematics/ng-new.md
View File

@ -11,19 +11,13 @@ ng generate ng-new ...
## Options
### name
### commit
Type: `string`
Default: `true`
The name of the workspace.
Type: `boolean`
### style
Default: `css`
Type: `string`
The file extension to be used for style files.
Initial repository commit information.
### directory
@ -31,19 +25,25 @@ Type: `string`
The directory name to create the workspace in.
### name
Type: `string`
The name of the workspace.
### npmScope
Type: `string`
Npm scope for importing libs.
### skipInstall
### preset
Default: `false`
Default: `empty`
Type: `boolean`
Type: `string`
Skip installing dependency packages.
What to create in the new workspace
### skipGit
@ -55,18 +55,18 @@ Type: `boolean`
Skip initializing a git repository.
### commit
### skipInstall
Default: `true`
Default: `false`
Type: `boolean`
Initial repository commit information.
Skip installing dependency packages.
### preset
### style
Default: `empty`
Default: `css`
Type: `string`
What to create in the new workspace
The file extension to be used for style files.

40
docs/api-schematics/ngrx.md
View File

@ -11,18 +11,6 @@ ng generate ngrx ...
## Options
### name
Type: `string`
Name of the NgRx feature (e.g., Products, Users, etc.). Recommended to use plural form for name.
### module
Type: `string`
Path to ngModule; host directory will contain the new '+state' directory (e.g., libs/comments/src/lib/comments-state.module.ts).
### directory
Default: `+state`
@ -31,14 +19,6 @@ Type: `string`
Override the name of the folder used to contain/group the NgRx files: contains actions, effects, reducers. selectors. (e.g., +state)
### root
Default: `false`
Type: `boolean`
Add StoreModule.forRoot and EffectsModule.forRoot() instead of forFeature (e.g., --root).
### facade
Default: `false`
@ -47,6 +27,18 @@ Type: `boolean`
Create a Facade class for the the Feature (e.g., --facade).
### module
Type: `string`
Path to ngModule; host directory will contain the new '+state' directory (e.g., libs/comments/src/lib/comments-state.module.ts).
### name
Type: `string`
Name of the NgRx feature (e.g., Products, Users, etc.). Recommended to use plural form for name.
### onlyAddFiles
Default: `false`
@ -63,6 +55,14 @@ Type: `boolean`
Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot).
### root
Default: `false`
Type: `boolean`
Add StoreModule.forRoot and EffectsModule.forRoot() instead of forFeature (e.g., --root).
### skipFormat
Default: `false`

36
docs/api-schematics/node-application.md
View File

@ -11,12 +11,6 @@ ng generate node-application ...
## Options
### name
Type: `string`
The name of the application.
### directory
Type: `string`
@ -31,6 +25,18 @@ Type: `string`
Node Framework to use for application.
### frontendProject
Type: `string`
Frontend project that needs to access this application. This sets up proxy configuration.
### name
Type: `string`
The name of the application.
### skipFormat
Default: `false`
@ -47,6 +53,12 @@ Type: `boolean`
Do not add dependencies to package.json.
### tags
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
@ -54,15 +66,3 @@ Default: `jest`
Type: `string`
Test runner to use for unit tests
### tags
Type: `string`
Add tags to the application (used for linting)
### frontendProject
Type: `string`
Frontend project that needs to access this application. This sets up proxy configuration.

36
docs/api-schematics/upgrade-module.md
View File

@ -11,17 +11,11 @@ ng generate upgrade-module ...
## Options
### project
### angularJsCmpSelector
Type: `string`
The name of the project
### name
Type: `string`
The name of the main AngularJS module.
The selector of an AngularJS component (e.g., --angularJsCmpSelector=myComponent)
### angularJsImport
@ -29,11 +23,25 @@ Type: `string`
Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app).
### angularJsCmpSelector
### name
Type: `string`
The selector of an AngularJS component (e.g., --angularJsCmpSelector=myComponent)
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
@ -50,11 +58,3 @@ Default: `false`
Type: `boolean`
Do not add @angular/upgrade to package.json (e.g., --skipPackageJson)
### router
Default: `false`
Type: `boolean`
Sets up router synchronization (e.g., --router)

42
docs/api-schematics/workspace.md
View File

@ -11,19 +11,13 @@ ng generate workspace ...
## Options
### name
### commit
Type: `string`
Default: `true`
The name of the workspace.
Type: `boolean`
### style
Default: `css`
Type: `string`
The file extension to be used for style files.
Initial repository commit information.
### directory
@ -31,20 +25,18 @@ Type: `string`
The directory name to create the workspace in.
### name
Type: `string`
The name of the workspace.
### npmScope
Type: `string`
Npm scope for importing libs.
### skipInstall
Default: `false`
Type: `boolean`
Skip installing dependency packages.
### skipGit
Alias(es): g
@ -55,10 +47,18 @@ Type: `boolean`
Skip initializing a git repository.
### commit
### skipInstall
Default: `true`
Default: `false`
Type: `boolean`
Initial repository commit information.
Skip installing dependency packages.
### style
Default: `css`
Type: `string`
The file extension to be used for style files.

15
scripts/documentation/builders.ts
View File

@ -8,6 +8,7 @@ import {
htmlSelectorFormat,
pathFormat
} from '@angular-devkit/schematics/src/formats';
import { sortAlphabeticallyFunction } from './utils';
/**
* @WhatItDoes: Generates default documentation from the builders' schema.
@ -64,12 +65,14 @@ function generateTemplate(builder): { name: string; template: string } {
if (Array.isArray(builder.options) && !!builder.options.length) {
template += '## Properties';
builder.options.forEach(
option =>
(template += dedent`
builder.options
.sort((a, b) => sortAlphabeticallyFunction(a.name, b.name))
.forEach(
option =>
(template += dedent`
### ${option.name} ${option.required ? '(*__required__*)' : ''} ${
option.hidden ? '(__hidden__)' : ''
}
option.hidden ? '(__hidden__)' : ''
}
${
!!option.aliases.length
@ -86,7 +89,7 @@ function generateTemplate(builder): { name: string; template: string } {
${option.description}
`)
);
);
}
return { name: builder.name, template };

16
scripts/documentation/npmscripts.ts
View File

@ -4,6 +4,7 @@ import * as path from 'path';
import { dedent } from 'tslint/lib/utils';
import { commandsObject } from '../../packages/schematics/src/command-line/nx-commands';
import { sortAlphabeticallyFunction } from './utils';
const commandsOutputDirectory = path.join(
__dirname,
@ -44,9 +45,16 @@ function generateMarkdown(command) {
if (Array.isArray(command.options) && !!command.options.length) {
template += '## Options';
command.options.forEach(
option =>
(template += dedent`
command.options
.sort((a, b) =>
sortAlphabeticallyFunction(
a.command.replace('--', ''),
b.command.replace('--', '')
)
)
.forEach(
option =>
(template += dedent`
### ${option.command.replace('--', '')}
${
option.default === undefined || option.default === ''
@ -55,7 +63,7 @@ function generateMarkdown(command) {
}
${option.description}
`)
);
);
}
return {

15
scripts/documentation/schematics.ts
View File

@ -6,6 +6,7 @@ import {
htmlSelectorFormat,
pathFormat
} from '@angular-devkit/schematics/src/formats';
import { sortAlphabeticallyFunction } from './utils';
const fs = require('fs-extra');
const path = require('path');
@ -79,12 +80,14 @@ function generateTemplate(schematic): { name: string; template: string } {
if (Array.isArray(schematic.options) && !!schematic.options.length) {
template += '## Options';
schematic.options.forEach(
option =>
(template += dedent`
schematic.options
.sort((a, b) => sortAlphabeticallyFunction(a.name, b.name))
.forEach(
option =>
(template += dedent`
### ${option.name} ${option.required ? '(*__required__*)' : ''} ${
option.hidden ? '(__hidden__)' : ''
}
option.hidden ? '(__hidden__)' : ''
}
${
!!option.aliases.length
@ -101,7 +104,7 @@ function generateTemplate(schematic): { name: string; template: string } {
${option.description}
`)
);
);
}
return { name: schematic.name, template };

12
scripts/documentation/utils.ts Normal file
View File

@ -0,0 +1,12 @@
export function sortAlphabeticallyFunction(a: string, b: string): number {
const nameA = a.toUpperCase(); // ignore upper and lowercase
const nameB = b.toUpperCase(); // ignore upper and lowercase
if (nameA < nameB) {
return -1;
}
if (nameA > nameB) {
return 1;
}
// names must be equal
return 0;
}