diff --git a/docs/api-angular/schematics/application.md b/docs/angular/api-angular/schematics/application.md similarity index 100% rename from docs/api-angular/schematics/application.md rename to docs/angular/api-angular/schematics/application.md diff --git a/docs/api-angular/schematics/downgrade-module.md b/docs/angular/api-angular/schematics/downgrade-module.md similarity index 100% rename from docs/api-angular/schematics/downgrade-module.md rename to docs/angular/api-angular/schematics/downgrade-module.md diff --git a/docs/api-angular/schematics/karma-project.md b/docs/angular/api-angular/schematics/karma-project.md similarity index 100% rename from docs/api-angular/schematics/karma-project.md rename to docs/angular/api-angular/schematics/karma-project.md diff --git a/docs/api-angular/schematics/karma.md b/docs/angular/api-angular/schematics/karma.md similarity index 100% rename from docs/api-angular/schematics/karma.md rename to docs/angular/api-angular/schematics/karma.md diff --git a/docs/api-angular/schematics/library.md b/docs/angular/api-angular/schematics/library.md similarity index 100% rename from docs/api-angular/schematics/library.md rename to docs/angular/api-angular/schematics/library.md diff --git a/docs/api-angular/schematics/ng-add.md b/docs/angular/api-angular/schematics/ng-add.md similarity index 100% rename from docs/api-angular/schematics/ng-add.md rename to docs/angular/api-angular/schematics/ng-add.md diff --git a/docs/api-angular/schematics/ngrx.md b/docs/angular/api-angular/schematics/ngrx.md similarity index 100% rename from docs/api-angular/schematics/ngrx.md rename to docs/angular/api-angular/schematics/ngrx.md diff --git a/docs/api-angular/schematics/upgrade-module.md b/docs/angular/api-angular/schematics/upgrade-module.md similarity index 100% rename from docs/api-angular/schematics/upgrade-module.md rename to docs/angular/api-angular/schematics/upgrade-module.md diff --git a/docs/api-cypress/builders/cypress.md b/docs/angular/api-cypress/builders/cypress.md similarity index 100% rename from docs/api-cypress/builders/cypress.md rename to docs/angular/api-cypress/builders/cypress.md diff --git a/docs/api-cypress/schematics/cypress-project.md b/docs/angular/api-cypress/schematics/cypress-project.md similarity index 100% rename from docs/api-cypress/schematics/cypress-project.md rename to docs/angular/api-cypress/schematics/cypress-project.md diff --git a/docs/api-cypress/schematics/ng-add.md b/docs/angular/api-cypress/schematics/ng-add.md similarity index 100% rename from docs/api-cypress/schematics/ng-add.md rename to docs/angular/api-cypress/schematics/ng-add.md diff --git a/docs/api-express/schematics/application.md b/docs/angular/api-express/schematics/application.md similarity index 100% rename from docs/api-express/schematics/application.md rename to docs/angular/api-express/schematics/application.md diff --git a/docs/api-express/schematics/ng-add.md b/docs/angular/api-express/schematics/ng-add.md similarity index 100% rename from docs/api-express/schematics/ng-add.md rename to docs/angular/api-express/schematics/ng-add.md diff --git a/docs/api-jest/builders/jest.md b/docs/angular/api-jest/builders/jest.md similarity index 100% rename from docs/api-jest/builders/jest.md rename to docs/angular/api-jest/builders/jest.md diff --git a/docs/api-jest/schematics/jest-project.md b/docs/angular/api-jest/schematics/jest-project.md similarity index 100% rename from docs/api-jest/schematics/jest-project.md rename to docs/angular/api-jest/schematics/jest-project.md diff --git a/docs/api-jest/schematics/ng-add.md b/docs/angular/api-jest/schematics/ng-add.md similarity index 100% rename from docs/api-jest/schematics/ng-add.md rename to docs/angular/api-jest/schematics/ng-add.md diff --git a/docs/api-linter/builders/lint.md b/docs/angular/api-linter/builders/lint.md similarity index 100% rename from docs/api-linter/builders/lint.md rename to docs/angular/api-linter/builders/lint.md diff --git a/docs/api-nest/schematics/application.md b/docs/angular/api-nest/schematics/application.md similarity index 100% rename from docs/api-nest/schematics/application.md rename to docs/angular/api-nest/schematics/application.md diff --git a/docs/api-nest/schematics/ng-add.md b/docs/angular/api-nest/schematics/ng-add.md similarity index 100% rename from docs/api-nest/schematics/ng-add.md rename to docs/angular/api-nest/schematics/ng-add.md diff --git a/docs/api-node/builders/build.md b/docs/angular/api-node/builders/build.md similarity index 100% rename from docs/api-node/builders/build.md rename to docs/angular/api-node/builders/build.md diff --git a/docs/api-node/builders/execute.md b/docs/angular/api-node/builders/execute.md similarity index 100% rename from docs/api-node/builders/execute.md rename to docs/angular/api-node/builders/execute.md diff --git a/docs/api-node/schematics/application.md b/docs/angular/api-node/schematics/application.md similarity index 100% rename from docs/api-node/schematics/application.md rename to docs/angular/api-node/schematics/application.md diff --git a/docs/api-node/schematics/ng-add.md b/docs/angular/api-node/schematics/ng-add.md similarity index 100% rename from docs/api-node/schematics/ng-add.md rename to docs/angular/api-node/schematics/ng-add.md diff --git a/docs/api-react/schematics/application.md b/docs/angular/api-react/schematics/application.md similarity index 100% rename from docs/api-react/schematics/application.md rename to docs/angular/api-react/schematics/application.md diff --git a/docs/api-react/schematics/component.md b/docs/angular/api-react/schematics/component.md similarity index 100% rename from docs/api-react/schematics/component.md rename to docs/angular/api-react/schematics/component.md diff --git a/docs/api-react/schematics/library.md b/docs/angular/api-react/schematics/library.md similarity index 100% rename from docs/api-react/schematics/library.md rename to docs/angular/api-react/schematics/library.md diff --git a/docs/api-react/schematics/ng-add.md b/docs/angular/api-react/schematics/ng-add.md similarity index 100% rename from docs/api-react/schematics/ng-add.md rename to docs/angular/api-react/schematics/ng-add.md diff --git a/docs/api-web/builders/build.md b/docs/angular/api-web/builders/build.md similarity index 100% rename from docs/api-web/builders/build.md rename to docs/angular/api-web/builders/build.md diff --git a/docs/api-web/builders/dev-server.md b/docs/angular/api-web/builders/dev-server.md similarity index 100% rename from docs/api-web/builders/dev-server.md rename to docs/angular/api-web/builders/dev-server.md diff --git a/docs/api-web/schematics/application.md b/docs/angular/api-web/schematics/application.md similarity index 100% rename from docs/api-web/schematics/application.md rename to docs/angular/api-web/schematics/application.md diff --git a/docs/api-web/schematics/ng-add.md b/docs/angular/api-web/schematics/ng-add.md similarity index 100% rename from docs/api-web/schematics/ng-add.md rename to docs/angular/api-web/schematics/ng-add.md diff --git a/docs/api-workspace/builders/run-commands.md b/docs/angular/api-workspace/builders/run-commands.md similarity index 100% rename from docs/api-workspace/builders/run-commands.md rename to docs/angular/api-workspace/builders/run-commands.md diff --git a/docs/api-workspace/npmscripts/affected-apps.md b/docs/angular/api-workspace/npmscripts/affected-apps.md similarity index 97% rename from docs/api-workspace/npmscripts/affected-apps.md rename to docs/angular/api-workspace/npmscripts/affected-apps.md index c412a69d8f..974419cbb6 100644 --- a/docs/api-workspace/npmscripts/affected-apps.md +++ b/docs/angular/api-workspace/npmscripts/affected-apps.md @@ -8,7 +8,7 @@ Print applications affected by changes affected:apps ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/affected-build.md b/docs/angular/api-workspace/npmscripts/affected-build.md similarity index 97% rename from docs/api-workspace/npmscripts/affected-build.md rename to docs/angular/api-workspace/npmscripts/affected-build.md index 21b0ee5caf..ce1fc337a5 100644 --- a/docs/api-workspace/npmscripts/affected-build.md +++ b/docs/angular/api-workspace/npmscripts/affected-build.md @@ -8,7 +8,7 @@ Build applications and publishable libraries affected by changes affected:build ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/affected-dep-graph.md b/docs/angular/api-workspace/npmscripts/affected-dep-graph.md similarity index 97% rename from docs/api-workspace/npmscripts/affected-dep-graph.md rename to docs/angular/api-workspace/npmscripts/affected-dep-graph.md index e7b8f8ea27..c93ac3b5a7 100644 --- a/docs/api-workspace/npmscripts/affected-dep-graph.md +++ b/docs/angular/api-workspace/npmscripts/affected-dep-graph.md @@ -8,7 +8,7 @@ Graph dependencies affected by changes affected:dep-graph ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/affected-e2e.md b/docs/angular/api-workspace/npmscripts/affected-e2e.md similarity index 97% rename from docs/api-workspace/npmscripts/affected-e2e.md rename to docs/angular/api-workspace/npmscripts/affected-e2e.md index 470b535b68..c1256e927b 100644 --- a/docs/api-workspace/npmscripts/affected-e2e.md +++ b/docs/angular/api-workspace/npmscripts/affected-e2e.md @@ -8,7 +8,7 @@ Run e2e tests for the applications affected by changes affected:e2e ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/affected-libs.md b/docs/angular/api-workspace/npmscripts/affected-libs.md similarity index 97% rename from docs/api-workspace/npmscripts/affected-libs.md rename to docs/angular/api-workspace/npmscripts/affected-libs.md index 68225c83c1..4f92a700f5 100644 --- a/docs/api-workspace/npmscripts/affected-libs.md +++ b/docs/angular/api-workspace/npmscripts/affected-libs.md @@ -8,7 +8,7 @@ Print libraries affected by changes affected:libs ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/affected-lint.md b/docs/angular/api-workspace/npmscripts/affected-lint.md similarity index 97% rename from docs/api-workspace/npmscripts/affected-lint.md rename to docs/angular/api-workspace/npmscripts/affected-lint.md index f3e4f93b5d..2fd1561ef3 100644 --- a/docs/api-workspace/npmscripts/affected-lint.md +++ b/docs/angular/api-workspace/npmscripts/affected-lint.md @@ -8,7 +8,7 @@ Lint projects affected by changes affected:lint ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/affected-test.md b/docs/angular/api-workspace/npmscripts/affected-test.md similarity index 97% rename from docs/api-workspace/npmscripts/affected-test.md rename to docs/angular/api-workspace/npmscripts/affected-test.md index e5fe986a2c..2306af739a 100644 --- a/docs/api-workspace/npmscripts/affected-test.md +++ b/docs/angular/api-workspace/npmscripts/affected-test.md @@ -8,7 +8,7 @@ Test projects affected by changes affected:test ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/affected.md b/docs/angular/api-workspace/npmscripts/affected.md similarity index 97% rename from docs/api-workspace/npmscripts/affected.md rename to docs/angular/api-workspace/npmscripts/affected.md index f5178c6d19..51d4478ec7 100644 --- a/docs/api-workspace/npmscripts/affected.md +++ b/docs/angular/api-workspace/npmscripts/affected.md @@ -8,7 +8,7 @@ Run task for affected projects affected ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/dep-graph.md b/docs/angular/api-workspace/npmscripts/dep-graph.md similarity index 97% rename from docs/api-workspace/npmscripts/dep-graph.md rename to docs/angular/api-workspace/npmscripts/dep-graph.md index 0673edccf2..e8f46de038 100644 --- a/docs/api-workspace/npmscripts/dep-graph.md +++ b/docs/angular/api-workspace/npmscripts/dep-graph.md @@ -8,7 +8,7 @@ Graph dependencies within workspace dep-graph ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/format-check.md b/docs/angular/api-workspace/npmscripts/format-check.md similarity index 97% rename from docs/api-workspace/npmscripts/format-check.md rename to docs/angular/api-workspace/npmscripts/format-check.md index 5728434150..ed6fbc290f 100644 --- a/docs/api-workspace/npmscripts/format-check.md +++ b/docs/angular/api-workspace/npmscripts/format-check.md @@ -8,7 +8,7 @@ Check for un-formatted files format:check ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/format-write.md b/docs/angular/api-workspace/npmscripts/format-write.md similarity index 97% rename from docs/api-workspace/npmscripts/format-write.md rename to docs/angular/api-workspace/npmscripts/format-write.md index 259c22c9c4..d138ab63be 100644 --- a/docs/api-workspace/npmscripts/format-write.md +++ b/docs/angular/api-workspace/npmscripts/format-write.md @@ -8,7 +8,7 @@ Overwrite un-formatted files format:write ``` -## Options + ## Options ### all diff --git a/docs/api-workspace/npmscripts/workspace-lint-files.md b/docs/angular/api-workspace/npmscripts/workspace-lint-files.md similarity index 91% rename from docs/api-workspace/npmscripts/workspace-lint-files.md rename to docs/angular/api-workspace/npmscripts/workspace-lint-files.md index 637d825753..79acf1c024 100644 --- a/docs/api-workspace/npmscripts/workspace-lint-files.md +++ b/docs/angular/api-workspace/npmscripts/workspace-lint-files.md @@ -8,7 +8,7 @@ Lint workspace or list of files workspace-lint [files..] ``` -## Options + ## Options ### help diff --git a/docs/api-workspace/npmscripts/workspace-schematic-name.md b/docs/angular/api-workspace/npmscripts/workspace-schematic-name.md similarity index 94% rename from docs/api-workspace/npmscripts/workspace-schematic-name.md rename to docs/angular/api-workspace/npmscripts/workspace-schematic-name.md index c9b3407b70..f3f1cc18ad 100644 --- a/docs/api-workspace/npmscripts/workspace-schematic-name.md +++ b/docs/angular/api-workspace/npmscripts/workspace-schematic-name.md @@ -8,7 +8,7 @@ Runs a workspace schematic from the tools/schematics directory workspace-schematic [name] ``` -## Options + ## Options ### help diff --git a/docs/api-workspace/schematics/library.md b/docs/angular/api-workspace/schematics/library.md similarity index 100% rename from docs/api-workspace/schematics/library.md rename to docs/angular/api-workspace/schematics/library.md diff --git a/docs/api-workspace/schematics/ng-add.md b/docs/angular/api-workspace/schematics/ng-add.md similarity index 100% rename from docs/api-workspace/schematics/ng-add.md rename to docs/angular/api-workspace/schematics/ng-add.md diff --git a/docs/api-workspace/schematics/ng-new.md b/docs/angular/api-workspace/schematics/ng-new.md similarity index 100% rename from docs/api-workspace/schematics/ng-new.md rename to docs/angular/api-workspace/schematics/ng-new.md diff --git a/docs/api-workspace/schematics/preset.md b/docs/angular/api-workspace/schematics/preset.md similarity index 100% rename from docs/api-workspace/schematics/preset.md rename to docs/angular/api-workspace/schematics/preset.md diff --git a/docs/api-workspace/schematics/tao-new.md b/docs/angular/api-workspace/schematics/tao-new.md similarity index 100% rename from docs/api-workspace/schematics/tao-new.md rename to docs/angular/api-workspace/schematics/tao-new.md diff --git a/docs/api-workspace/schematics/workspace-schematic.md b/docs/angular/api-workspace/schematics/workspace-schematic.md similarity index 100% rename from docs/api-workspace/schematics/workspace-schematic.md rename to docs/angular/api-workspace/schematics/workspace-schematic.md diff --git a/docs/api-workspace/schematics/workspace.md b/docs/angular/api-workspace/schematics/workspace.md similarity index 100% rename from docs/api-workspace/schematics/workspace.md rename to docs/angular/api-workspace/schematics/workspace.md diff --git a/docs/api/home.md b/docs/angular/api/home.md similarity index 100% rename from docs/api/home.md rename to docs/angular/api/home.md diff --git a/docs/builders.json b/docs/angular/builders.json similarity index 100% rename from docs/builders.json rename to docs/angular/builders.json diff --git a/docs/schematics.json b/docs/angular/schematics.json similarity index 100% rename from docs/schematics.json rename to docs/angular/schematics.json diff --git a/docs/react/api-angular/schematics/application.md b/docs/react/api-angular/schematics/application.md new file mode 100644 index 0000000000..00e7169e8c --- /dev/null +++ b/docs/react/api-angular/schematics/application.md @@ -0,0 +1,138 @@ +# application + +Create an Angular application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### enableIvy + +Default: `false` + +Type: `boolean` + +**EXPERIMENTAL** True to create a new app that uses the Ivy rendering engine. + +### inlineStyle + +Alias(es): s + +Default: `false` + +Type: `boolean` + +Specifies if the style will be in the ts file. + +### inlineTemplate + +Alias(es): t + +Default: `false` + +Type: `boolean` + +Specifies if the template will be in the ts file. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### prefix + +Alias(es): p + +Type: `string` + +The prefix to apply to generated selectors. + +### routing + +Default: `false` + +Type: `boolean` + +Generates a routing module. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### skipTests + +Alias(es): S + +Default: `false` + +Type: `boolean` + +Skip creating spec files. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests + +### viewEncapsulation + +Type: `string` + +Specifies the view encapsulation strategy. diff --git a/docs/react/api-angular/schematics/downgrade-module.md b/docs/react/api-angular/schematics/downgrade-module.md new file mode 100644 index 0000000000..84d6bcb7bf --- /dev/null +++ b/docs/react/api-angular/schematics/downgrade-module.md @@ -0,0 +1,46 @@ +# downgrade-module + +Setup Downgrade Module + +## Usage + +```bash +nx generate downgrade-module ... + +``` + +## Options + +### angularJsImport + +Type: `string` + +Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). + +### name + +Type: `string` + +The name of the main AngularJS module. + +### project + +Type: `string` + +The name of the project + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add @angular/upgrade to package.json (e.g., --skipPackageJson) diff --git a/docs/react/api-angular/schematics/karma-project.md b/docs/react/api-angular/schematics/karma-project.md new file mode 100644 index 0000000000..bad4856406 --- /dev/null +++ b/docs/react/api-angular/schematics/karma-project.md @@ -0,0 +1,18 @@ +# karma-project + +Add karma testing to a project + +## Usage + +```bash +nx generate karma-project ... + +``` + +## Options + +### project + +Type: `string` + +The name of the project. diff --git a/docs/react/api-angular/schematics/karma.md b/docs/react/api-angular/schematics/karma.md new file mode 100644 index 0000000000..dcbf3d04a7 --- /dev/null +++ b/docs/react/api-angular/schematics/karma.md @@ -0,0 +1,10 @@ +# karma + +Add karma configuration to a workspace + +## Usage + +```bash +nx generate karma ... + +``` diff --git a/docs/react/api-angular/schematics/library.md b/docs/react/api-angular/schematics/library.md new file mode 100644 index 0000000000..997046f817 --- /dev/null +++ b/docs/react/api-angular/schematics/library.md @@ -0,0 +1,116 @@ +# library + +Create an Angular library + +## Usage + +```bash +nx generate library ... + +``` + +## Options + +### directory + +Type: `string` + +A directory where the app is placed + +### lazy + +Default: `false` + +Type: `boolean` + +Add RouterModule.forChild when set to true, and a simple array of routes when set to false. + +### name + +Type: `string` + +Library name + +### parentModule + +Type: `string` + +Update the router configuration of the parent module using loadChildren or children, depending on what `lazy` is set to. + +### prefix + +Alias(es): p + +Type: `string` + +The prefix to apply to generated selectors. + +### publishable + +Default: `false` + +Type: `boolean` + +Generate a simple TS library when set to true. + +### routing + +Default: `false` + +Type: `boolean` + +Add router configuration. See lazy for more information. + +### simpleModuleName + +Default: `false` + +Type: `boolean` + +Keep the module name simple (when using --directory) + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### skipTsConfig + +Default: `false` + +Type: `boolean` + +Do not update tsconfig.json for development experience. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Type: `string` + +Add tags to the library (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-angular/schematics/ng-add.md b/docs/react/api-angular/schematics/ng-add.md new file mode 100644 index 0000000000..762b0a1103 --- /dev/null +++ b/docs/react/api-angular/schematics/ng-add.md @@ -0,0 +1,44 @@ +# ng-add [hidden] + +Add @nrwl/angular to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing after adding @nrwl/workspace + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-angular/schematics/ngrx.md b/docs/react/api-angular/schematics/ngrx.md new file mode 100644 index 0000000000..d006ce011a --- /dev/null +++ b/docs/react/api-angular/schematics/ngrx.md @@ -0,0 +1,104 @@ +# ngrx + +Add an ngrx config to a project + +## Usage + +```bash +nx generate ngrx ... + +``` + +## Options + +### directory + +Default: `+state` + +Type: `string` + +The name of the folder used to contain/group the generated NgRx files. + +### facade + +Default: `false` + +Type: `boolean` + +Create a Facade class for the the Feature. + +### minimal + +Default: `false` + +Type: `boolean` + +Only register the root state management setup or feature state. + +### module + +Type: `string` + +The path to NgModule where the feature state will be registered. The host directory will create/use the new state directory. + +### name + +Type: `string` + +Name of the NgRx feature state, such as "products" or "users"). Recommended to use the plural form of the name. + +### onlyAddFiles + +Default: `false` + +Type: `boolean` + +**Deprecated**, use `skipImport`. Only add new NgRx files, without changing the module file (e.g., --onlyAddFiles). + +### onlyEmptyRoot + +Default: `false` + +Type: `boolean` + +**Deprecated**, use `minimal`. Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot). + +### root + +Default: `false` + +Type: `boolean` + +Setup root or feature state management with NgRx. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting of generated files. + +### skipImport + +Default: `false` + +Type: `boolean` + +Generate NgRx feature files without registering the feature in the NgModule. + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not update the package.json with NgRx dependencies. + +### syntax + +Default: `classes` + +Type: `string` + +Specifies whether to use class-based or creator functions for actions, reducers, and effects. diff --git a/docs/react/api-angular/schematics/upgrade-module.md b/docs/react/api-angular/schematics/upgrade-module.md new file mode 100644 index 0000000000..8c5e74f96f --- /dev/null +++ b/docs/react/api-angular/schematics/upgrade-module.md @@ -0,0 +1,60 @@ +# upgrade-module + +Add an upgrade module + +## Usage + +```bash +nx generate upgrade-module ... + +``` + +## Options + +### angularJsCmpSelector + +Type: `string` + +The selector of an AngularJS component (e.g., --angularJsCmpSelector=myComponent) + +### angularJsImport + +Type: `string` + +Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). + +### name + +Type: `string` + +The name of the main AngularJS module. + +### project + +Type: `string` + +The name of the project + +### router + +Default: `false` + +Type: `boolean` + +Sets up router synchronization (e.g., --router) + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add @angular/upgrade to package.json (e.g., --skipPackageJson) diff --git a/docs/react/api-cypress/builders/cypress.md b/docs/react/api-cypress/builders/cypress.md new file mode 100644 index 0000000000..8651be8bbc --- /dev/null +++ b/docs/react/api-cypress/builders/cypress.md @@ -0,0 +1,93 @@ +# cypress + +Run Cypress e2e tests + +## Properties + +### baseUrl + +Type: `string` + +Use this to pass directly the address of your distant server address with the port running your application + +### browser + +Type: `string` + +The browser to run tests in. + +### copyFiles + +Type: `string` + +DEPRECATED: A regex string that is used to choose what additional integration files to copy to the dist folder + +### cypressConfig + +Type: `string` + +The path of the Cypress configuration json file. + +### devServerTarget + +Type: `string` + +Dev server target to run tests against. + +### exit + +Default: `true` + +Type: `boolean` + +Whether or not the Cypress Test Runner will stay open after running tests in a spec file + +### headless + +Default: `false` + +Type: `boolean` + +Whether or not to open the Cypress application to run the tests. If set to 'true', will run in headless mode + +### key + +Type: `string` + +The key cypress should use to run tests in parallel/record the run (CI only) + +### parallel + +Default: `false` + +Type: `boolean` + +Whether or not Cypress should run its tests in parallel (CI only) + +### record + +Default: `false` + +Type: `boolean` + +Whether or not Cypress should record the results of the tests + +### spec + +Type: `string` + +A comma delimited glob string that is provided to the Cypress runner to specify which spec files to run. i.e. '**examples/**,**actions.spec** + +### tsConfig + +Type: `string` + +The path of the Cypress tsconfig configuration json file. + +### watch + +Default: `false` + +Type: `boolean` + +Recompile and run tests when files change. diff --git a/docs/react/api-cypress/schematics/cypress-project.md b/docs/react/api-cypress/schematics/cypress-project.md new file mode 100644 index 0000000000..c9d6950b69 --- /dev/null +++ b/docs/react/api-cypress/schematics/cypress-project.md @@ -0,0 +1,38 @@ +# cypress-project [hidden] + +Add a Cypress E2E Project + +## Usage + +```bash +nx generate cypress-project ... + +``` + +## Options + +### directory + +Type: `string` + +A directory where the project is placed + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +Name of the E2E Project + +### project + +Type: `string` + +The name of the frontend project to test. diff --git a/docs/react/api-cypress/schematics/ng-add.md b/docs/react/api-cypress/schematics/ng-add.md new file mode 100644 index 0000000000..e5400d40ab --- /dev/null +++ b/docs/react/api-cypress/schematics/ng-add.md @@ -0,0 +1,10 @@ +# ng-add [hidden] + +Add Cypress configuration to the workspace + +## Usage + +```bash +nx generate ng-add ... + +``` diff --git a/docs/react/api-express/schematics/application.md b/docs/react/api-express/schematics/application.md new file mode 100644 index 0000000000..3082318fc2 --- /dev/null +++ b/docs/react/api-express/schematics/application.md @@ -0,0 +1,68 @@ +# application + +Create an express application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### frontendProject + +Type: `string` + +Frontend project that needs to access this application. This sets up proxy configuration. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-express/schematics/ng-add.md b/docs/react/api-express/schematics/ng-add.md new file mode 100644 index 0000000000..fb7cfd898c --- /dev/null +++ b/docs/react/api-express/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/express to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/react/api-jest/builders/jest.md b/docs/react/api-jest/builders/jest.md new file mode 100644 index 0000000000..29d919a547 --- /dev/null +++ b/docs/react/api-jest/builders/jest.md @@ -0,0 +1,199 @@ +# jest + +Run Jest unit tests + +## Properties + +### bail + +Alias(es): b + +Type: `number` + +Exit the test suite immediately after `n` number of failing tests. (https://jestjs.io/docs/en/cli#bail) + +### ci + +Type: `boolean` + +Whether to run Jest in continuous integration (CI) mode. This option is on by default in most popular CI environments. It will prevent snapshots from being written unless explicitly requested. (https://jestjs.io/docs/en/cli#ci) + +### clearCache + +Type: `boolean` + +Deletes the Jest cache directory and then exits without running tests. Will delete Jest's default cache directory. _Note: clearing the cache will reduce performance_. + +### codeCoverage + +Type: `boolean` + +Indicates that test coverage information should be collected and reported in the output. (https://jestjs.io/docs/en/cli#coverage) + +### color + +Alias(es): colors + +Type: `boolean` + +Forces test results output color highlighting (even if stdout is not a TTY). Set to false if you would like to have no colors. (https://jestjs.io/docs/en/cli#colors) + +### colors + +Type: `boolean` + +Forces test results output highlighting even if stdout is not a TTY. (https://jestjs.io/docs/en/cli#colors) + +### config + +Type: `string` + +The path to a Jest config file specifying how to find and execute tests. If no rootDir is set in the config, the directory containing the config file is assumed to be the rootDir for the project. This can also be a JSON-encoded value which Jest will use as configuration + +### coverage + +Type: `boolean` + +Indicates that test coverage information should be collected and reported in the output. This option is also aliased by --collectCoverage. (https://jestjs.io/docs/en/cli#coverage) + +### coverageDirectory + +Type: `string` + +An array of regexp pattern strings that are matched against all file paths before executing the test. If the file path matches any of the patterns, coverage information will be skipped. + +### coverageReporters + +Type: `string` + +A list of reporter names that Jest uses when writing coverage reports. Any istanbul reporter + +### findRelatedTests + +Type: `string` + +Find and run the tests that cover a comma separated list of source files that were passed in as arguments. (https://jestjs.io/docs/en/cli#findrelatedtests-spaceseparatedlistofsourcefiles) + +### jestConfig + +Type: `string` + +The path of the Jest configuration. (https://jestjs.io/docs/en/configuration) + +### json + +Type: `boolean` + +Prints the test results in JSON. This mode will send all other test output and user messages to stderr. (https://jestjs.io/docs/en/cli#json) + +### maxWorkers + +Alias(es): w + +Type: `number` + +Specifies the maximum number of workers the worker-pool will spawn for running tests. This defaults to the number of the cores available on your machine. Useful for CI. (its usually best not to override this default) (https://jestjs.io/docs/en/cli#maxworkers-num) + +### onlyChanged + +Alias(es): o + +Type: `boolean` + +Attempts to identify which tests to run based on which files have changed in the current repository. Only works if you're running tests in a git or hg repository at the moment. (https://jestjs.io/docs/en/cli#onlychanged) + +### outputFile + +Type: `string` + +Write test results to a file when the --json option is also specified. (https://jestjs.io/docs/en/cli#outputfile-filename) + +### passWithNoTests + +Type: `boolean` + +Will not fail if no tests are found (for example while using `--testPathPattern`.) (https://jestjs.io/docs/en/cli#passwithnotests) + +### reporters + +Type: `array` + +Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple reporters: jest --reporters="default" --reporters="jest-junit" (https://jestjs.io/docs/en/cli#reporters) + +### runInBand + +Alias(es): i + +Type: `boolean` + +Run all tests serially in the current process (rather than creating a worker pool of child processes that run tests). This is sometimes useful for debugging, but such use cases are pretty rare. Useful for CI. (https://jestjs.io/docs/en/cli#runinband) + +### setupFile + +Type: `string` + +The name of a setup file used by Jest. (https://jestjs.io/docs/en/configuration#setupfilesafterenv-array) + +### silent + +Type: `boolean` + +Prevent tests from printing messages through the console. (https://jestjs.io/docs/en/cli#silent) + +### testFile + +Type: `string` + +The name of the file to test. + +### testNamePattern + +Alias(es): t + +Type: `string` + +Run only tests with a name that matches the regex pattern. (https://jestjs.io/docs/en/cli#testnamepattern-regex) + +### testPathPattern + +Type: `string` + +A regexp pattern string that is matched against all tests paths before executing the test. (https://jestjs.io/docs/en/cli#testpathpattern-regex) + +### tsConfig + +Type: `string` + +The name of the Typescript configuration file. + +### updateSnapshot + +Alias(es): u + +Type: `boolean` + +Use this flag to re-record snapshots. Can be used together with a test suite pattern or with `--testNamePattern` to re-record snapshot for test matching the pattern. (https://jestjs.io/docs/en/cli#updatesnapshot) + +### useStderr + +Type: `boolean` + +Divert all output to stderr. + +### verbose + +Type: `string` + +Display individual test results with the test suite hierarchy. (https://jestjs.io/docs/en/cli#verbose) + +### watch + +Type: `boolean` + +Watch files for changes and rerun tests related to changed files. If you want to re-run all tests when a file has changed, use the `--watchAll` option. (https://jestjs.io/docs/en/cli#watch) + +### watchAll + +Type: `boolean` + +Watch files for changes and rerun all tests when something changes. If you want to re-run only the tests that depend on the changed files, use the `--watch` option. (https://jestjs.io/docs/en/cli#watchall) diff --git a/docs/react/api-jest/schematics/jest-project.md b/docs/react/api-jest/schematics/jest-project.md new file mode 100644 index 0000000000..a7da8773a8 --- /dev/null +++ b/docs/react/api-jest/schematics/jest-project.md @@ -0,0 +1,50 @@ +# jest-project [hidden] + +Add Jest configuration to a project + +## Usage + +```bash +nx generate jest-project ... + +``` + +## Options + +### project + +Type: `string` + +The name of the project. + +### setupFile + +Default: `none` + +Type: `string` + +The setup file to be generated + +### skipSerializers + +Default: `false` + +Type: `boolean` + +Skips the serializers required to snapshot angular templates + +### skipSetupFile + +Default: `false` + +Type: `boolean` + +[Deprecated]: Skips the setup file required for angular. (Use --setup-file) + +### supportTsx + +Default: `false` + +Type: `boolean` + +Setup tsx support diff --git a/docs/react/api-jest/schematics/ng-add.md b/docs/react/api-jest/schematics/ng-add.md new file mode 100644 index 0000000000..e0b4ef8a6b --- /dev/null +++ b/docs/react/api-jest/schematics/ng-add.md @@ -0,0 +1,10 @@ +# ng-add [hidden] + +Add Jest configuration to the workspace + +## Usage + +```bash +nx generate ng-add ... + +``` diff --git a/docs/react/api-linter/builders/lint.md b/docs/react/api-linter/builders/lint.md new file mode 100644 index 0000000000..7aa2c8a1ef --- /dev/null +++ b/docs/react/api-linter/builders/lint.md @@ -0,0 +1,53 @@ +# lint + +Lint a project + +## Properties + +### config + +Type: `string` + +The name of the configuration file. + +### exclude + +Type: `array` + +Files to exclude from linting. + +### files + +Type: `array` + +Files to include in linting. + +### fix + +Default: `false` + +Type: `boolean` + +Fixes linting errors (may overwrite linted files). + +### format + +Default: `prose` + +Type: `string` + +Output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist). + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### tsConfig + +Type: `string` + +The name of the TypeScript configuration file. diff --git a/docs/react/api-nest/schematics/application.md b/docs/react/api-nest/schematics/application.md new file mode 100644 index 0000000000..842af3bdb3 --- /dev/null +++ b/docs/react/api-nest/schematics/application.md @@ -0,0 +1,68 @@ +# application + +Create a nest application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### frontendProject + +Type: `string` + +Frontend project that needs to access this application. This sets up proxy configuration. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-nest/schematics/ng-add.md b/docs/react/api-nest/schematics/ng-add.md new file mode 100644 index 0000000000..6726a04070 --- /dev/null +++ b/docs/react/api-nest/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/nest to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/react/api-node/builders/build.md b/docs/react/api-node/builders/build.md new file mode 100644 index 0000000000..8fb4c90e2b --- /dev/null +++ b/docs/react/api-node/builders/build.md @@ -0,0 +1,131 @@ +# build + +Build a Node application + +## Properties + +### assets + +Type: `array` + +List of static application assets. + +### externalDependencies + +Default: `all` + +Type: `string` + +Dependencies to keep external to the bundle. ("all" (default), "none", or an array of module names) + +### extractLicenses + +Default: `false` + +Type: `boolean` + +Extract all licenses in a separate file, in the case of production builds only. + +### fileReplacements + +Type: `array` of `object` + +Replace files with other files in the build. + +#### replace + +Type: `string` + +undefined + +#### with + +Type: `string` + +undefined + +### main + +Type: `string` + +The name of the main entry-point file. + +### maxWorkers + +Type: `number` + +Number of workers to use for type checking. (defaults to # of CPUS - 2) + +### optimization + +Default: `false` + +Type: `boolean` + +Defines the optimization level of the build. + +### poll + +Type: `number` + +Frequency of file watcher in ms. + +### progress + +Default: `false` + +Type: `boolean` + +Log progress to the console while building. + +### showCircularDependencies + +Default: `true` + +Type: `boolean` + +Show circular dependency warnings on builds. + +### sourceMap + +Default: `true` + +Type: `boolean` + +Produce source maps. + +### statsJson + +Default: `false` + +Type: `boolean` + +Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https: //webpack.github.io/analyse. + +### tsConfig + +Type: `string` + +The name of the Typescript configuration file. + +### verbose + +Default: `false` + +Type: `boolean` + +Emits verbose output + +### watch + +Default: `false` + +Type: `boolean` + +Run build when files change. + +### webpackConfig + +Type: `string` + +Path to a function which takes a webpack config, context and returns the resulting webpack config diff --git a/docs/react/api-node/builders/execute.md b/docs/react/api-node/builders/execute.md new file mode 100644 index 0000000000..55ba6682d8 --- /dev/null +++ b/docs/react/api-node/builders/execute.md @@ -0,0 +1,47 @@ +# execute + +Execute a Node application + +## Properties + +### args + +Type: `array` + +Extra args when starting the app + +### buildTarget + +Type: `string` + +The target to run to build you the app + +### host + +Default: `localhost` + +Type: `string` + +The host to inspect the process on + +### inspect + +Default: `inspect` + +Type: `string` + +Ensures the app is starting with debugging + +### port + +Default: `7777` + +Type: `number` + +The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes. + +### waitUntilTargets + +Type: `array` + +The targets to run to before starting the node app diff --git a/docs/react/api-node/schematics/application.md b/docs/react/api-node/schematics/application.md new file mode 100644 index 0000000000..c51980eb8c --- /dev/null +++ b/docs/react/api-node/schematics/application.md @@ -0,0 +1,68 @@ +# application + +Create a node application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### frontendProject + +Type: `string` + +Frontend project that needs to access this application. This sets up proxy configuration. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-node/schematics/ng-add.md b/docs/react/api-node/schematics/ng-add.md new file mode 100644 index 0000000000..821e278fd0 --- /dev/null +++ b/docs/react/api-node/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/node to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/react/api-react/schematics/application.md b/docs/react/api-react/schematics/application.md new file mode 100644 index 0000000000..5dc8535d69 --- /dev/null +++ b/docs/react/api-react/schematics/application.md @@ -0,0 +1,118 @@ +# application + +Create an application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### babel + +Default: `false` + +Type: `boolean` + +Use Babel and TypeScript preset instead of ts-loader (Useful if you need Babel plugins) + +### classComponent + +Alias(es): C + +Default: `false` + +Type: `boolean` + +Use class components instead of functional component + +### directory + +Alias(es): d + +Type: `string` + +The directory of the new application. + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### pascalCaseFiles + +Alias(es): P + +Default: `false` + +Type: `boolean` + +Use pascal case component file name (e.g. App.tsx) + +### routing + +Type: `boolean` + +Generate application with routes + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipWorkspaceJson + +Default: `false` + +Type: `boolean` + +Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style) + +### style + +Alias(es): s + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Alias(es): t + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-react/schematics/component.md b/docs/react/api-react/schematics/component.md new file mode 100644 index 0000000000..183205c27f --- /dev/null +++ b/docs/react/api-react/schematics/component.md @@ -0,0 +1,88 @@ +# component + +Create a component + +## Usage + +```bash +nx generate component ... + +``` + +## Options + +### classComponent + +Alias(es): C + +Default: `false` + +Type: `boolean` + +Use class components instead of functional component. + +### directory + +Alias(es): d + +Type: `string` + +Create the component under this directory (can be nested). + +### export + +Alias(es): e + +Default: `false` + +Type: `boolean` + +When true, the component is exported from the project index.ts (if it exists). + +### name + +Type: `string` + +The name of the component. + +### pascalCaseFiles + +Alias(es): P + +Default: `false` + +Type: `boolean` + +Use pascal case component file name (e.g. App.tsx). + +### project + +Alias(es): p + +Type: `string` + +The name of the project. + +### routing + +Type: `boolean` + +Generate a library with routes. + +### skipTests + +Default: `false` + +Type: `boolean` + +When true, does not create "spec.ts" test files for the new component. + +### style + +Alias(es): s + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/react/api-react/schematics/library.md b/docs/react/api-react/schematics/library.md new file mode 100644 index 0000000000..a6ce83277c --- /dev/null +++ b/docs/react/api-react/schematics/library.md @@ -0,0 +1,100 @@ +# library + +Create a library + +## Usage + +```bash +nx generate library ... + +``` + +## Options + +### appProject + +Alias(es): a + +Type: `string` + +The application project to add the library route to + +### directory + +Alias(es): d + +Type: `string` + +A directory where the app is placed + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +Library name + +### pascalCaseFiles + +Alias(es): P + +Default: `false` + +Type: `boolean` + +Use pascal case component file name (e.g. App.tsx) + +### routing + +Type: `boolean` + +Generate library with routes + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipTsConfig + +Default: `false` + +Type: `boolean` + +Do not update tsconfig.json for development experience. + +### style + +Alias(es): s + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Alias(es): t + +Type: `string` + +Add tags to the library (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-react/schematics/ng-add.md b/docs/react/api-react/schematics/ng-add.md new file mode 100644 index 0000000000..4d47eb790e --- /dev/null +++ b/docs/react/api-react/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/react to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/react/api-web/builders/build.md b/docs/react/api-web/builders/build.md new file mode 100644 index 0000000000..d4a31569d8 --- /dev/null +++ b/docs/react/api-web/builders/build.md @@ -0,0 +1,221 @@ +# build + +Build a application + +## Properties + +### assets + +Type: `array` + +List of static application assets. + +### baseHref + +Default: `/` + +Type: `string` + +Base url for the application being built. + +### budgets + +Type: `array` + +Budget thresholds to ensure parts of your application stay within boundaries which you set. + +### commonChunk + +Default: `true` + +Type: `boolean` + +Use a separate bundle containing code used across multiple bundles. + +### deployUrl + +Type: `string` + +URL where the application will be deployed. + +### differentialLoading + +Default: `true` + +Type: `boolean` + +Enable differential loading for es5 browsers + +### es2015Polyfills + +Type: `string` + +Conditional polyfills loaded in browsers which do not support ES2015. + +### extractCss + +Default: `false` + +Type: `boolean` + +Extract css into a .css file + +### extractLicenses + +Default: `false` + +Type: `boolean` + +Extract all licenses in a separate file, in the case of production builds only. + +### fileReplacements + +Type: `array` of `object` + +Replace files with other files in the build. + +#### replace + +Type: `string` + +undefined + +#### with + +Type: `string` + +undefined + +### index + +Type: `string` + +HTML File which will be contain the application + +### main + +Type: `string` + +The name of the main entry-point file. + +### maxWorkers + +Type: `number` + +Number of workers to use for type checking. (defaults to # of CPUS - 2) + +### namedChunks + +Default: `true` + +Type: `boolean` + +Names the produced bundles according to their entry file + +### optimization + +Type: `boolean` + +Enables optimization of the build output. + +### outputHashing + +Default: `none` + +Type: `string` + +Define the output filename cache-busting hashing mode. + +### polyfills + +Type: `string` + +Polyfills to load before application + +### progress + +Default: `false` + +Type: `boolean` + +Log progress to the console while building. + +### scripts + +Type: `array` + +External Scripts which will be included before the main application entry + +### showCircularDependencies + +Default: `true` + +Type: `boolean` + +Show circular dependency warnings on builds. + +### sourceMap + +Default: `true` + +Type: `boolean` + +Output sourcemaps. + +### statsJson + +Default: `false` + +Type: `boolean` + +Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https://webpack.github.io/analyse. + +### styles + +Type: `array` + +External Styles which will be included with the application + +### subresourceIntegrity + +Default: `false` + +Type: `boolean` + +Enables the use of subresource integrity validation. + +### tsConfig + +Type: `string` + +The name of the Typescript configuration file. + +### vendorChunk + +Default: `true` + +Type: `boolean` + +Use a separate bundle containing only vendor libraries. + +### verbose + +Default: `false` + +Type: `boolean` + +Emits verbose output + +### watch + +Default: `false` + +Type: `boolean` + +Enable re-building when files change. + +### webpackConfig + +Type: `string` + +Path to a function which takes a webpack config, some context and returns the resulting webpack config diff --git a/docs/react/api-web/builders/dev-server.md b/docs/react/api-web/builders/dev-server.md new file mode 100644 index 0000000000..b8a4f94863 --- /dev/null +++ b/docs/react/api-web/builders/dev-server.md @@ -0,0 +1,77 @@ +# dev-server + +Serve a web application + +## Properties + +### buildTarget + +Type: `string` + +Target which builds the application + +### host + +Default: `localhost` + +Type: `string` + +Host to listen on. + +### liveReload + +Default: `true` + +Type: `boolean` + +Whether to reload the page on change, using live-reload. + +### open + +Default: `false` + +Type: `boolean` + +Open the application in the browser. + +### port + +Default: `4200` + +Type: `number` + +Port to listen on. + +### publicHost + +Type: `string` + +Public URL where the application will be served + +### ssl + +Default: `false` + +Type: `boolean` + +Serve using HTTPS. + +### sslCert + +Type: `string` + +SSL certificate to use for serving HTTPS. + +### sslKey + +Type: `string` + +SSL key to use for serving HTTPS. + +### watch + +Default: `true` + +Type: `boolean` + +Watches for changes and rebuilds application diff --git a/docs/react/api-web/schematics/application.md b/docs/react/api-web/schematics/application.md new file mode 100644 index 0000000000..9c384a2cbb --- /dev/null +++ b/docs/react/api-web/schematics/application.md @@ -0,0 +1,70 @@ +# application + +Create an application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-web/schematics/ng-add.md b/docs/react/api-web/schematics/ng-add.md new file mode 100644 index 0000000000..8e24996651 --- /dev/null +++ b/docs/react/api-web/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/web to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/react/api-workspace/builders/run-commands.md b/docs/react/api-workspace/builders/run-commands.md new file mode 100644 index 0000000000..f8352e9eaf --- /dev/null +++ b/docs/react/api-workspace/builders/run-commands.md @@ -0,0 +1,35 @@ +# run-commands + +Run commands + +## Properties + +### args + +Type: `string` + +Extra arguments. You can pass them as follows: ng run project:target --args='--wait=100'. You can them use {args.wait} syntax to interpolate them in the workspace config file. + +### commands + +Type: `array` of `object` + +#### command + +Type: `string` + +Command to run in child process + +### parallel + +Default: `true` + +Type: `boolean` + +Run commands in parallel + +### readyWhen + +Type: `string` + +String to appear in stdout or stderr that indicates that the task is done. This option can only be used when parallel is set to true. If not specified, the task is done when all the child processes complete. diff --git a/docs/react/api-workspace/npmscripts/affected-apps.md b/docs/react/api-workspace/npmscripts/affected-apps.md new file mode 100644 index 0000000000..974419cbb6 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected-apps.md @@ -0,0 +1,59 @@ +# affected:apps + +Print applications affected by changes + +## Usage + +```bash +affected:apps +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/affected-build.md b/docs/react/api-workspace/npmscripts/affected-build.md new file mode 100644 index 0000000000..ce1fc337a5 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected-build.md @@ -0,0 +1,71 @@ +# affected:build + +Build applications and publishable libraries affected by changes + +## Usage + +```bash +affected:build +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/affected-dep-graph.md b/docs/react/api-workspace/npmscripts/affected-dep-graph.md new file mode 100644 index 0000000000..c93ac3b5a7 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected-dep-graph.md @@ -0,0 +1,63 @@ +# affected:dep-graph + +Graph dependencies affected by changes + +## Usage + +```bash +affected:dep-graph +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### file + +output file (e.g. --file=.vis/output.json) + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/affected-e2e.md b/docs/react/api-workspace/npmscripts/affected-e2e.md new file mode 100644 index 0000000000..c1256e927b --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected-e2e.md @@ -0,0 +1,71 @@ +# affected:e2e + +Run e2e tests for the applications affected by changes + +## Usage + +```bash +affected:e2e +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/affected-libs.md b/docs/react/api-workspace/npmscripts/affected-libs.md new file mode 100644 index 0000000000..4f92a700f5 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected-libs.md @@ -0,0 +1,59 @@ +# affected:libs + +Print libraries affected by changes + +## Usage + +```bash +affected:libs +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/affected-lint.md b/docs/react/api-workspace/npmscripts/affected-lint.md new file mode 100644 index 0000000000..2fd1561ef3 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected-lint.md @@ -0,0 +1,71 @@ +# affected:lint + +Lint projects affected by changes + +## Usage + +```bash +affected:lint +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/affected-test.md b/docs/react/api-workspace/npmscripts/affected-test.md new file mode 100644 index 0000000000..2306af739a --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected-test.md @@ -0,0 +1,71 @@ +# affected:test + +Test projects affected by changes + +## Usage + +```bash +affected:test +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/affected.md b/docs/react/api-workspace/npmscripts/affected.md new file mode 100644 index 0000000000..51d4478ec7 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/affected.md @@ -0,0 +1,75 @@ +# affected + +Run task for affected projects + +## Usage + +```bash +affected +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### target + +Task to run for affected projects + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/dep-graph.md b/docs/react/api-workspace/npmscripts/dep-graph.md new file mode 100644 index 0000000000..e8f46de038 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/dep-graph.md @@ -0,0 +1,63 @@ +# dep-graph + +Graph dependencies within workspace + +## Usage + +```bash +dep-graph +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### file + +output file (e.g. --file=.vis/output.json) + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/format-check.md b/docs/react/api-workspace/npmscripts/format-check.md new file mode 100644 index 0000000000..ed6fbc290f --- /dev/null +++ b/docs/react/api-workspace/npmscripts/format-check.md @@ -0,0 +1,61 @@ +# format:check + +Check for un-formatted files + +## Usage + +```bash +format:check +``` + + ## Options + +### all + +All projects + +### apps-and-libs + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/format-write.md b/docs/react/api-workspace/npmscripts/format-write.md new file mode 100644 index 0000000000..d138ab63be --- /dev/null +++ b/docs/react/api-workspace/npmscripts/format-write.md @@ -0,0 +1,61 @@ +# format:write + +Overwrite un-formatted files + +## Usage + +```bash +format:write +``` + + ## Options + +### all + +All projects + +### apps-and-libs + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/workspace-lint-files.md b/docs/react/api-workspace/npmscripts/workspace-lint-files.md new file mode 100644 index 0000000000..79acf1c024 --- /dev/null +++ b/docs/react/api-workspace/npmscripts/workspace-lint-files.md @@ -0,0 +1,19 @@ +# workspace-lint [files..] + +Lint workspace or list of files + +## Usage + +```bash +workspace-lint [files..] +``` + + ## Options + +### help + +Show help + +### version + +Show version number diff --git a/docs/react/api-workspace/npmscripts/workspace-schematic-name.md b/docs/react/api-workspace/npmscripts/workspace-schematic-name.md new file mode 100644 index 0000000000..f3f1cc18ad --- /dev/null +++ b/docs/react/api-workspace/npmscripts/workspace-schematic-name.md @@ -0,0 +1,27 @@ +# workspace-schematic [name] + +Runs a workspace schematic from the tools/schematics directory + +## Usage + +```bash +workspace-schematic [name] +``` + + ## Options + +### help + +Show help + +### list-schematics + +List the available workspace-schematics + +### name + +The name of your schematic` + +### version + +Show version number diff --git a/docs/react/api-workspace/schematics/library.md b/docs/react/api-workspace/schematics/library.md new file mode 100644 index 0000000000..0abf734a18 --- /dev/null +++ b/docs/react/api-workspace/schematics/library.md @@ -0,0 +1,62 @@ +# library + +Create a library + +## Usage + +```bash +nx generate library ... + +``` + +## Options + +### directory + +Type: `string` + +A directory where the app is placed + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +Library name + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipTsConfig + +Default: `false` + +Type: `boolean` + +Do not update tsconfig.json for development experience. + +### tags + +Type: `string` + +Add tags to the library (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/react/api-workspace/schematics/ng-add.md b/docs/react/api-workspace/schematics/ng-add.md new file mode 100644 index 0000000000..b901a32950 --- /dev/null +++ b/docs/react/api-workspace/schematics/ng-add.md @@ -0,0 +1,32 @@ +# ng-add [hidden] + +Convert an existing CLI project into an Nx Workspace + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### name + +Type: `string` + +Project name. + +### npmScope + +Type: `string` + +Npm scope for importing libs. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing after adding @nrwl/workspace diff --git a/docs/react/api-workspace/schematics/ng-new.md b/docs/react/api-workspace/schematics/ng-new.md new file mode 100644 index 0000000000..f7af293381 --- /dev/null +++ b/docs/react/api-workspace/schematics/ng-new.md @@ -0,0 +1,78 @@ +# ng-new [hidden] + +Create a workspace + +## Usage + +```bash +nx generate ng-new ... + +``` + +## Options + +### appName + +Type: `string` + +Application name. + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. + +### directory + +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. + +### preset + +Default: `empty` + +Type: `string` + +What to create in the new workspace + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/react/api-workspace/schematics/preset.md b/docs/react/api-workspace/schematics/preset.md new file mode 100644 index 0000000000..a4d7a0b51b --- /dev/null +++ b/docs/react/api-workspace/schematics/preset.md @@ -0,0 +1,44 @@ +# preset [hidden] + +Create application in an empty workspace + +## Usage + +```bash +nx generate preset ... + +``` + +## Options + +### cli + +Type: `string` + +CLI powering the workspace. + +### name + +Type: `string` + +The name of the application. + +### npmScope + +Type: `string` + +Npm scope for importing libs. + +### preset + +Type: `string` + +The name of the preset. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/react/api-workspace/schematics/tao-new.md b/docs/react/api-workspace/schematics/tao-new.md new file mode 100644 index 0000000000..f2cd807384 --- /dev/null +++ b/docs/react/api-workspace/schematics/tao-new.md @@ -0,0 +1,78 @@ +# tao-new [hidden] + +Create a workspace + +## Usage + +```bash +nx generate tao-new ... + +``` + +## Options + +### appName + +Type: `string` + +Application name. + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. + +### directory + +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. + +### preset + +Default: `empty` + +Type: `string` + +What to create in the new workspace + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/react/api-workspace/schematics/workspace-schematic.md b/docs/react/api-workspace/schematics/workspace-schematic.md new file mode 100644 index 0000000000..4432eaaf55 --- /dev/null +++ b/docs/react/api-workspace/schematics/workspace-schematic.md @@ -0,0 +1,26 @@ +# workspace-schematic + +Generates a workspace schematic + +## Usage + +```bash +nx generate workspace-schematic ... + +``` + +## Options + +### name + +Type: `string` + +Schematic name + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/react/api-workspace/schematics/workspace.md b/docs/react/api-workspace/schematics/workspace.md new file mode 100644 index 0000000000..f557cd1323 --- /dev/null +++ b/docs/react/api-workspace/schematics/workspace.md @@ -0,0 +1,72 @@ +# workspace [hidden] + +Create an empty workspace + +## Usage + +```bash +nx generate workspace ... + +``` + +## Options + +### cli + +Default: `nx` + +Type: `string` + +CLI used for generating code and running tasks + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. + +### directory + +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. + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/react/api/home.md b/docs/react/api/home.md new file mode 100644 index 0000000000..af6fa6164a --- /dev/null +++ b/docs/react/api/home.md @@ -0,0 +1,49 @@ +# API + +Here is the list of all the available packages inside the Nx ecosystem. You +can see, for each package its dependencies. + +| PackageName | Dependencies | PeerDependencies | +| --------------- | --------------------------------------- | ---------------- | +| @nrwl/angular | @nrwl/cypress, @nrwl/jest | @nrwl/workspace | +| @nrwl/cypress | | @nrwl/workspace | +| @nrwl/express | @nrwl/node, @nrwl/jest | @nrwl/workspace | +| @nrwl/jest | | @nrwl/workspace | +| @nrwl/linter | | @nrwl/workspace | +| @nrwl/nest | @nrwl/node, @nrwl/jest | @nrwl/workspace | +| @nrwl/node | @nrwl/jest, @nrwl/linter | @nrwl/workspace | +| @nrwl/react | @nrwl/cypress, @nrwl/jest, @nrwl/web | @nrwl/workspace | +| @nrwl/web | @nrwl/cypress, @nrwl/jest, @nrwl/linter | @nrwl/workspace | +| @nrwl/workspace | @nrwl/cli | | + +## Angular + +![Angular](/assets/content/api/angular.jpg) + +## React + +![React](/assets/content/api/react.jpg) + +## Nest + +![Nest](/assets/content/api/nest.jpg) + +## Express + +![Express](/assets/content/api/express.jpg) + +## Node + +![Node](/assets/content/api/node.jpg) + +## Cypress + +![Cypress](/assets/content/api/cypress.jpg) + +## Jest + +![Jest](/assets/content/api/jest.jpg) + +## Web + +![Web](/assets/content/api/web.jpg) diff --git a/docs/react/builders.json b/docs/react/builders.json new file mode 100644 index 0000000000..4e2c6c1f1a --- /dev/null +++ b/docs/react/builders.json @@ -0,0 +1 @@ +["cypress", "express", "jest", "linter", "nest", "node", "web", "workspace"] diff --git a/docs/react/schematics.json b/docs/react/schematics.json new file mode 100644 index 0000000000..95046b7aa8 --- /dev/null +++ b/docs/react/schematics.json @@ -0,0 +1,11 @@ +[ + "angular", + "cypress", + "express", + "jest", + "nest", + "node", + "react", + "web", + "workspace" +] diff --git a/docs/api/angular.jpg b/docs/shared/api/angular.jpg similarity index 100% rename from docs/api/angular.jpg rename to docs/shared/api/angular.jpg diff --git a/docs/api/cypress.jpg b/docs/shared/api/cypress.jpg similarity index 100% rename from docs/api/cypress.jpg rename to docs/shared/api/cypress.jpg diff --git a/docs/api/express.jpg b/docs/shared/api/express.jpg similarity index 100% rename from docs/api/express.jpg rename to docs/shared/api/express.jpg diff --git a/docs/api/jest.jpg b/docs/shared/api/jest.jpg similarity index 100% rename from docs/api/jest.jpg rename to docs/shared/api/jest.jpg diff --git a/docs/api/nest.jpg b/docs/shared/api/nest.jpg similarity index 100% rename from docs/api/nest.jpg rename to docs/shared/api/nest.jpg diff --git a/docs/api/node.jpg b/docs/shared/api/node.jpg similarity index 100% rename from docs/api/node.jpg rename to docs/shared/api/node.jpg diff --git a/docs/api/react.jpg b/docs/shared/api/react.jpg similarity index 100% rename from docs/api/react.jpg rename to docs/shared/api/react.jpg diff --git a/docs/api/web.jpg b/docs/shared/api/web.jpg similarity index 100% rename from docs/api/web.jpg rename to docs/shared/api/web.jpg diff --git a/docs/web/api-angular/schematics/application.md b/docs/web/api-angular/schematics/application.md new file mode 100644 index 0000000000..00e7169e8c --- /dev/null +++ b/docs/web/api-angular/schematics/application.md @@ -0,0 +1,138 @@ +# application + +Create an Angular application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### enableIvy + +Default: `false` + +Type: `boolean` + +**EXPERIMENTAL** True to create a new app that uses the Ivy rendering engine. + +### inlineStyle + +Alias(es): s + +Default: `false` + +Type: `boolean` + +Specifies if the style will be in the ts file. + +### inlineTemplate + +Alias(es): t + +Default: `false` + +Type: `boolean` + +Specifies if the template will be in the ts file. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### prefix + +Alias(es): p + +Type: `string` + +The prefix to apply to generated selectors. + +### routing + +Default: `false` + +Type: `boolean` + +Generates a routing module. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### skipTests + +Alias(es): S + +Default: `false` + +Type: `boolean` + +Skip creating spec files. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests + +### viewEncapsulation + +Type: `string` + +Specifies the view encapsulation strategy. diff --git a/docs/web/api-angular/schematics/downgrade-module.md b/docs/web/api-angular/schematics/downgrade-module.md new file mode 100644 index 0000000000..84d6bcb7bf --- /dev/null +++ b/docs/web/api-angular/schematics/downgrade-module.md @@ -0,0 +1,46 @@ +# downgrade-module + +Setup Downgrade Module + +## Usage + +```bash +nx generate downgrade-module ... + +``` + +## Options + +### angularJsImport + +Type: `string` + +Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). + +### name + +Type: `string` + +The name of the main AngularJS module. + +### project + +Type: `string` + +The name of the project + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add @angular/upgrade to package.json (e.g., --skipPackageJson) diff --git a/docs/web/api-angular/schematics/karma-project.md b/docs/web/api-angular/schematics/karma-project.md new file mode 100644 index 0000000000..bad4856406 --- /dev/null +++ b/docs/web/api-angular/schematics/karma-project.md @@ -0,0 +1,18 @@ +# karma-project + +Add karma testing to a project + +## Usage + +```bash +nx generate karma-project ... + +``` + +## Options + +### project + +Type: `string` + +The name of the project. diff --git a/docs/web/api-angular/schematics/karma.md b/docs/web/api-angular/schematics/karma.md new file mode 100644 index 0000000000..dcbf3d04a7 --- /dev/null +++ b/docs/web/api-angular/schematics/karma.md @@ -0,0 +1,10 @@ +# karma + +Add karma configuration to a workspace + +## Usage + +```bash +nx generate karma ... + +``` diff --git a/docs/web/api-angular/schematics/library.md b/docs/web/api-angular/schematics/library.md new file mode 100644 index 0000000000..997046f817 --- /dev/null +++ b/docs/web/api-angular/schematics/library.md @@ -0,0 +1,116 @@ +# library + +Create an Angular library + +## Usage + +```bash +nx generate library ... + +``` + +## Options + +### directory + +Type: `string` + +A directory where the app is placed + +### lazy + +Default: `false` + +Type: `boolean` + +Add RouterModule.forChild when set to true, and a simple array of routes when set to false. + +### name + +Type: `string` + +Library name + +### parentModule + +Type: `string` + +Update the router configuration of the parent module using loadChildren or children, depending on what `lazy` is set to. + +### prefix + +Alias(es): p + +Type: `string` + +The prefix to apply to generated selectors. + +### publishable + +Default: `false` + +Type: `boolean` + +Generate a simple TS library when set to true. + +### routing + +Default: `false` + +Type: `boolean` + +Add router configuration. See lazy for more information. + +### simpleModuleName + +Default: `false` + +Type: `boolean` + +Keep the module name simple (when using --directory) + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### skipTsConfig + +Default: `false` + +Type: `boolean` + +Do not update tsconfig.json for development experience. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Type: `string` + +Add tags to the library (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-angular/schematics/ng-add.md b/docs/web/api-angular/schematics/ng-add.md new file mode 100644 index 0000000000..762b0a1103 --- /dev/null +++ b/docs/web/api-angular/schematics/ng-add.md @@ -0,0 +1,44 @@ +# ng-add [hidden] + +Add @nrwl/angular to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing after adding @nrwl/workspace + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-angular/schematics/ngrx.md b/docs/web/api-angular/schematics/ngrx.md new file mode 100644 index 0000000000..d006ce011a --- /dev/null +++ b/docs/web/api-angular/schematics/ngrx.md @@ -0,0 +1,104 @@ +# ngrx + +Add an ngrx config to a project + +## Usage + +```bash +nx generate ngrx ... + +``` + +## Options + +### directory + +Default: `+state` + +Type: `string` + +The name of the folder used to contain/group the generated NgRx files. + +### facade + +Default: `false` + +Type: `boolean` + +Create a Facade class for the the Feature. + +### minimal + +Default: `false` + +Type: `boolean` + +Only register the root state management setup or feature state. + +### module + +Type: `string` + +The path to NgModule where the feature state will be registered. The host directory will create/use the new state directory. + +### name + +Type: `string` + +Name of the NgRx feature state, such as "products" or "users"). Recommended to use the plural form of the name. + +### onlyAddFiles + +Default: `false` + +Type: `boolean` + +**Deprecated**, use `skipImport`. Only add new NgRx files, without changing the module file (e.g., --onlyAddFiles). + +### onlyEmptyRoot + +Default: `false` + +Type: `boolean` + +**Deprecated**, use `minimal`. Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot). + +### root + +Default: `false` + +Type: `boolean` + +Setup root or feature state management with NgRx. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting of generated files. + +### skipImport + +Default: `false` + +Type: `boolean` + +Generate NgRx feature files without registering the feature in the NgModule. + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not update the package.json with NgRx dependencies. + +### syntax + +Default: `classes` + +Type: `string` + +Specifies whether to use class-based or creator functions for actions, reducers, and effects. diff --git a/docs/web/api-angular/schematics/upgrade-module.md b/docs/web/api-angular/schematics/upgrade-module.md new file mode 100644 index 0000000000..8c5e74f96f --- /dev/null +++ b/docs/web/api-angular/schematics/upgrade-module.md @@ -0,0 +1,60 @@ +# upgrade-module + +Add an upgrade module + +## Usage + +```bash +nx generate upgrade-module ... + +``` + +## Options + +### angularJsCmpSelector + +Type: `string` + +The selector of an AngularJS component (e.g., --angularJsCmpSelector=myComponent) + +### angularJsImport + +Type: `string` + +Import expression of the AngularJS application (e.g., --angularJsImport=some_node_module/my_app). + +### name + +Type: `string` + +The name of the main AngularJS module. + +### project + +Type: `string` + +The name of the project + +### router + +Default: `false` + +Type: `boolean` + +Sets up router synchronization (e.g., --router) + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add @angular/upgrade to package.json (e.g., --skipPackageJson) diff --git a/docs/web/api-cypress/builders/cypress.md b/docs/web/api-cypress/builders/cypress.md new file mode 100644 index 0000000000..8651be8bbc --- /dev/null +++ b/docs/web/api-cypress/builders/cypress.md @@ -0,0 +1,93 @@ +# cypress + +Run Cypress e2e tests + +## Properties + +### baseUrl + +Type: `string` + +Use this to pass directly the address of your distant server address with the port running your application + +### browser + +Type: `string` + +The browser to run tests in. + +### copyFiles + +Type: `string` + +DEPRECATED: A regex string that is used to choose what additional integration files to copy to the dist folder + +### cypressConfig + +Type: `string` + +The path of the Cypress configuration json file. + +### devServerTarget + +Type: `string` + +Dev server target to run tests against. + +### exit + +Default: `true` + +Type: `boolean` + +Whether or not the Cypress Test Runner will stay open after running tests in a spec file + +### headless + +Default: `false` + +Type: `boolean` + +Whether or not to open the Cypress application to run the tests. If set to 'true', will run in headless mode + +### key + +Type: `string` + +The key cypress should use to run tests in parallel/record the run (CI only) + +### parallel + +Default: `false` + +Type: `boolean` + +Whether or not Cypress should run its tests in parallel (CI only) + +### record + +Default: `false` + +Type: `boolean` + +Whether or not Cypress should record the results of the tests + +### spec + +Type: `string` + +A comma delimited glob string that is provided to the Cypress runner to specify which spec files to run. i.e. '**examples/**,**actions.spec** + +### tsConfig + +Type: `string` + +The path of the Cypress tsconfig configuration json file. + +### watch + +Default: `false` + +Type: `boolean` + +Recompile and run tests when files change. diff --git a/docs/web/api-cypress/schematics/cypress-project.md b/docs/web/api-cypress/schematics/cypress-project.md new file mode 100644 index 0000000000..c9d6950b69 --- /dev/null +++ b/docs/web/api-cypress/schematics/cypress-project.md @@ -0,0 +1,38 @@ +# cypress-project [hidden] + +Add a Cypress E2E Project + +## Usage + +```bash +nx generate cypress-project ... + +``` + +## Options + +### directory + +Type: `string` + +A directory where the project is placed + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +Name of the E2E Project + +### project + +Type: `string` + +The name of the frontend project to test. diff --git a/docs/web/api-cypress/schematics/ng-add.md b/docs/web/api-cypress/schematics/ng-add.md new file mode 100644 index 0000000000..e5400d40ab --- /dev/null +++ b/docs/web/api-cypress/schematics/ng-add.md @@ -0,0 +1,10 @@ +# ng-add [hidden] + +Add Cypress configuration to the workspace + +## Usage + +```bash +nx generate ng-add ... + +``` diff --git a/docs/web/api-express/schematics/application.md b/docs/web/api-express/schematics/application.md new file mode 100644 index 0000000000..3082318fc2 --- /dev/null +++ b/docs/web/api-express/schematics/application.md @@ -0,0 +1,68 @@ +# application + +Create an express application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### frontendProject + +Type: `string` + +Frontend project that needs to access this application. This sets up proxy configuration. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-express/schematics/ng-add.md b/docs/web/api-express/schematics/ng-add.md new file mode 100644 index 0000000000..fb7cfd898c --- /dev/null +++ b/docs/web/api-express/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/express to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/web/api-jest/builders/jest.md b/docs/web/api-jest/builders/jest.md new file mode 100644 index 0000000000..29d919a547 --- /dev/null +++ b/docs/web/api-jest/builders/jest.md @@ -0,0 +1,199 @@ +# jest + +Run Jest unit tests + +## Properties + +### bail + +Alias(es): b + +Type: `number` + +Exit the test suite immediately after `n` number of failing tests. (https://jestjs.io/docs/en/cli#bail) + +### ci + +Type: `boolean` + +Whether to run Jest in continuous integration (CI) mode. This option is on by default in most popular CI environments. It will prevent snapshots from being written unless explicitly requested. (https://jestjs.io/docs/en/cli#ci) + +### clearCache + +Type: `boolean` + +Deletes the Jest cache directory and then exits without running tests. Will delete Jest's default cache directory. _Note: clearing the cache will reduce performance_. + +### codeCoverage + +Type: `boolean` + +Indicates that test coverage information should be collected and reported in the output. (https://jestjs.io/docs/en/cli#coverage) + +### color + +Alias(es): colors + +Type: `boolean` + +Forces test results output color highlighting (even if stdout is not a TTY). Set to false if you would like to have no colors. (https://jestjs.io/docs/en/cli#colors) + +### colors + +Type: `boolean` + +Forces test results output highlighting even if stdout is not a TTY. (https://jestjs.io/docs/en/cli#colors) + +### config + +Type: `string` + +The path to a Jest config file specifying how to find and execute tests. If no rootDir is set in the config, the directory containing the config file is assumed to be the rootDir for the project. This can also be a JSON-encoded value which Jest will use as configuration + +### coverage + +Type: `boolean` + +Indicates that test coverage information should be collected and reported in the output. This option is also aliased by --collectCoverage. (https://jestjs.io/docs/en/cli#coverage) + +### coverageDirectory + +Type: `string` + +An array of regexp pattern strings that are matched against all file paths before executing the test. If the file path matches any of the patterns, coverage information will be skipped. + +### coverageReporters + +Type: `string` + +A list of reporter names that Jest uses when writing coverage reports. Any istanbul reporter + +### findRelatedTests + +Type: `string` + +Find and run the tests that cover a comma separated list of source files that were passed in as arguments. (https://jestjs.io/docs/en/cli#findrelatedtests-spaceseparatedlistofsourcefiles) + +### jestConfig + +Type: `string` + +The path of the Jest configuration. (https://jestjs.io/docs/en/configuration) + +### json + +Type: `boolean` + +Prints the test results in JSON. This mode will send all other test output and user messages to stderr. (https://jestjs.io/docs/en/cli#json) + +### maxWorkers + +Alias(es): w + +Type: `number` + +Specifies the maximum number of workers the worker-pool will spawn for running tests. This defaults to the number of the cores available on your machine. Useful for CI. (its usually best not to override this default) (https://jestjs.io/docs/en/cli#maxworkers-num) + +### onlyChanged + +Alias(es): o + +Type: `boolean` + +Attempts to identify which tests to run based on which files have changed in the current repository. Only works if you're running tests in a git or hg repository at the moment. (https://jestjs.io/docs/en/cli#onlychanged) + +### outputFile + +Type: `string` + +Write test results to a file when the --json option is also specified. (https://jestjs.io/docs/en/cli#outputfile-filename) + +### passWithNoTests + +Type: `boolean` + +Will not fail if no tests are found (for example while using `--testPathPattern`.) (https://jestjs.io/docs/en/cli#passwithnotests) + +### reporters + +Type: `array` + +Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple reporters: jest --reporters="default" --reporters="jest-junit" (https://jestjs.io/docs/en/cli#reporters) + +### runInBand + +Alias(es): i + +Type: `boolean` + +Run all tests serially in the current process (rather than creating a worker pool of child processes that run tests). This is sometimes useful for debugging, but such use cases are pretty rare. Useful for CI. (https://jestjs.io/docs/en/cli#runinband) + +### setupFile + +Type: `string` + +The name of a setup file used by Jest. (https://jestjs.io/docs/en/configuration#setupfilesafterenv-array) + +### silent + +Type: `boolean` + +Prevent tests from printing messages through the console. (https://jestjs.io/docs/en/cli#silent) + +### testFile + +Type: `string` + +The name of the file to test. + +### testNamePattern + +Alias(es): t + +Type: `string` + +Run only tests with a name that matches the regex pattern. (https://jestjs.io/docs/en/cli#testnamepattern-regex) + +### testPathPattern + +Type: `string` + +A regexp pattern string that is matched against all tests paths before executing the test. (https://jestjs.io/docs/en/cli#testpathpattern-regex) + +### tsConfig + +Type: `string` + +The name of the Typescript configuration file. + +### updateSnapshot + +Alias(es): u + +Type: `boolean` + +Use this flag to re-record snapshots. Can be used together with a test suite pattern or with `--testNamePattern` to re-record snapshot for test matching the pattern. (https://jestjs.io/docs/en/cli#updatesnapshot) + +### useStderr + +Type: `boolean` + +Divert all output to stderr. + +### verbose + +Type: `string` + +Display individual test results with the test suite hierarchy. (https://jestjs.io/docs/en/cli#verbose) + +### watch + +Type: `boolean` + +Watch files for changes and rerun tests related to changed files. If you want to re-run all tests when a file has changed, use the `--watchAll` option. (https://jestjs.io/docs/en/cli#watch) + +### watchAll + +Type: `boolean` + +Watch files for changes and rerun all tests when something changes. If you want to re-run only the tests that depend on the changed files, use the `--watch` option. (https://jestjs.io/docs/en/cli#watchall) diff --git a/docs/web/api-jest/schematics/jest-project.md b/docs/web/api-jest/schematics/jest-project.md new file mode 100644 index 0000000000..a7da8773a8 --- /dev/null +++ b/docs/web/api-jest/schematics/jest-project.md @@ -0,0 +1,50 @@ +# jest-project [hidden] + +Add Jest configuration to a project + +## Usage + +```bash +nx generate jest-project ... + +``` + +## Options + +### project + +Type: `string` + +The name of the project. + +### setupFile + +Default: `none` + +Type: `string` + +The setup file to be generated + +### skipSerializers + +Default: `false` + +Type: `boolean` + +Skips the serializers required to snapshot angular templates + +### skipSetupFile + +Default: `false` + +Type: `boolean` + +[Deprecated]: Skips the setup file required for angular. (Use --setup-file) + +### supportTsx + +Default: `false` + +Type: `boolean` + +Setup tsx support diff --git a/docs/web/api-jest/schematics/ng-add.md b/docs/web/api-jest/schematics/ng-add.md new file mode 100644 index 0000000000..e0b4ef8a6b --- /dev/null +++ b/docs/web/api-jest/schematics/ng-add.md @@ -0,0 +1,10 @@ +# ng-add [hidden] + +Add Jest configuration to the workspace + +## Usage + +```bash +nx generate ng-add ... + +``` diff --git a/docs/web/api-linter/builders/lint.md b/docs/web/api-linter/builders/lint.md new file mode 100644 index 0000000000..7aa2c8a1ef --- /dev/null +++ b/docs/web/api-linter/builders/lint.md @@ -0,0 +1,53 @@ +# lint + +Lint a project + +## Properties + +### config + +Type: `string` + +The name of the configuration file. + +### exclude + +Type: `array` + +Files to exclude from linting. + +### files + +Type: `array` + +Files to include in linting. + +### fix + +Default: `false` + +Type: `boolean` + +Fixes linting errors (may overwrite linted files). + +### format + +Default: `prose` + +Type: `string` + +Output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist). + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### tsConfig + +Type: `string` + +The name of the TypeScript configuration file. diff --git a/docs/web/api-nest/schematics/application.md b/docs/web/api-nest/schematics/application.md new file mode 100644 index 0000000000..842af3bdb3 --- /dev/null +++ b/docs/web/api-nest/schematics/application.md @@ -0,0 +1,68 @@ +# application + +Create a nest application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### frontendProject + +Type: `string` + +Frontend project that needs to access this application. This sets up proxy configuration. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-nest/schematics/ng-add.md b/docs/web/api-nest/schematics/ng-add.md new file mode 100644 index 0000000000..6726a04070 --- /dev/null +++ b/docs/web/api-nest/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/nest to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/web/api-node/builders/build.md b/docs/web/api-node/builders/build.md new file mode 100644 index 0000000000..8fb4c90e2b --- /dev/null +++ b/docs/web/api-node/builders/build.md @@ -0,0 +1,131 @@ +# build + +Build a Node application + +## Properties + +### assets + +Type: `array` + +List of static application assets. + +### externalDependencies + +Default: `all` + +Type: `string` + +Dependencies to keep external to the bundle. ("all" (default), "none", or an array of module names) + +### extractLicenses + +Default: `false` + +Type: `boolean` + +Extract all licenses in a separate file, in the case of production builds only. + +### fileReplacements + +Type: `array` of `object` + +Replace files with other files in the build. + +#### replace + +Type: `string` + +undefined + +#### with + +Type: `string` + +undefined + +### main + +Type: `string` + +The name of the main entry-point file. + +### maxWorkers + +Type: `number` + +Number of workers to use for type checking. (defaults to # of CPUS - 2) + +### optimization + +Default: `false` + +Type: `boolean` + +Defines the optimization level of the build. + +### poll + +Type: `number` + +Frequency of file watcher in ms. + +### progress + +Default: `false` + +Type: `boolean` + +Log progress to the console while building. + +### showCircularDependencies + +Default: `true` + +Type: `boolean` + +Show circular dependency warnings on builds. + +### sourceMap + +Default: `true` + +Type: `boolean` + +Produce source maps. + +### statsJson + +Default: `false` + +Type: `boolean` + +Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https: //webpack.github.io/analyse. + +### tsConfig + +Type: `string` + +The name of the Typescript configuration file. + +### verbose + +Default: `false` + +Type: `boolean` + +Emits verbose output + +### watch + +Default: `false` + +Type: `boolean` + +Run build when files change. + +### webpackConfig + +Type: `string` + +Path to a function which takes a webpack config, context and returns the resulting webpack config diff --git a/docs/web/api-node/builders/execute.md b/docs/web/api-node/builders/execute.md new file mode 100644 index 0000000000..55ba6682d8 --- /dev/null +++ b/docs/web/api-node/builders/execute.md @@ -0,0 +1,47 @@ +# execute + +Execute a Node application + +## Properties + +### args + +Type: `array` + +Extra args when starting the app + +### buildTarget + +Type: `string` + +The target to run to build you the app + +### host + +Default: `localhost` + +Type: `string` + +The host to inspect the process on + +### inspect + +Default: `inspect` + +Type: `string` + +Ensures the app is starting with debugging + +### port + +Default: `7777` + +Type: `number` + +The port to inspect the process on. Setting port to 0 will assign random free ports to all forked processes. + +### waitUntilTargets + +Type: `array` + +The targets to run to before starting the node app diff --git a/docs/web/api-node/schematics/application.md b/docs/web/api-node/schematics/application.md new file mode 100644 index 0000000000..c51980eb8c --- /dev/null +++ b/docs/web/api-node/schematics/application.md @@ -0,0 +1,68 @@ +# application + +Create a node application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### frontendProject + +Type: `string` + +Frontend project that needs to access this application. This sets up proxy configuration. + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipPackageJson + +Default: `false` + +Type: `boolean` + +Do not add dependencies to package.json. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-node/schematics/ng-add.md b/docs/web/api-node/schematics/ng-add.md new file mode 100644 index 0000000000..821e278fd0 --- /dev/null +++ b/docs/web/api-node/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/node to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/web/api-react/schematics/application.md b/docs/web/api-react/schematics/application.md new file mode 100644 index 0000000000..5dc8535d69 --- /dev/null +++ b/docs/web/api-react/schematics/application.md @@ -0,0 +1,118 @@ +# application + +Create an application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### babel + +Default: `false` + +Type: `boolean` + +Use Babel and TypeScript preset instead of ts-loader (Useful if you need Babel plugins) + +### classComponent + +Alias(es): C + +Default: `false` + +Type: `boolean` + +Use class components instead of functional component + +### directory + +Alias(es): d + +Type: `string` + +The directory of the new application. + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### pascalCaseFiles + +Alias(es): P + +Default: `false` + +Type: `boolean` + +Use pascal case component file name (e.g. App.tsx) + +### routing + +Type: `boolean` + +Generate application with routes + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipWorkspaceJson + +Default: `false` + +Type: `boolean` + +Skip updating workspace.json with default schematic options based on values provided to this app (e.g. babel, style) + +### style + +Alias(es): s + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Alias(es): t + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-react/schematics/component.md b/docs/web/api-react/schematics/component.md new file mode 100644 index 0000000000..183205c27f --- /dev/null +++ b/docs/web/api-react/schematics/component.md @@ -0,0 +1,88 @@ +# component + +Create a component + +## Usage + +```bash +nx generate component ... + +``` + +## Options + +### classComponent + +Alias(es): C + +Default: `false` + +Type: `boolean` + +Use class components instead of functional component. + +### directory + +Alias(es): d + +Type: `string` + +Create the component under this directory (can be nested). + +### export + +Alias(es): e + +Default: `false` + +Type: `boolean` + +When true, the component is exported from the project index.ts (if it exists). + +### name + +Type: `string` + +The name of the component. + +### pascalCaseFiles + +Alias(es): P + +Default: `false` + +Type: `boolean` + +Use pascal case component file name (e.g. App.tsx). + +### project + +Alias(es): p + +Type: `string` + +The name of the project. + +### routing + +Type: `boolean` + +Generate a library with routes. + +### skipTests + +Default: `false` + +Type: `boolean` + +When true, does not create "spec.ts" test files for the new component. + +### style + +Alias(es): s + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/web/api-react/schematics/library.md b/docs/web/api-react/schematics/library.md new file mode 100644 index 0000000000..a6ce83277c --- /dev/null +++ b/docs/web/api-react/schematics/library.md @@ -0,0 +1,100 @@ +# library + +Create a library + +## Usage + +```bash +nx generate library ... + +``` + +## Options + +### appProject + +Alias(es): a + +Type: `string` + +The application project to add the library route to + +### directory + +Alias(es): d + +Type: `string` + +A directory where the app is placed + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +Library name + +### pascalCaseFiles + +Alias(es): P + +Default: `false` + +Type: `boolean` + +Use pascal case component file name (e.g. App.tsx) + +### routing + +Type: `boolean` + +Generate library with routes + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipTsConfig + +Default: `false` + +Type: `boolean` + +Do not update tsconfig.json for development experience. + +### style + +Alias(es): s + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Alias(es): t + +Type: `string` + +Add tags to the library (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-react/schematics/ng-add.md b/docs/web/api-react/schematics/ng-add.md new file mode 100644 index 0000000000..4d47eb790e --- /dev/null +++ b/docs/web/api-react/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/react to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/web/api-web/builders/build.md b/docs/web/api-web/builders/build.md new file mode 100644 index 0000000000..d4a31569d8 --- /dev/null +++ b/docs/web/api-web/builders/build.md @@ -0,0 +1,221 @@ +# build + +Build a application + +## Properties + +### assets + +Type: `array` + +List of static application assets. + +### baseHref + +Default: `/` + +Type: `string` + +Base url for the application being built. + +### budgets + +Type: `array` + +Budget thresholds to ensure parts of your application stay within boundaries which you set. + +### commonChunk + +Default: `true` + +Type: `boolean` + +Use a separate bundle containing code used across multiple bundles. + +### deployUrl + +Type: `string` + +URL where the application will be deployed. + +### differentialLoading + +Default: `true` + +Type: `boolean` + +Enable differential loading for es5 browsers + +### es2015Polyfills + +Type: `string` + +Conditional polyfills loaded in browsers which do not support ES2015. + +### extractCss + +Default: `false` + +Type: `boolean` + +Extract css into a .css file + +### extractLicenses + +Default: `false` + +Type: `boolean` + +Extract all licenses in a separate file, in the case of production builds only. + +### fileReplacements + +Type: `array` of `object` + +Replace files with other files in the build. + +#### replace + +Type: `string` + +undefined + +#### with + +Type: `string` + +undefined + +### index + +Type: `string` + +HTML File which will be contain the application + +### main + +Type: `string` + +The name of the main entry-point file. + +### maxWorkers + +Type: `number` + +Number of workers to use for type checking. (defaults to # of CPUS - 2) + +### namedChunks + +Default: `true` + +Type: `boolean` + +Names the produced bundles according to their entry file + +### optimization + +Type: `boolean` + +Enables optimization of the build output. + +### outputHashing + +Default: `none` + +Type: `string` + +Define the output filename cache-busting hashing mode. + +### polyfills + +Type: `string` + +Polyfills to load before application + +### progress + +Default: `false` + +Type: `boolean` + +Log progress to the console while building. + +### scripts + +Type: `array` + +External Scripts which will be included before the main application entry + +### showCircularDependencies + +Default: `true` + +Type: `boolean` + +Show circular dependency warnings on builds. + +### sourceMap + +Default: `true` + +Type: `boolean` + +Output sourcemaps. + +### statsJson + +Default: `false` + +Type: `boolean` + +Generates a 'stats.json' file which can be analyzed using tools such as: #webpack-bundle-analyzer' or https://webpack.github.io/analyse. + +### styles + +Type: `array` + +External Styles which will be included with the application + +### subresourceIntegrity + +Default: `false` + +Type: `boolean` + +Enables the use of subresource integrity validation. + +### tsConfig + +Type: `string` + +The name of the Typescript configuration file. + +### vendorChunk + +Default: `true` + +Type: `boolean` + +Use a separate bundle containing only vendor libraries. + +### verbose + +Default: `false` + +Type: `boolean` + +Emits verbose output + +### watch + +Default: `false` + +Type: `boolean` + +Enable re-building when files change. + +### webpackConfig + +Type: `string` + +Path to a function which takes a webpack config, some context and returns the resulting webpack config diff --git a/docs/web/api-web/builders/dev-server.md b/docs/web/api-web/builders/dev-server.md new file mode 100644 index 0000000000..b8a4f94863 --- /dev/null +++ b/docs/web/api-web/builders/dev-server.md @@ -0,0 +1,77 @@ +# dev-server + +Serve a web application + +## Properties + +### buildTarget + +Type: `string` + +Target which builds the application + +### host + +Default: `localhost` + +Type: `string` + +Host to listen on. + +### liveReload + +Default: `true` + +Type: `boolean` + +Whether to reload the page on change, using live-reload. + +### open + +Default: `false` + +Type: `boolean` + +Open the application in the browser. + +### port + +Default: `4200` + +Type: `number` + +Port to listen on. + +### publicHost + +Type: `string` + +Public URL where the application will be served + +### ssl + +Default: `false` + +Type: `boolean` + +Serve using HTTPS. + +### sslCert + +Type: `string` + +SSL certificate to use for serving HTTPS. + +### sslKey + +Type: `string` + +SSL key to use for serving HTTPS. + +### watch + +Default: `true` + +Type: `boolean` + +Watches for changes and rebuilds application diff --git a/docs/web/api-web/schematics/application.md b/docs/web/api-web/schematics/application.md new file mode 100644 index 0000000000..9c384a2cbb --- /dev/null +++ b/docs/web/api-web/schematics/application.md @@ -0,0 +1,70 @@ +# application + +Create an application + +## Usage + +```bash +nx generate application ... + +``` + +## Options + +### directory + +Type: `string` + +The directory of the new application. + +### e2eTestRunner + +Default: `cypress` + +Type: `string` + +Test runner to use for end to end (e2e) tests + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +The name of the application. + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. + +### tags + +Type: `string` + +Add tags to the application (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-web/schematics/ng-add.md b/docs/web/api-web/schematics/ng-add.md new file mode 100644 index 0000000000..8e24996651 --- /dev/null +++ b/docs/web/api-web/schematics/ng-add.md @@ -0,0 +1,20 @@ +# ng-add [hidden] + +Add @nrwl/web to a project + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/web/api-workspace/builders/run-commands.md b/docs/web/api-workspace/builders/run-commands.md new file mode 100644 index 0000000000..f8352e9eaf --- /dev/null +++ b/docs/web/api-workspace/builders/run-commands.md @@ -0,0 +1,35 @@ +# run-commands + +Run commands + +## Properties + +### args + +Type: `string` + +Extra arguments. You can pass them as follows: ng run project:target --args='--wait=100'. You can them use {args.wait} syntax to interpolate them in the workspace config file. + +### commands + +Type: `array` of `object` + +#### command + +Type: `string` + +Command to run in child process + +### parallel + +Default: `true` + +Type: `boolean` + +Run commands in parallel + +### readyWhen + +Type: `string` + +String to appear in stdout or stderr that indicates that the task is done. This option can only be used when parallel is set to true. If not specified, the task is done when all the child processes complete. diff --git a/docs/web/api-workspace/npmscripts/affected-apps.md b/docs/web/api-workspace/npmscripts/affected-apps.md new file mode 100644 index 0000000000..974419cbb6 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected-apps.md @@ -0,0 +1,59 @@ +# affected:apps + +Print applications affected by changes + +## Usage + +```bash +affected:apps +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/affected-build.md b/docs/web/api-workspace/npmscripts/affected-build.md new file mode 100644 index 0000000000..ce1fc337a5 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected-build.md @@ -0,0 +1,71 @@ +# affected:build + +Build applications and publishable libraries affected by changes + +## Usage + +```bash +affected:build +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/affected-dep-graph.md b/docs/web/api-workspace/npmscripts/affected-dep-graph.md new file mode 100644 index 0000000000..c93ac3b5a7 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected-dep-graph.md @@ -0,0 +1,63 @@ +# affected:dep-graph + +Graph dependencies affected by changes + +## Usage + +```bash +affected:dep-graph +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### file + +output file (e.g. --file=.vis/output.json) + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/affected-e2e.md b/docs/web/api-workspace/npmscripts/affected-e2e.md new file mode 100644 index 0000000000..c1256e927b --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected-e2e.md @@ -0,0 +1,71 @@ +# affected:e2e + +Run e2e tests for the applications affected by changes + +## Usage + +```bash +affected:e2e +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/affected-libs.md b/docs/web/api-workspace/npmscripts/affected-libs.md new file mode 100644 index 0000000000..4f92a700f5 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected-libs.md @@ -0,0 +1,59 @@ +# affected:libs + +Print libraries affected by changes + +## Usage + +```bash +affected:libs +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/affected-lint.md b/docs/web/api-workspace/npmscripts/affected-lint.md new file mode 100644 index 0000000000..2fd1561ef3 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected-lint.md @@ -0,0 +1,71 @@ +# affected:lint + +Lint projects affected by changes + +## Usage + +```bash +affected:lint +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/affected-test.md b/docs/web/api-workspace/npmscripts/affected-test.md new file mode 100644 index 0000000000..2306af739a --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected-test.md @@ -0,0 +1,71 @@ +# affected:test + +Test projects affected by changes + +## Usage + +```bash +affected:test +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/affected.md b/docs/web/api-workspace/npmscripts/affected.md new file mode 100644 index 0000000000..51d4478ec7 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/affected.md @@ -0,0 +1,75 @@ +# affected + +Run task for affected projects + +## Usage + +```bash +affected +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### maxParallel + +Default: `3` + +Max number of parallel processes + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### parallel + +Default: `false` + +Parallelize the command + +### target + +Task to run for affected projects + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/dep-graph.md b/docs/web/api-workspace/npmscripts/dep-graph.md new file mode 100644 index 0000000000..e8f46de038 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/dep-graph.md @@ -0,0 +1,63 @@ +# dep-graph + +Graph dependencies within workspace + +## Usage + +```bash +dep-graph +``` + + ## Options + +### all + +All projects + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### file + +output file (e.g. --file=.vis/output.json) + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/format-check.md b/docs/web/api-workspace/npmscripts/format-check.md new file mode 100644 index 0000000000..ed6fbc290f --- /dev/null +++ b/docs/web/api-workspace/npmscripts/format-check.md @@ -0,0 +1,61 @@ +# format:check + +Check for un-formatted files + +## Usage + +```bash +format:check +``` + + ## Options + +### all + +All projects + +### apps-and-libs + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/format-write.md b/docs/web/api-workspace/npmscripts/format-write.md new file mode 100644 index 0000000000..d138ab63be --- /dev/null +++ b/docs/web/api-workspace/npmscripts/format-write.md @@ -0,0 +1,61 @@ +# format:write + +Overwrite un-formatted files + +## Usage + +```bash +format:write +``` + + ## Options + +### all + +All projects + +### apps-and-libs + +### base + +Base of the current branch (usually master) + +### exclude + +Default: `` + +Exclude certain projects from being processed + +### files + +A list of files delimited by commas + +### head + +Latest commit of the current branch (usually HEAD) + +### help + +Show help + +### only-failed + +Default: `false` + +Isolate projects which previously failed + +### uncommitted + +Uncommitted changes + +### untracked + +Untracked changes + +### verbose + +Print additional error stack trace on failure + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/workspace-lint-files.md b/docs/web/api-workspace/npmscripts/workspace-lint-files.md new file mode 100644 index 0000000000..79acf1c024 --- /dev/null +++ b/docs/web/api-workspace/npmscripts/workspace-lint-files.md @@ -0,0 +1,19 @@ +# workspace-lint [files..] + +Lint workspace or list of files + +## Usage + +```bash +workspace-lint [files..] +``` + + ## Options + +### help + +Show help + +### version + +Show version number diff --git a/docs/web/api-workspace/npmscripts/workspace-schematic-name.md b/docs/web/api-workspace/npmscripts/workspace-schematic-name.md new file mode 100644 index 0000000000..f3f1cc18ad --- /dev/null +++ b/docs/web/api-workspace/npmscripts/workspace-schematic-name.md @@ -0,0 +1,27 @@ +# workspace-schematic [name] + +Runs a workspace schematic from the tools/schematics directory + +## Usage + +```bash +workspace-schematic [name] +``` + + ## Options + +### help + +Show help + +### list-schematics + +List the available workspace-schematics + +### name + +The name of your schematic` + +### version + +Show version number diff --git a/docs/web/api-workspace/schematics/library.md b/docs/web/api-workspace/schematics/library.md new file mode 100644 index 0000000000..0abf734a18 --- /dev/null +++ b/docs/web/api-workspace/schematics/library.md @@ -0,0 +1,62 @@ +# library + +Create a library + +## Usage + +```bash +nx generate library ... + +``` + +## Options + +### directory + +Type: `string` + +A directory where the app is placed + +### linter + +Default: `tslint` + +Type: `string` + +The tool to use for running lint checks. + +### name + +Type: `string` + +Library name + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files + +### skipTsConfig + +Default: `false` + +Type: `boolean` + +Do not update tsconfig.json for development experience. + +### tags + +Type: `string` + +Add tags to the library (used for linting) + +### unitTestRunner + +Default: `jest` + +Type: `string` + +Test runner to use for unit tests diff --git a/docs/web/api-workspace/schematics/ng-add.md b/docs/web/api-workspace/schematics/ng-add.md new file mode 100644 index 0000000000..b901a32950 --- /dev/null +++ b/docs/web/api-workspace/schematics/ng-add.md @@ -0,0 +1,32 @@ +# ng-add [hidden] + +Convert an existing CLI project into an Nx Workspace + +## Usage + +```bash +nx generate ng-add ... + +``` + +## Options + +### name + +Type: `string` + +Project name. + +### npmScope + +Type: `string` + +Npm scope for importing libs. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing after adding @nrwl/workspace diff --git a/docs/web/api-workspace/schematics/ng-new.md b/docs/web/api-workspace/schematics/ng-new.md new file mode 100644 index 0000000000..f7af293381 --- /dev/null +++ b/docs/web/api-workspace/schematics/ng-new.md @@ -0,0 +1,78 @@ +# ng-new [hidden] + +Create a workspace + +## Usage + +```bash +nx generate ng-new ... + +``` + +## Options + +### appName + +Type: `string` + +Application name. + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. + +### directory + +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. + +### preset + +Default: `empty` + +Type: `string` + +What to create in the new workspace + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/web/api-workspace/schematics/preset.md b/docs/web/api-workspace/schematics/preset.md new file mode 100644 index 0000000000..a4d7a0b51b --- /dev/null +++ b/docs/web/api-workspace/schematics/preset.md @@ -0,0 +1,44 @@ +# preset [hidden] + +Create application in an empty workspace + +## Usage + +```bash +nx generate preset ... + +``` + +## Options + +### cli + +Type: `string` + +CLI powering the workspace. + +### name + +Type: `string` + +The name of the application. + +### npmScope + +Type: `string` + +Npm scope for importing libs. + +### preset + +Type: `string` + +The name of the preset. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/web/api-workspace/schematics/tao-new.md b/docs/web/api-workspace/schematics/tao-new.md new file mode 100644 index 0000000000..f2cd807384 --- /dev/null +++ b/docs/web/api-workspace/schematics/tao-new.md @@ -0,0 +1,78 @@ +# tao-new [hidden] + +Create a workspace + +## Usage + +```bash +nx generate tao-new ... + +``` + +## Options + +### appName + +Type: `string` + +Application name. + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. + +### directory + +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. + +### preset + +Default: `empty` + +Type: `string` + +What to create in the new workspace + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/web/api-workspace/schematics/workspace-schematic.md b/docs/web/api-workspace/schematics/workspace-schematic.md new file mode 100644 index 0000000000..4432eaaf55 --- /dev/null +++ b/docs/web/api-workspace/schematics/workspace-schematic.md @@ -0,0 +1,26 @@ +# workspace-schematic + +Generates a workspace schematic + +## Usage + +```bash +nx generate workspace-schematic ... + +``` + +## Options + +### name + +Type: `string` + +Schematic name + +### skipFormat + +Default: `false` + +Type: `boolean` + +Skip formatting files diff --git a/docs/web/api-workspace/schematics/workspace.md b/docs/web/api-workspace/schematics/workspace.md new file mode 100644 index 0000000000..f557cd1323 --- /dev/null +++ b/docs/web/api-workspace/schematics/workspace.md @@ -0,0 +1,72 @@ +# workspace [hidden] + +Create an empty workspace + +## Usage + +```bash +nx generate workspace ... + +``` + +## Options + +### cli + +Default: `nx` + +Type: `string` + +CLI used for generating code and running tasks + +### commit + +Default: `true` + +Type: `boolean` + +Initial repository commit information. + +### directory + +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. + +### skipGit + +Alias(es): g + +Default: `false` + +Type: `boolean` + +Skip initializing a git repository. + +### skipInstall + +Default: `false` + +Type: `boolean` + +Skip installing dependency packages. + +### style + +Default: `css` + +Type: `string` + +The file extension to be used for style files. diff --git a/docs/web/api/home.md b/docs/web/api/home.md new file mode 100644 index 0000000000..af6fa6164a --- /dev/null +++ b/docs/web/api/home.md @@ -0,0 +1,49 @@ +# API + +Here is the list of all the available packages inside the Nx ecosystem. You +can see, for each package its dependencies. + +| PackageName | Dependencies | PeerDependencies | +| --------------- | --------------------------------------- | ---------------- | +| @nrwl/angular | @nrwl/cypress, @nrwl/jest | @nrwl/workspace | +| @nrwl/cypress | | @nrwl/workspace | +| @nrwl/express | @nrwl/node, @nrwl/jest | @nrwl/workspace | +| @nrwl/jest | | @nrwl/workspace | +| @nrwl/linter | | @nrwl/workspace | +| @nrwl/nest | @nrwl/node, @nrwl/jest | @nrwl/workspace | +| @nrwl/node | @nrwl/jest, @nrwl/linter | @nrwl/workspace | +| @nrwl/react | @nrwl/cypress, @nrwl/jest, @nrwl/web | @nrwl/workspace | +| @nrwl/web | @nrwl/cypress, @nrwl/jest, @nrwl/linter | @nrwl/workspace | +| @nrwl/workspace | @nrwl/cli | | + +## Angular + +![Angular](/assets/content/api/angular.jpg) + +## React + +![React](/assets/content/api/react.jpg) + +## Nest + +![Nest](/assets/content/api/nest.jpg) + +## Express + +![Express](/assets/content/api/express.jpg) + +## Node + +![Node](/assets/content/api/node.jpg) + +## Cypress + +![Cypress](/assets/content/api/cypress.jpg) + +## Jest + +![Jest](/assets/content/api/jest.jpg) + +## Web + +![Web](/assets/content/api/web.jpg) diff --git a/docs/web/builders.json b/docs/web/builders.json new file mode 100644 index 0000000000..4e2c6c1f1a --- /dev/null +++ b/docs/web/builders.json @@ -0,0 +1 @@ +["cypress", "express", "jest", "linter", "nest", "node", "web", "workspace"] diff --git a/docs/web/schematics.json b/docs/web/schematics.json new file mode 100644 index 0000000000..95046b7aa8 --- /dev/null +++ b/docs/web/schematics.json @@ -0,0 +1,11 @@ +[ + "angular", + "cypress", + "express", + "jest", + "nest", + "node", + "react", + "web", + "workspace" +] diff --git a/scripts/documentation/generate-api-home.ts b/scripts/documentation/generate-api-home.ts index a910af72dd..2f35b76a8e 100644 --- a/scripts/documentation/generate-api-home.ts +++ b/scripts/documentation/generate-api-home.ts @@ -3,7 +3,8 @@ import { getPackageConfigurations } from './get-package-configurations'; import { generateFile, getNxPackageDependencies } from './utils'; import { dedent } from 'tslint/lib/utils'; -let template = dedent` +getPackageConfigurations().forEach(({ framework, configs }) => { + let template = dedent` # API Here is the list of all the available packages inside the Nx ecosystem. You @@ -13,7 +14,7 @@ can see, for each package its dependencies. | ----------- | ------------ | ---------------- | `; -const imagesTemplate = dedent` + const imagesTemplate = dedent` ## Angular ![Angular](/assets/content/api/angular.jpg) @@ -39,32 +40,33 @@ const imagesTemplate = dedent` ![Web](/assets/content/api/web.jpg) `; -getPackageConfigurations() - .filter(item => item.hasBuilders || item.hasSchematics) - .map(item => { - const dependencies = getNxPackageDependencies( - path.join(item.root, 'package.json') - ); + configs + .filter(item => item.hasBuilders || item.hasSchematics) + .map(item => { + const dependencies = getNxPackageDependencies( + path.join(item.root, 'package.json') + ); - const data = Object.assign( - {}, - { - hasBuilders: item.hasBuilders, - hasSchematics: item.hasSchematics - }, - dependencies - ); + const data = Object.assign( + {}, + { + hasBuilders: item.hasBuilders, + hasSchematics: item.hasSchematics + }, + dependencies + ); - template += dedent`| ${data.name} | ${data.dependencies.join( - ', ' - )} | ${data.peerDependencies.join(', ')} |\n`; + template += dedent`| ${data.name} | ${data.dependencies.join( + ', ' + )} | ${data.peerDependencies.join(', ')} |\n`; + }); + + // Adding images of dependency graphs + template += imagesTemplate; + + generateFile(path.join(__dirname, '../../docs', framework, 'api'), { + name: 'home', + template }); - -// Adding images of dependency graphs -template += imagesTemplate; - -generateFile(path.join(__dirname, '../../docs', 'api'), { - name: 'home', - template }); console.log('Done generating API Home Documentation'); diff --git a/scripts/documentation/generate-builders-data.ts b/scripts/documentation/generate-builders-data.ts index 26ab3e870e..f1b9dd6252 100644 --- a/scripts/documentation/generate-builders-data.ts +++ b/scripts/documentation/generate-builders-data.ts @@ -101,30 +101,36 @@ function generateTemplate(builder): { name: string; template: string } { } Promise.all( - getPackageConfigurations() - .filter(item => item.hasBuilders) - .map(config => { - Promise.all(generateSchematicList(config, registry)) - .then(builderList => builderList.map(generateTemplate)) - .then(markdownList => - markdownList.forEach(template => - generateFile(config.builderOutput, template) - ) - ) - .then(() => - console.log( - `Generated documentation for ${config.root} to ${config.output}` - ) - ); - }) + getPackageConfigurations().map(({ configs }) => { + return Promise.all( + configs + .filter(item => item.hasBuilders) + .map(config => { + Promise.all(generateSchematicList(config, registry)) + .then(builderList => builderList.map(generateTemplate)) + .then(markdownList => + markdownList.forEach(template => + generateFile(config.builderOutput, template) + ) + ) + .then(() => + console.log( + `Generated documentation for ${config.root} to ${config.output}` + ) + ); + }) + ); + }) ).then(() => { console.log('Done generating Builders Documentation'); }); -const builders = getPackageConfigurations() - .filter(item => item.hasBuilders) - .map(item => item.name); -fs.outputJsonSync( - path.join(__dirname, '../../docs', 'builders.json'), - builders -); +getPackageConfigurations().forEach(({ framework, configs }) => { + const builders = configs + .filter(item => item.hasBuilders) + .map(item => item.name); + fs.outputJsonSync( + path.join(__dirname, '../../docs', framework, 'builders.json'), + builders + ); +}); diff --git a/scripts/documentation/generate-npmscripts-data.ts b/scripts/documentation/generate-npmscripts-data.ts index 73c5cbae1f..a86b7189b7 100644 --- a/scripts/documentation/generate-npmscripts-data.ts +++ b/scripts/documentation/generate-npmscripts-data.ts @@ -7,83 +7,87 @@ import { commandsObject } from '../../packages/workspace'; const importFresh = require('import-fresh'); -const commandsOutputDirectory = path.join( - __dirname, - '../../docs/api-workspace/npmscripts' -); -fs.removeSync(commandsOutputDirectory); -function getCommands(command) { - return command.getCommandInstance().getCommandHandlers(); -} -function parseCommandInstance(name, command) { - const builder = command.builder(importFresh('yargs')().resetOptions()); - const builderDescriptions = builder.getUsageInstance().getDescriptions(); - const builderDefaultOptions = builder.getOptions().default; - return { - command: command['original'], - description: command['description'], - options: - Object.keys(builderDescriptions).map(name => ({ - command: '--'.concat(name), - description: builderDescriptions[name] - ? builderDescriptions[name].replace('__yargsString__:', '') - : '', - default: builderDefaultOptions[name] - })) || null - }; -} -function generateMarkdown(command) { - let template = dedent` - # ${command.command} - ${command.description} - - ## Usage - \`\`\`bash - ${command.command} - \`\`\` - `; +['web', 'angular', 'react'].forEach(framework => { + const commandsOutputDirectory = path.join( + __dirname, + '../../docs/', + framework, + 'api-workspace/npmscripts' + ); + fs.removeSync(commandsOutputDirectory); + function getCommands(command) { + return command.getCommandInstance().getCommandHandlers(); + } + function parseCommandInstance(name, command) { + const builder = command.builder(importFresh('yargs')().resetOptions()); + const builderDescriptions = builder.getUsageInstance().getDescriptions(); + const builderDefaultOptions = builder.getOptions().default; + return { + command: command['original'], + description: command['description'], + options: + Object.keys(builderDescriptions).map(name => ({ + command: '--'.concat(name), + description: builderDescriptions[name] + ? builderDescriptions[name].replace('__yargsString__:', '') + : '', + default: builderDefaultOptions[name] + })) || null + }; + } + function generateMarkdown(command) { + let template = dedent` + # ${command.command} + ${command.description} + + ## Usage + \`\`\`bash + ${command.command} + \`\`\` + `; - if (Array.isArray(command.options) && !!command.options.length) { - template += '## Options'; + if (Array.isArray(command.options) && !!command.options.length) { + template += '## Options'; - command.options - .sort((a, b) => - sortAlphabeticallyFunction( - a.command.replace('--', ''), - b.command.replace('--', '') + command.options + .sort((a, b) => + sortAlphabeticallyFunction( + a.command.replace('--', ''), + b.command.replace('--', '') + ) ) - ) - .forEach( - option => - (template += dedent` - ### ${option.command.replace('--', '')} - ${ - option.default === undefined || option.default === '' - ? '' - : `Default: \`${option.default}\`\n` - } - ${option.description} - `) - ); + .forEach( + option => + (template += dedent` + ### ${option.command.replace('--', '')} + ${ + option.default === undefined || option.default === '' + ? '' + : `Default: \`${option.default}\`\n` + } + ${option.description} + `) + ); + } + + return { + name: command.command + .replace(':', '-') + .replace(' ', '-') + .replace(/[\]\[.]+/gm, ''), + template + }; } - return { - name: command.command - .replace(':', '-') - .replace(' ', '-') - .replace(/[\]\[.]+/gm, ''), - template - }; -} + // TODO: Try to add option's type, examples, and group? + // TODO: split one command per page / Create an index + const npmscripts = getCommands(commandsObject); -// TODO: Try to add option's type, examples, and group? -// TODO: split one command per page / Create an index -const npmscripts = getCommands(commandsObject); - -Object.keys(npmscripts) - .filter(name => !name.startsWith('run') && !name.startsWith('generate')) - .map(name => parseCommandInstance(name, npmscripts[name])) - .map(command => generateMarkdown(command)) - .forEach(templateObject => - generateFile(commandsOutputDirectory, templateObject) - ); + Object.keys(npmscripts) + .filter(name => !name.startsWith('run') && !name.startsWith('generate')) + .map(name => parseCommandInstance(name, npmscripts[name])) + .map(command => generateMarkdown(command)) + .forEach(templateObject => + generateFile(commandsOutputDirectory, templateObject) + ); +}); diff --git a/scripts/documentation/generate-package-dependencies.ts b/scripts/documentation/generate-package-dependencies.ts deleted file mode 100644 index 1e99ec0796..0000000000 --- a/scripts/documentation/generate-package-dependencies.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as fs from 'fs-extra'; -import * as path from 'path'; -import { getPackageConfigurations } from './get-package-configurations'; -import { getNxPackageDependencies } from './utils'; - -getPackageConfigurations() - .filter(item => item.hasBuilders || item.hasSchematics) - .map(config => { - const dependencies = getNxPackageDependencies( - path.join(config.root, 'package.json') - ); - if (dependencies) { - fs.outputJsonSync( - path.join(config.output, 'package-dependencies.json'), - dependencies - ); - console.log(`Dependencies file created at: ${config.output}`); - } - }); diff --git a/scripts/documentation/generate-schematics-data.ts b/scripts/documentation/generate-schematics-data.ts index fd39469415..b46308ad03 100644 --- a/scripts/documentation/generate-schematics-data.ts +++ b/scripts/documentation/generate-schematics-data.ts @@ -55,15 +55,19 @@ function generateSchematicList( }); } -function generateTemplate(schematic): { name: string; template: string } { +function generateTemplate( + framework: string, + schematic +): { name: string; template: string } { + const command = framework === 'angular' ? 'ng' : 'nx'; let template = dedent` # ${schematic.name} ${schematic.hidden ? '[hidden]' : ''} ${schematic.description} ## Usage \`\`\`bash - ng generate ${schematic.name} ... - ${schematic.alias ? `ng g ${schematic.name} ... # Same` : ''} + ${command} generate ${schematic.name} ... + ${schematic.alias ? `${command} g ${schematic.name} ... # Same` : ''} \`\`\` \n`; @@ -101,32 +105,40 @@ function generateTemplate(schematic): { name: string; template: string } { } Promise.all( - getPackageConfigurations() - .filter(item => item.hasSchematics) - .map(config => { - return Promise.all(generateSchematicList(config, registry)) - .then(schematicList => schematicList.map(generateTemplate)) - .then(markdownList => - markdownList.forEach(template => - generateFile(config.schematicOutput, template) - ) - ) - .then(() => { - console.log( - `Documentation from ${config.root} generated to ${ - config.schematicOutput - }` - ); - }); - }) + getPackageConfigurations().map(({ framework, configs }) => { + return Promise.all( + configs + .filter(item => item.hasSchematics) + .map(config => { + return Promise.all(generateSchematicList(config, registry)) + .then(schematicList => + schematicList.map(s => generateTemplate(framework, s)) + ) + .then(markdownList => + markdownList.forEach(template => + generateFile(config.schematicOutput, template) + ) + ) + .then(() => { + console.log( + `Documentation from ${config.root} generated to ${ + config.schematicOutput + }` + ); + }); + }) + ); + }) ).then(() => { console.log('Finished Generating all Documentation'); }); -const schematics = getPackageConfigurations() - .filter(item => item.hasSchematics) - .map(item => item.name); -fs.outputJsonSync( - path.join(__dirname, '../../docs', 'schematics.json'), - schematics -); +getPackageConfigurations().forEach(({ framework, configs }) => { + const schematics = configs + .filter(item => item.hasSchematics) + .map(item => item.name); + fs.outputJsonSync( + path.join(__dirname, '../../docs', framework, 'schematics.json'), + schematics + ); +}); diff --git a/scripts/documentation/get-package-configurations.ts b/scripts/documentation/get-package-configurations.ts index fdaa7aebf2..0672ff4eb8 100644 --- a/scripts/documentation/get-package-configurations.ts +++ b/scripts/documentation/get-package-configurations.ts @@ -21,25 +21,33 @@ export interface Configuration { export function getPackageConfigurations( packagesDirectory: string = 'packages', documentationsDirectory: string = 'docs' -): Configuration[] { - const packagesDir = path.resolve( - path.join(__dirname, '../../', packagesDirectory) - ); - const documentationDir = path.resolve( - path.join(__dirname, '../../', documentationsDirectory) - ); - return shelljs.ls(packagesDir).map(folderName => { - const itemList = shelljs.ls(path.join(packagesDir, folderName)); - const output = path.join(documentationDir, `api-${folderName}`); - return { - name: folderName, - root: path.join(packagesDir, folderName), - source: path.join(packagesDir, `${folderName}/src`), - output, - builderOutput: path.join(output, 'builders'), - schematicOutput: path.join(output, 'schematics'), - hasBuilders: itemList.includes('builders.json'), - hasSchematics: itemList.includes('collection.json') - }; +): { framework: 'web' | 'angular' | 'react'; configs: Configuration[] }[] { + return ['web', 'angular', 'react'].map(framework => { + const packagesDir = path.resolve( + path.join(__dirname, '../../', packagesDirectory) + ); + const documentationDir = path.resolve( + path.join(__dirname, '../../', documentationsDirectory) + ); + const configs = shelljs.ls(packagesDir).map(folderName => { + const itemList = shelljs.ls(path.join(packagesDir, folderName)); + const output = path.join( + documentationDir, + framework, + `api-${folderName}` + ); + return { + name: folderName, + root: path.join(packagesDir, folderName), + source: path.join(packagesDir, `${folderName}/src`), + output, + framework, + builderOutput: path.join(output, 'builders'), + schematicOutput: path.join(output, 'schematics'), + hasBuilders: itemList.includes('builders.json'), + hasSchematics: itemList.includes('collection.json') + }; + }); + return { framework: framework as any, configs }; }); }