diff --git a/docs/api-builders/cypress.md b/docs/api-builders/cypress.md index 79560df9d9..48410884fb 100644 --- a/docs/api-builders/cypress.md +++ b/docs/api-builders/cypress.md @@ -2,15 +2,58 @@ Run Cypress e2e tests -### Properties +## Properties -| Name | Description | Type | Default value | -| ----------------- | ------------------------------------------------------------------------------------------------------------- | ------- | ------------- | -| `cypressConfig` | The path of the Cypress configuration json file. | string | `undefined` | -| `watch` | Recompile and run tests when files change. | boolean | `false` | -| `tsConfig` | The path of the Cypress tsconfig configuration json file. | string | `undefined` | -| `devServerTarget` | Dev server target to run tests against. | string | `undefined` | -| `headless` | Whether or not the open the Cypress application to run the tests. If set to 'true', will run in headless mode | boolean | `false` | -| `record` | Whether or not Cypress should record the results of the tests | boolean | `false` | -| `baseUrl` | Use this to pass directly the address of your distant server address with the port running your application | string | `undefined` | -| `browser` | The browser to run tests in. | string | `undefined` | +### 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` + +Dev server target to run tests against. + +### headless + +Default: `false` + +Type: `boolean` + +Whether or not the open the Cypress application to run the tests. If set to 'true', will run in headless mode + +### record + +Default: `false` + +Type: `boolean` + +Whether or not Cypress should record the results of the tests + +### 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. diff --git a/docs/api-builders/jest.md b/docs/api-builders/jest.md index b57dc7a48b..31fbd585b1 100644 --- a/docs/api-builders/jest.md +++ b/docs/api-builders/jest.md @@ -2,21 +2,96 @@ Run Jest unit tests -### Properties +## Properties -| Name | Description | Type | Default value | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------- | ------- | ------------- | -| `updateSnapshot` | Re-record all failing snapshots. (https://jestjs.io/docs/en/cli#updatesnapshot) | boolean | `undefined` | -| `jestConfig` | The path of the Jest configuration. (https://jestjs.io/docs/en/configuration.html) | string | `undefined` | -| `setupFile` | The name of a setup file used by Jest. (https://jestjs.io/docs/en/configuration.html#setuptestframeworkscriptfile-string) | string | `undefined` | -| `watch` | Run tests when files change. (https://jestjs.io/docs/en/cli#watch) | boolean | `false` | -| `onlyChanged` | Isolate tests affected by uncommitted changes. (https://jestjs.io/docs/en/cli#onlychanged) | boolean | `undefined` | -| `passWithNoTests` | Allow test suite to pass when no test files are found. (https://jestjs.io/docs/en/cli#passwithnotests) | boolean | `undefined` | -| `codeCoverage` | Export a code coverage report. (https://jestjs.io/docs/en/cli#coverage) | boolean | `undefined` | -| `tsConfig` | The name of the Typescript configuration file. | string | `undefined` | -| `ci` | Fail on missing snapshots. (https://jestjs.io/docs/en/cli#ci) | boolean | `undefined` | -| `bail` | Exit the test suite immediately upon the first failing test suite. (https://jestjs.io/docs/en/cli#bail) | boolean | `undefined` | -| `silent` | Prevent tests from printing messages through the console. (https://jestjs.io/docs/en/cli#silent) | boolean | `undefined` | -| `runInBand` | Run tests in a single process as opposed to multiple workers. Useful for CI. (https://jestjs.io/docs/en/cli.html#runinband) | boolean | `undefined` | -| `maxWorkers` | Max number of workers to run tests across. Useful for CI. (https://jestjs.io/docs/en/cli.html#maxworkers-num) | number | `undefined` | -| `testNamePattern` | Run only tests with a name that matches the regex. (https://jestjs.io/docs/en/cli.html#testnamepattern-regex) | string | `undefined` | +### updateSnapshot + +Alias(es): u + +Type: `boolean` + +Re-record all failing snapshots. (https://jestjs.io/docs/en/cli#updatesnapshot) + +### jestConfig + +Type: `string` + +The path of the Jest configuration. (https://jestjs.io/docs/en/configuration.html) + +### setupFile + +Type: `string` + +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) + +### onlyChanged + +Alias(es): o + +Type: `boolean` + +Isolate tests affected by uncommitted changes. (https://jestjs.io/docs/en/cli#onlychanged) + +### passWithNoTests + +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 + +Type: `number` + +Max number of workers to run tests across. Useful for CI. (https://jestjs.io/docs/en/cli.html#maxworkers-num) + +### testNamePattern + +Alias(es): t + +Type: `string` + +Run only tests with a name that matches the regex. (https://jestjs.io/docs/en/cli.html#testnamepattern-regex) diff --git a/docs/api-builders/node-build.md b/docs/api-builders/node-build.md index 0c632bf3d3..81ae016def 100644 --- a/docs/api-builders/node-build.md +++ b/docs/api-builders/node-build.md @@ -2,20 +2,98 @@ Build a Node application -### Properties +## Properties -| Name | Description | Type | Default value | -| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------- | -| `externalDependencies` | Dependencies to keep external to the bundle. ("all" (default), "none", or an array of module names) | string | `all` | -| `main` | The name of the main entry-point file. | string | `undefined` | -| `watch` | Run build when files change. | boolean | `false` | -| `poll` | Frequency of file watcher in ms. | number | `undefined` | -| `sourceMap` | Produce source maps. | boolean | `true` | -| `progress` | Log progress to the console while building. | boolean | `false` | -| `tsConfig` | The name of the Typescript configuration file. | string | `undefined` | -| `statsJson` | Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https: //webpack.github.io/analyse. | boolean | `false` | -| `extractLicenses` | Extract all licenses in a separate file, in the case of production builds only. | boolean | `false` | -| `optimization` | Defines the optimization level of the build. | boolean | `false` | -| `showCircularDependencies` | Show circular dependency warnings on builds. | boolean | `true` | -| `maxWorkers` | Number of workers to use for type checking. (defaults to # of CPUS - 2) | number | `undefined` | -| `webpackConfig` | Path to a function which takes a webpack config, context and returns the resulting webpack config | string | `undefined` | +### externalDependencies + +Default: `all` + +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` + +Type: `boolean` + +Extract all licenses in a separate file, in the case of production builds only. + +### optimization + +Default: `false` + +Type: `boolean` + +Defines the optimization level of the build. + +### showCircularDependencies + +Default: `true` + +Type: `boolean` + +Show circular dependency warnings on builds. + +### maxWorkers + +Type: `number` + +Number of workers to use for type checking. (defaults to # of CPUS - 2) + +### webpackConfig + +Type: `string` + +Path to a function which takes a webpack config, context and returns the resulting webpack config diff --git a/docs/api-builders/node-execute.md b/docs/api-builders/node-execute.md index d27f2ea57f..ef19e4c643 100644 --- a/docs/api-builders/node-execute.md +++ b/docs/api-builders/node-execute.md @@ -2,12 +2,38 @@ Execute a Node application -### Properties +## Properties -| Name | Description | Type | Default value | -| ------------------ | -------------------------------------------------- | ------ | ------------- | -| `buildTarget` | The target to run to build you the app | string | `undefined` | -| `waitUntilTargets` | The targets to run to before starting the node app | array | `undefined` | -| `port` | The port to inspect the process on | number | `7777` | -| `inspect` | Ensures the app is starting with debugging | string | `inspect` | -| `args` | Extra args when starting the app | array | `undefined` | +### 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` + +Type: `string` + +Ensures the app is starting with debugging + +### args + +Type: `array` + +Extra args when starting the app diff --git a/docs/api-builders/run-commands.md b/docs/api-builders/run-commands.md index 1f78860506..06689ccb61 100644 --- a/docs/api-builders/run-commands.md +++ b/docs/api-builders/run-commands.md @@ -2,9 +2,18 @@ Run commands -### Properties +## Properties -| Name | Description | Type | Default value | -| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------- | -| `parallel` | Run commands in parallel | boolean | `true` | -| `readyWhen` | 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 one when all the child processes complete. | string | `undefined` | +### 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 one when all the child processes complete. diff --git a/docs/api-builders/web-build.md b/docs/api-builders/web-build.md index 70a92e0800..d125488e2e 100644 --- a/docs/api-builders/web-build.md +++ b/docs/api-builders/web-build.md @@ -2,31 +2,174 @@ Build a web application -### Properties +## Properties -| Name | Description | Type | Default value | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------- | -| `namedChunks` | Names the produced bundles according to their entry file | boolean | `true` | -| `main` | The name of the main entry-point file. | string | `undefined` | -| `watch` | Enable re-building when files change. | boolean | `false` | -| `baseHref` | Base url for the application being built. | string | `/` | -| `deployUrl` | URL where the application will be deployed. | string | `undefined` | -| `vendorChunk` | Use a separate bundle containing only vendor libraries. | boolean | `true` | -| `commonChunk` | Use a separate bundle containing code used across multiple bundles. | boolean | `true` | -| `sourceMap` | Output sourcemaps. | boolean | `true` | -| `progress` | Log progress to the console while building. | boolean | `false` | -| `index` | HTML File which will be contain the application | string | `undefined` | -| `scripts` | External Scripts which will be included before the main application entry | array | `undefined` | -| `styles` | External Styles which will be included with the application | array | `undefined` | -| `tsConfig` | The name of the Typescript configuration file. | string | `undefined` | -| `outputHashing` | Define the output filename cache-busting hashing mode. | string | `none` | -| `optimization` | Enables optimization of the build output. | boolean | `undefined` | -| `extractCss` | Extract css into a .css file | boolean | `false` | -| `es2015Polyfills` | Conditional polyfills loaded in browsers which do not support ES2015. | string | `undefined` | -| `subresourceIntegrity` | Enables the use of subresource integrity validation. | boolean | `false` | -| `polyfills` | Polyfills to load before application | string | `undefined` | -| `statsJson` | Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https://webpack.github.io/analyse. | boolean | `false` | -| `extractLicenses` | Extract all licenses in a separate file, in the case of production builds only. | boolean | `false` | -| `showCircularDependencies` | Show circular dependency warnings on builds. | boolean | `true` | -| `maxWorkers` | Number of workers to use for type checking. (defaults to # of CPUS - 2) | number | `undefined` | -| `webpackConfig` | Path to a function which takes a webpack config, some context and returns the resulting webpack config | string | `undefined` | +### 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: `/` + +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` + +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 + +Type: `string` + +HTML File which will be contain the application + +### 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 + +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. + +### extractCss + +Default: `false` + +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` + +Type: `boolean` + +Extract all licenses in a separate file, in the case of production builds only. + +### showCircularDependencies + +Default: `true` + +Type: `boolean` + +Show circular dependency warnings on builds. + +### maxWorkers + +Type: `number` + +Number of workers to use for type checking. (defaults to # of CPUS - 2) + +### webpackConfig + +Type: `string` + +Path to a function which takes a webpack config, some context and returns the resulting webpack config diff --git a/docs/api-builders/web-dev-server.md b/docs/api-builders/web-dev-server.md index e0f7191304..81a433c490 100644 --- a/docs/api-builders/web-dev-server.md +++ b/docs/api-builders/web-dev-server.md @@ -2,17 +2,76 @@ Serve a web application -### Properties +## Properties -| Name | Description | Type | Default value | -| ------------- | -------------------------------------------------------- | ------- | ------------- | -| `buildTarget` | Target which builds the application | string | `undefined` | -| `port` | Port to listen on. | number | `4200` | -| `host` | Host to listen on. | string | `localhost` | -| `ssl` | Serve using HTTPS. | boolean | `false` | -| `sslKey` | SSL key to use for serving HTTPS. | string | `undefined` | -| `sslCert` | SSL certificate to use for serving HTTPS. | string | `undefined` | -| `watch` | Watches for changes and rebuilds application | boolean | `true` | -| `liveReload` | Whether to reload the page on change, using live-reload. | boolean | `true` | -| `publicHost` | Public URL where the application will be served | string | `undefined` | -| `open` | Open the application in the browser. | boolean | `false` | +### buildTarget + +Type: `string` + +Target which builds the application + +### port + +Default: `4200` + +Type: `number` + +Port to listen on. + +### host + +Default: `localhost` + +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` + +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` + +Type: `boolean` + +Open the application in the browser. diff --git a/docs/api-npmscripts/affected-apps.md b/docs/api-npmscripts/affected-apps.md index b19ce43198..2edb2c21ce 100644 --- a/docs/api-npmscripts/affected-apps.md +++ b/docs/api-npmscripts/affected-apps.md @@ -8,20 +8,62 @@ Print applications affected by changes affected:apps ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/affected-build.md b/docs/api-npmscripts/affected-build.md index a922d6cc9c..efab41f782 100644 --- a/docs/api-npmscripts/affected-build.md +++ b/docs/api-npmscripts/affected-build.md @@ -8,20 +8,62 @@ Build applications and publishable libraries affected by changes affected:build ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/affected-dep-graph.md b/docs/api-npmscripts/affected-dep-graph.md index a3526f5604..066d47e244 100644 --- a/docs/api-npmscripts/affected-dep-graph.md +++ b/docs/api-npmscripts/affected-dep-graph.md @@ -8,21 +8,66 @@ Graph dependencies affected by changes affected:dep-graph ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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) diff --git a/docs/api-npmscripts/affected-e2e.md b/docs/api-npmscripts/affected-e2e.md index a053373437..4a554d7f68 100644 --- a/docs/api-npmscripts/affected-e2e.md +++ b/docs/api-npmscripts/affected-e2e.md @@ -8,20 +8,62 @@ Run e2e tests for the applications affected by changes affected:e2e ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/affected-libs.md b/docs/api-npmscripts/affected-libs.md index deda88e653..ec71fb5254 100644 --- a/docs/api-npmscripts/affected-libs.md +++ b/docs/api-npmscripts/affected-libs.md @@ -8,20 +8,62 @@ Print libraries affected by changes affected:libs ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/affected-lint.md b/docs/api-npmscripts/affected-lint.md index fbd4df033c..6161c4e78f 100644 --- a/docs/api-npmscripts/affected-lint.md +++ b/docs/api-npmscripts/affected-lint.md @@ -8,21 +8,66 @@ Lint projects affected by changes affected:lint ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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) diff --git a/docs/api-npmscripts/affected-test.md b/docs/api-npmscripts/affected-test.md index 3028314e19..8cdb15b57c 100644 --- a/docs/api-npmscripts/affected-test.md +++ b/docs/api-npmscripts/affected-test.md @@ -8,20 +8,62 @@ Test projects affected by changes affected:test ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/affected.md b/docs/api-npmscripts/affected.md index 96ad686348..da1d32cebc 100644 --- a/docs/api-npmscripts/affected.md +++ b/docs/api-npmscripts/affected.md @@ -8,20 +8,62 @@ Run task for affected projects affected ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/dep-graph.md b/docs/api-npmscripts/dep-graph.md index 018d7a7f74..b930e81f63 100644 --- a/docs/api-npmscripts/dep-graph.md +++ b/docs/api-npmscripts/dep-graph.md @@ -8,21 +8,66 @@ Graph dependencies within workspace dep-graph ``` -### Options +## Options -| Option | Description | Default value | -| --------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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) diff --git a/docs/api-npmscripts/format-check.md b/docs/api-npmscripts/format-check.md index 179d6246f6..18d6c15442 100644 --- a/docs/api-npmscripts/format-check.md +++ b/docs/api-npmscripts/format-check.md @@ -8,22 +8,68 @@ Check for un-formatted files format:check ``` -### Options +## Options -| Option | Description | Default value | -| ----------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | -| `--apps-and-libs` | | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/format-write.md b/docs/api-npmscripts/format-write.md index 194cc373ce..f332136001 100644 --- a/docs/api-npmscripts/format-write.md +++ b/docs/api-npmscripts/format-write.md @@ -8,22 +8,68 @@ Overwrite un-formatted files format:write ``` -### Options +## Options -| Option | Description | Default value | -| ----------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | -| `--apps-and-libs` | | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/lint-files.md b/docs/api-npmscripts/lint-files.md index 49b3c31619..7143f38d01 100644 --- a/docs/api-npmscripts/lint-files.md +++ b/docs/api-npmscripts/lint-files.md @@ -8,22 +8,68 @@ Lint workspace or list of files lint [files..] ``` -### Options +## Options -| Option | Description | Default value | -| ----------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | -| `--apps-and-libs` | | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/update-check.md b/docs/api-npmscripts/update-check.md index 44b0a18b1a..be733bab90 100644 --- a/docs/api-npmscripts/update-check.md +++ b/docs/api-npmscripts/update-check.md @@ -8,22 +8,68 @@ Check for workspace updates update:check ``` -### Options +## Options -| Option | Description | Default value | -| ----------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | -| `--apps-and-libs` | | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/update-skip.md b/docs/api-npmscripts/update-skip.md index 67e9082913..04d17ab129 100644 --- a/docs/api-npmscripts/update-skip.md +++ b/docs/api-npmscripts/update-skip.md @@ -8,22 +8,68 @@ Skip workspace updates update:skip ``` -### Options +## Options -| Option | Description | Default value | -| ----------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | -| `--apps-and-libs` | | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/update.md b/docs/api-npmscripts/update.md index ace0ffa435..c524327993 100644 --- a/docs/api-npmscripts/update.md +++ b/docs/api-npmscripts/update.md @@ -8,22 +8,68 @@ Update workspace update ``` -### Options +## Options -| Option | Description | Default value | -| ----------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--file` | output file (e.g. --file=.vis/output.json) | | -| `--apps-and-libs` | | | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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 diff --git a/docs/api-npmscripts/workspace-schematic-name.md b/docs/api-npmscripts/workspace-schematic-name.md index b6491fd002..45eeac57ab 100644 --- a/docs/api-npmscripts/workspace-schematic-name.md +++ b/docs/api-npmscripts/workspace-schematic-name.md @@ -8,24 +8,76 @@ Runs a workspace schematic from the tools/schematics directory workspace-schematic [name] ``` -### Options +## Options -| Option | Description | Default value | -| ------------------- | -------------------------------------------------- | ------------- | -| `--help` | Show help | | -| `--version` | Show version number | | -| `--quiet` | | | -| `--parallel` | Parallelize the command | `false` | -| `--maxParallel` | Max number of parallel processes | `3` | -| `--files` | A list of files delimited by commas | | -| `--uncommitted` | Uncommitted changes | | -| `--untracked` | Untracked changes | | -| `--all` | All projects | | -| `--base` | Base of the current branch (usually master) | | -| `--head` | Latest commit of the current branch (usually HEAD) | | -| `--exclude` | Exclude certain projects from being processed | `` | -| `--only-failed` | Isolate projects which previously failed | `false` | -| `--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` | +### help + +Show help + +### version + +Show version number + +### quiet + +### parallel + +Default: `false` + +Parallelize the command + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### files + +A list of files delimited by commas + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### all + +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` diff --git a/docs/api-schematics/application.md b/docs/api-schematics/application.md index 375a25578f..052fa83e97 100644 --- a/docs/api-schematics/application.md +++ b/docs/api-schematics/application.md @@ -9,22 +9,122 @@ ng generate application ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ------------------- | ----- | ------------------------------------------------- | ------- | ------------- | -| `prefix` | p | The prefix to apply to generated selectors. | string | `undefined` | -| `framework` | | The Framework for the application. | string | `angular` | -| `directory` | | The directory of the new application. | string | `undefined` | -| `inlineStyle` | s | Specifies if the style will be in the ts file. | boolean | `false` | -| `inlineTemplate` | t | Specifies if the template will be in the ts file. | boolean | `false` | -| `viewEncapsulation` | | Specifies the view encapsulation strategy. | string | `undefined` | -| `routing` | | Generates a routing module. | boolean | `false` | -| `name` | | The name of the application. | string | `undefined` | -| `style` | | The file extension to be used for style files. | string | `css` | -| `skipTests` | S | Skip creating spec files. | boolean | `false` | -| `skipFormat` | | Skip formatting files | boolean | `false` | -| `skipPackageJson` | | Do not add dependencies to package.json. | boolean | `false` | -| `unitTestRunner` | | Test runner to use for unit tests | string | `jest` | -| `e2eTestRunner` | | Test runner to use for end to end (e2e) tests | string | `cypress` | -| `tags` | | Add tags to the application (used for linting) | string | `undefined` | +### prefix + +Alias(es): p + +Type: `string` + +The prefix to apply to generated selectors. + +### framework + +Default: `angular` + +Type: `string` + +The Framework for the application. + +### directory + +Type: `string` + +The directory of the new application. + +### 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. + +### viewEncapsulation + +Type: `string` + +Specifies the view encapsulation strategy. + +### routing + +Default: `false` + +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` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### tags + +Type: `string` + +Add tags to the application (used for linting) diff --git a/docs/api-schematics/cypress-project.md b/docs/api-schematics/cypress-project.md index 987edf9dd1..e1b2452d6b 100644 --- a/docs/api-schematics/cypress-project.md +++ b/docs/api-schematics/cypress-project.md @@ -9,8 +9,10 @@ ng generate cypress-project ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| --------- | ----- | ------------------------ | ------ | ------------- | -| `project` | | The name of the project. | string | `undefined` | +### project + +Type: `string` + +The name of the project. diff --git a/docs/api-schematics/downgrade-module.md b/docs/api-schematics/downgrade-module.md index a208313bff..85645ce621 100644 --- a/docs/api-schematics/downgrade-module.md +++ b/docs/api-schematics/downgrade-module.md @@ -9,12 +9,38 @@ ng generate downgrade-module ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ----------------- | ----- | ------------------------------------------------------------------------------------------------- | ------- | ------------- | -| `project` | | The name of the project | string | `undefined` | -| `name` | | The name of the main AngularJS module. | string | `undefined` | -| `angularJsImport` | | Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). | string | `undefined` | -| `skipFormat` | | Skip formatting files | boolean | `false` | -| `skipPackageJson` | | Do not add @angular/upgrade to package.json (e.g., --skipPackageJson) | boolean | `false` | +### project + +Type: `string` + +The name of the project + +### name + +Type: `string` + +The name of the main AngularJS module. + +### angularJsImport + +Type: `string` + +Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add @angular/upgrade to package.json (e.g., --skipPackageJson) diff --git a/docs/api-schematics/jest-project.md b/docs/api-schematics/jest-project.md index cfaffe2d6d..c33b76c2dd 100644 --- a/docs/api-schematics/jest-project.md +++ b/docs/api-schematics/jest-project.md @@ -9,12 +9,42 @@ ng generate jest-project ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ----------------- | ----- | --------------------------------------------------------------------------- | ------- | ------------- | -| `project` | | The name of the project. | string | `undefined` | -| `skipSetupFile` | | [Deprecated]: Skips the setup file required for angular. (Use --setup-file) | boolean | `false` | -| `setupFile` | | The setup file to be generated | string | `angular` | -| `skipSerializers` | | Skips the serializers required to snapshot angular templates | boolean | `false` | -| `supportTsx` | | Setup tsx support | boolean | `false` | +### project + +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` + +Type: `string` + +The setup file to be generated + +### skipSerializers + +Default: `false` + +Type: `boolean` + +Skips the serializers required to snapshot angular templates + +### supportTsx + +Default: `false` + +Type: `boolean` + +Setup tsx support diff --git a/docs/api-schematics/jest.md b/docs/api-schematics/jest.md index cd546b2d0f..b8f6960491 100644 --- a/docs/api-schematics/jest.md +++ b/docs/api-schematics/jest.md @@ -8,9 +8,3 @@ Add Jest configuration to the workspace ng generate jest ... ``` - -### Options - -| Name | Alias | Description | Type | Default value | -| ---- | ----- | ----------- | ---- | ------------- | - diff --git a/docs/api-schematics/karma-project.md b/docs/api-schematics/karma-project.md index f708ba3eb3..354c3f68ac 100644 --- a/docs/api-schematics/karma-project.md +++ b/docs/api-schematics/karma-project.md @@ -9,8 +9,10 @@ ng generate karma-project ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| --------- | ----- | ------------------------ | ------ | ------------- | -| `project` | | The name of the project. | string | `undefined` | +### project + +Type: `string` + +The name of the project. diff --git a/docs/api-schematics/karma.md b/docs/api-schematics/karma.md index feb34d56df..26c1c959bb 100644 --- a/docs/api-schematics/karma.md +++ b/docs/api-schematics/karma.md @@ -8,9 +8,3 @@ Add Karma configuration to the workspace ng generate karma ... ``` - -### Options - -| Name | Alias | Description | Type | Default value | -| ---- | ----- | ----------- | ---- | ------------- | - diff --git a/docs/api-schematics/library.md b/docs/api-schematics/library.md index ff9d166454..3ded5b0e31 100644 --- a/docs/api-schematics/library.md +++ b/docs/api-schematics/library.md @@ -9,23 +9,124 @@ ng generate library ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ------------------ | ----- | ------------------------------------------------------------------------------------------------------------------------ | ------- | ------------- | -| `skipTsConfig` | | Do not update tsconfig.json for development experience. | boolean | `false` | -| `name` | | Library name | string | `undefined` | -| `framework` | | The framework this library uses | string | `none` | -| `publishable` | | Generate a simple TS library when set to true. | boolean | `false` | -| `prefix` | p | The prefix to apply to generated selectors. | string | `undefined` | -| `skipFormat` | | Skip formatting files | boolean | `false` | -| `simpleModuleName` | | Keep the module name simple (when using --directory) | boolean | `false` | -| `skipPackageJson` | | Do not add dependencies to package.json. | boolean | `false` | -| `directory` | | A directory where the app is placed | string | `undefined` | -| `parentModule` | | Update the router configuration of the parent module using loadChildren or children, depending on what `lazy` is set to. | string | `undefined` | -| `style` | | The file extension to be used for style files. | string | `css` | -| `routing` | | Add router configuration. See lazy for more information. | boolean | `false` | -| `lazy` | | Add RouterModule.forChild when set to true, and a simple array of routes when set to false. | boolean | `false` | -| `module` | | [Deprecated]: Include an NgModule in the library. | boolean | `true` | -| `tags` | | Add tags to the library (used for linting) | string | `undefined` | -| `unitTestRunner` | | Test runner to use for unit tests | string | `jest` | +### skipTsConfig + +Default: `false` + +Type: `boolean` + +Do not update tsconfig.json for development experience. + +### name + +Type: `string` + +Library name + +### framework + +Default: `none` + +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` + +Type: `boolean` + +Add RouterModule.forChild when set to true, and a simple array of routes when set to false. + +### module + +Default: `true` + +Type: `boolean` + +[Deprecated]: Include an NgModule in the library. + +### tags + +Type: `string` + +Add tags to the library (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/api-schematics/ng-add.md b/docs/api-schematics/ng-add.md index 5a3613a938..0a9eccb4fb 100644 --- a/docs/api-schematics/ng-add.md +++ b/docs/api-schematics/ng-add.md @@ -9,10 +9,24 @@ ng generate ng-add ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ------------- | ----- | --------------------------------------------- | ------- | ------------- | -| `npmScope` | | Npm scope for importing libs. | string | `undefined` | -| `skipInstall` | | Skip installing after adding @nrwl/schematics | boolean | `false` | -| `name` | | Project name. | string | `undefined` | +### npmScope + +Type: `string` + +Npm scope for importing libs. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing after adding @nrwl/schematics + +### name + +Type: `string` + +Project name. diff --git a/docs/api-schematics/ng-new.md b/docs/api-schematics/ng-new.md index 3a110b3a10..7325df7fa3 100644 --- a/docs/api-schematics/ng-new.md +++ b/docs/api-schematics/ng-new.md @@ -9,15 +9,64 @@ ng generate ng-new ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ------------- | ----- | ---------------------------------------------- | ------- | ------------- | -| `name` | | The name of the workspace. | string | `undefined` | -| `style` | | The file extension to be used for style files. | string | `css` | -| `directory` | | The directory name to create the workspace in. | string | `` | -| `npmScope` | | Npm scope for importing libs. | string | `undefined` | -| `skipInstall` | | Skip installing dependency packages. | boolean | `false` | -| `skipGit` | g | Skip initializing a git repository. | boolean | `false` | -| `commit` | | Initial repository commit information. | boolean | `true` | -| `preset` | | What to create in the new workspace | string | `empty` | +### name + +Type: `string` + +The name of the workspace. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### directory + +Type: `string` + +The directory name to create the workspace in. + +### npmScope + +Type: `string` + +Npm scope for importing libs. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. + +### preset + +Default: `empty` + +Type: `string` + +What to create in the new workspace diff --git a/docs/api-schematics/ngrx.md b/docs/api-schematics/ngrx.md index 9ace5d7e18..de7c78e169 100644 --- a/docs/api-schematics/ngrx.md +++ b/docs/api-schematics/ngrx.md @@ -9,16 +9,72 @@ ng generate ngrx ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ----------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------------- | -| `name` | | Name of the NgRx feature (e.g., Products, Users, etc.). Recommended to use plural form for name. | string | `undefined` | -| `module` | | Path to ngModule; host directory will contain the new '+state' directory (e.g., libs/comments/src/lib/comments-state.module.ts). | string | `undefined` | -| `directory` | | Override the name of the folder used to contain/group the NgRx files: contains actions, effects, reducers. selectors. (e.g., +state) | string | `+state` | -| `root` | | Add StoreModule.forRoot and EffectsModule.forRoot() instead of forFeature (e.g., --root). | boolean | `false` | -| `facade` | | Create a Facade class for the the Feature (e.g., --facade). | boolean | `false` | -| `onlyAddFiles` | | Only add new NgRx files, without changing the module file (e.g., --onlyAddFiles). | boolean | `false` | -| `onlyEmptyRoot` | | Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot). | boolean | `false` | -| `skipFormat` | | Skip formatting files | boolean | `false` | -| `skipPackageJson` | | Do not add NgRx dependencies to package.json (e.g., --skipPackageJson) | boolean | `false` | +### 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` + +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` + +Type: `boolean` + +Create a Facade class for the the Feature (e.g., --facade). + +### onlyAddFiles + +Default: `false` + +Type: `boolean` + +Only add new NgRx files, without changing the module file (e.g., --onlyAddFiles). + +### onlyEmptyRoot + +Default: `false` + +Type: `boolean` + +Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot). + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add NgRx dependencies to package.json (e.g., --skipPackageJson) diff --git a/docs/api-schematics/node-application.md b/docs/api-schematics/node-application.md index fd6bca3234..1dbafaddae 100644 --- a/docs/api-schematics/node-application.md +++ b/docs/api-schematics/node-application.md @@ -9,15 +9,60 @@ ng generate node-application ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ----------------- | ----- | ----------------------------------------------------------------------------------------- | ------- | ------------- | -| `name` | | The name of the application. | string | `undefined` | -| `directory` | | The directory of the new application. | string | `undefined` | -| `framework` | | Node Framework to use for application. | string | `nestjs` | -| `skipFormat` | | Skip formatting files | boolean | `false` | -| `skipPackageJson` | | Do not add dependencies to package.json. | boolean | `false` | -| `unitTestRunner` | | Test runner to use for unit tests | string | `jest` | -| `tags` | | Add tags to the application (used for linting) | string | `undefined` | -| `frontendProject` | | Frontend project that needs to access this application. This sets up proxy configuration. | string | `undefined` | +### name + +Type: `string` + +The name of the application. + +### directory + +Type: `string` + +The directory of the new application. + +### framework + +Default: `nestjs` + +Type: `string` + +Node Framework to use for application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### unitTestRunner + +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. diff --git a/docs/api-schematics/upgrade-module.md b/docs/api-schematics/upgrade-module.md index 69c300e8fc..cee9341a0f 100644 --- a/docs/api-schematics/upgrade-module.md +++ b/docs/api-schematics/upgrade-module.md @@ -9,14 +9,52 @@ ng generate upgrade-module ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ---------------------- | ----- | ------------------------------------------------------------------------------------------------- | ------- | ------------- | -| `project` | | The name of the project | string | `undefined` | -| `name` | | The name of the main AngularJS module. | string | `undefined` | -| `angularJsImport` | | Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). | string | `undefined` | -| `angularJsCmpSelector` | | The selector of an AngularJS component (e.g., --angularJsCmpSelector=myComponent) | string | `undefined` | -| `skipFormat` | | Skip formatting files | boolean | `false` | -| `skipPackageJson` | | Do not add @angular/upgrade to package.json (e.g., --skipPackageJson) | boolean | `false` | -| `router` | | Sets up router synchronization (e.g., --router) | boolean | `false` | +### project + +Type: `string` + +The name of the project + +### name + +Type: `string` + +The name of the main AngularJS module. + +### angularJsImport + +Type: `string` + +Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). + +### angularJsCmpSelector + +Type: `string` + +The selector of an AngularJS component (e.g., --angularJsCmpSelector=myComponent) + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +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) diff --git a/docs/api-schematics/workspace-schematic.md b/docs/api-schematics/workspace-schematic.md index 49c754603b..f33d87f36b 100644 --- a/docs/api-schematics/workspace-schematic.md +++ b/docs/api-schematics/workspace-schematic.md @@ -9,9 +9,18 @@ ng generate workspace-schematic ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ------------ | ----- | --------------------- | ------- | ------------- | -| `name` | | Schematic name | string | `undefined` | -| `skipFormat` | | Skip formatting files | boolean | `false` | +### name + +Type: `string` + +Schematic name + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/api-schematics/workspace.md b/docs/api-schematics/workspace.md index cb61812898..aaf02147c6 100644 --- a/docs/api-schematics/workspace.md +++ b/docs/api-schematics/workspace.md @@ -9,14 +9,56 @@ ng generate workspace ... ``` -### Options +## Options -| Name | Alias | Description | Type | Default value | -| ------------- | ----- | ---------------------------------------------- | ------- | ------------- | -| `name` | | The name of the workspace. | string | `undefined` | -| `style` | | The file extension to be used for style files. | string | `css` | -| `directory` | | The directory name to create the workspace in. | string | `` | -| `npmScope` | | Npm scope for importing libs. | string | `undefined` | -| `skipInstall` | | Skip installing dependency packages. | boolean | `false` | -| `skipGit` | g | Skip initializing a git repository. | boolean | `false` | -| `commit` | | Initial repository commit information. | boolean | `true` | +### name + +Type: `string` + +The name of the workspace. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### directory + +Type: `string` + +The directory name to create the workspace in. + +### npmScope + +Type: `string` + +Npm scope for importing libs. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. diff --git a/scripts/documentation/builders.ts b/scripts/documentation/builders.ts index e6be30e592..445c1606d8 100644 --- a/scripts/documentation/builders.ts +++ b/scripts/documentation/builders.ts @@ -59,19 +59,35 @@ function generateTemplate(builder): { name: string; template: string } { let template = dedent` # ${builder.name} ${builder.description} - - ### Properties - | Name | Description | Type | Default value | - |------|-------------|------|---------------|\n`; + \n`; - builder.options.forEach( - option => - (template += dedent`| \`${option.name}\` ${ - option.required ? '(*__required__*)' : '' - } ${option.hidden ? '(__hidden__)' : ''} | ${option.description} | ${ - option.type - } | \`${option.default}\` | \n`) - ); + if (Array.isArray(builder.options) && !!builder.options.length) { + template += '## Properties'; + + builder.options.forEach( + option => + (template += dedent` + ### ${option.name} ${option.required ? '(*__required__*)' : ''} ${ + option.hidden ? '(__hidden__)' : '' + } + + ${ + !!option.aliases.length + ? `Alias(es): ${option.aliases.join(',')}\n` + : '' + } + ${ + option.default === undefined || option.default === '' + ? '' + : `Default: \`${option.default}\`\n` + } + Type: \`${option.type}\` \n + + + ${option.description} + `) + ); + } return { name: builder.name, template }; } diff --git a/scripts/documentation/npmscripts.ts b/scripts/documentation/npmscripts.ts index d10105ad3a..43ee9627c8 100644 --- a/scripts/documentation/npmscripts.ts +++ b/scripts/documentation/npmscripts.ts @@ -42,16 +42,19 @@ function generateMarkdown(command) { `; if (Array.isArray(command.options) && !!command.options.length) { - template += dedent` - ### Options - | Option | Description | Default value | - |--------|-------------|---------------|\n`; + template += '## Options'; command.options.forEach( option => - (template += dedent`| \`${option.command}\` | ${option.description} | ${ - option.default === undefined ? '' : `\`${option.default}\`` - } | \n`) + (template += dedent` + ### ${option.command.replace('--', '')} + ${ + option.default === undefined || option.default === '' + ? '' + : `Default: \`${option.default}\`\n` + } + ${option.description} + `) ); } @@ -63,6 +66,7 @@ function generateMarkdown(command) { template }; } + function generateFile( outputDirectory: string, templateObject: { name: string; template: string } diff --git a/scripts/documentation/schematics.ts b/scripts/documentation/schematics.ts index 87ba785972..8b2439777d 100644 --- a/scripts/documentation/schematics.ts +++ b/scripts/documentation/schematics.ts @@ -74,19 +74,35 @@ function generateTemplate(schematic): { name: string; template: string } { ng generate ${schematic.name} ... ${schematic.alias ? `ng g ${schematic.name} ... # Same` : ''} \`\`\` - - ### Options - | Name | Alias | Description | Type | Default value | - |------|-------|-------------|------|---------------|\n`; + \n`; - schematic.options.forEach( - option => - (template += dedent`| \`${option.name}\` ${ - option.required ? '(*__required__*)' : '' - } ${option.hidden ? '(__hidden__)' : ''} | ${ - !!option.aliases.length ? option.aliases.join(',') : '' - } | ${option.description} | ${option.type} | \`${option.default}\` | \n`) - ); + if (Array.isArray(schematic.options) && !!schematic.options.length) { + template += '## Options'; + + schematic.options.forEach( + option => + (template += dedent` + ### ${option.name} ${option.required ? '(*__required__*)' : ''} ${ + option.hidden ? '(__hidden__)' : '' + } + + ${ + !!option.aliases.length + ? `Alias(es): ${option.aliases.join(',')}\n` + : '' + } + ${ + option.default === undefined || option.default === '' + ? '' + : `Default: \`${option.default}\`\n` + } + Type: \`${option.type}\` \n + + + ${option.description} + `) + ); + } return { name: schematic.name, template }; }