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

docs(core): add better docs for run-script

Browse Source
This commit is contained in:
Victor Savkin 2021-09-16 15:46:15 -04:00
parent c71d286ef5
commit a5ba9bc0c3
224 changed files with 613 additions and 451 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/angular/api-angular/executors/delegate-build.md
View File

@ -2,7 +2,7 @@
Delegates the build to a different target while supporting incremental builds.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-angular/executors/ng-packagr-lite.md
View File

@ -2,7 +2,7 @@
Builds a library with support for incremental builds.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-angular/executors/package.md
View File

@ -2,7 +2,7 @@
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-angular/executors/webpack-browser.md
View File

@ -2,7 +2,7 @@
Builds a browser application with support for incremental builds and custom webpack configuration.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-angular/executors/webpack-server.md
View File

@ -2,7 +2,7 @@
Serves a browser application with support for a custom webpack configuration.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-cypress/executors/cypress.md
View File

@ -2,7 +2,7 @@
Run Cypress e2e tests
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-detox/executors/build.md
View File

@ -2,7 +2,7 @@
Run the command defined in build property of the specified configuration.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-detox/executors/test.md
View File

@ -2,7 +2,7 @@
Initiating your detox test suite.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-gatsby/executors/build.md
View File

@ -2,7 +2,7 @@
Build a Gatsby app
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-gatsby/executors/server.md
View File

@ -2,7 +2,7 @@
Starts server for app
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-jest/executors/jest.md
View File

@ -2,7 +2,7 @@
Run Jest unit tests
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-linter/executors/eslint.md
View File

@ -2,7 +2,7 @@
Run ESLint on a project
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-linter/executors/lint.md
View File

@ -2,7 +2,7 @@
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-next/executors/build.md
View File

@ -2,7 +2,7 @@
Build a Next.js app
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-next/executors/export.md
View File

@ -2,7 +2,7 @@
Export a Next.js app. The exported application is located at dist/$outputPath/exported.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-next/executors/server.md
View File

@ -2,7 +2,7 @@
Serve a Next.js app
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-node/executors/build.md
View File

@ -2,7 +2,7 @@
Build a Node application
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-node/executors/execute.md
View File

@ -2,7 +2,7 @@
Execute a Node application
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-node/executors/package.md
View File

@ -2,7 +2,7 @@
Package a Node library
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-nx-plugin/executors/e2e.md
View File

@ -2,7 +2,7 @@
Creates and runs the e2e tests for an Nx Plugin.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-react-native/executors/build-android.md
View File

@ -2,7 +2,7 @@
Release Build for Android.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-react-native/executors/bundle.md
View File

@ -2,7 +2,7 @@
Builds the JS bundle.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-react-native/executors/ensure-symlink.md
View File

@ -2,4 +2,4 @@
Ensure workspace node_modules is symlink under app's node_modules folder.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.

2
docs/angular/api-react-native/executors/run-android.md
View File

@ -2,7 +2,7 @@
Runs Android application.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-react-native/executors/run-ios.md
View File

@ -2,7 +2,7 @@
Runs iOS application.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-react-native/executors/start.md
View File

@ -2,7 +2,7 @@
Starts the dev server for JS bundle.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-react-native/executors/sync-deps.md
View File

@ -2,7 +2,7 @@
Syncs dependencies to package.json (required for autolinking).
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-storybook/executors/build.md
View File

@ -2,7 +2,7 @@
Build Storybook
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-storybook/executors/storybook.md
View File

@ -2,7 +2,7 @@
Serve Storybook
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-web/executors/build.md
View File

@ -2,7 +2,7 @@
Build a application
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-web/executors/dev-server.md
View File

@ -2,7 +2,7 @@
Serve a web application
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-web/executors/file-server.md
View File

@ -2,7 +2,7 @@
Serve a web application from a folder
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

2
docs/angular/api-web/executors/package.md
View File

@ -2,7 +2,7 @@
Package a library
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

22
docs/angular/api-workspace/executors/run-commands.md
View File

@ -2,7 +2,7 @@
Run any custom commands with Nx
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Examples
@ -11,10 +11,10 @@ Options can be configured in `angular.json` when defining the executor, or when
```json
//...
"frontend": {
"architect": {
"targets": {
//...
"ls-project-root": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "ls apps/frontend/src"
}
@ -39,7 +39,7 @@ You can run them sequentially by setting `parallel: false`:
```json
"create-script": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"commands": [
"mkdir -p scripts",
@ -78,7 +78,7 @@ nx run frontend:webpack --args="--config=example.config.js"
```json
"webpack": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "webpack"
}
@ -92,7 +92,7 @@ that sets the `forwardAllArgs` option to `false` as shown below:
```json
"webpack": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"commands": [
{
@ -110,7 +110,7 @@ Normally, `run-commands` considers the commands done when all of them have finis
```json
"finish-when-ready": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"commands": [
"sleep 5 && echo 'FINISHED'",
@ -141,10 +141,10 @@ nx affected --target=generate-docs
```json
//...
"frontend": {
"architect": {
"targets": {
//...
"generate-docs": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "npx compodoc -p apps/frontend/tsconfig.app.json"
}
@ -152,10 +152,10 @@ nx affected --target=generate-docs
}
},
"api": {
"architect": {
"targets": {
//...
"generate-docs": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "npx compodoc -p apps/api/tsconfig.app.json"
}

47
docs/angular/api-workspace/executors/run-script.md
View File

@ -2,7 +2,50 @@
Run an npm script using Nx
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Examples
`workspace.json`:
```json
"frontend": {
"root": "packages/frontend",
"targets": {
"build": {
"executor": "@nrwl/workspace:run-script",
"options": {
"script": "build-my-project"
}
}
}
}
```
```bash
nx run frontend:build
```
The `build` target is going to run `npm run build-my-project` (or `yarn build-my-project`) in the `packages/frontend` directory.
#### Caching Artifacts
By default, Nx is going to cache `dist/packages/frontend`, `packages/frontend/dist`, `packages/frontend/build`, `packages/frontend/public`. If your npm script writes files to other places, you can override the list of cached outputs as follows:
```json
"frontend": {
"root": "packages/frontend",
"targets": {
"build": {
"executor": "@nrwl/workspace:run-script",
"outputs": ["packages/frontend/dist", "packaged/frontend/docs"],
"options": {
"script": "build-my-project"
}
}
}
}
```
## Options
@ -10,4 +53,4 @@ Options can be configured in `angular.json` when defining the executor, or when
Type: `string`
Script to run in child process
An npm script name in the package.json file of the project (e.g., build)

2
docs/angular/api-workspace/executors/tsc.md
View File

@ -2,7 +2,7 @@
Build a project using TypeScript.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
Options can be configured in `angular.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

4
docs/angular/cli/print-affected.md
View File

@ -1,6 +1,6 @@
# print-affected
Graph execution plan
Prints information about the projects and targets affected by changes
## Usage
@ -86,6 +86,8 @@ This is the name of the tasks runner configured in nx.json
### select
Select the subset of the returned json document (e.g., --selected=projects)
### skip-nx-cache
Default: `false`

3
docs/node/api-angular/executors/delegate-build.md
View File

@ -2,8 +2,7 @@
Delegates the build to a different target while supporting incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-angular/executors/ng-packagr-lite.md
View File

@ -2,8 +2,7 @@
Builds a library with support for incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-angular/executors/package.md
View File

@ -2,8 +2,7 @@
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-angular/executors/webpack-browser.md
View File

@ -2,8 +2,7 @@
Builds a browser application with support for incremental builds and custom webpack configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-angular/executors/webpack-server.md
View File

@ -2,8 +2,7 @@
Serves a browser application with support for a custom webpack configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-cypress/executors/cypress.md
View File

@ -2,8 +2,7 @@
Run Cypress e2e tests
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-detox/executors/build.md
View File

@ -2,8 +2,7 @@
Run the command defined in build property of the specified configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-detox/executors/test.md
View File

@ -2,8 +2,7 @@
Initiating your detox test suite.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-gatsby/executors/build.md
View File

@ -2,8 +2,7 @@
Build a Gatsby app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-gatsby/executors/server.md
View File

@ -2,8 +2,7 @@
Starts server for app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-jest/executors/jest.md
View File

@ -2,8 +2,7 @@
Run Jest unit tests
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-linter/executors/eslint.md
View File

@ -2,8 +2,7 @@
Run ESLint on a project
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-linter/executors/lint.md
View File

@ -2,8 +2,7 @@
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-next/executors/build.md
View File

@ -2,8 +2,7 @@
Build a Next.js app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-next/executors/export.md
View File

@ -2,8 +2,7 @@
Export a Next.js app. The exported application is located at dist/$outputPath/exported.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-next/executors/server.md
View File

@ -2,8 +2,7 @@
Serve a Next.js app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-node/executors/build.md
View File

@ -2,8 +2,7 @@
Build a Node application
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-node/executors/execute.md
View File

@ -2,8 +2,7 @@
Execute a Node application
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-node/executors/package.md
View File

@ -2,8 +2,7 @@
Package a Node library
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-nx-plugin/executors/e2e.md
View File

@ -2,8 +2,7 @@
Creates and runs the e2e tests for an Nx Plugin.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-react-native/executors/build-android.md
View File

@ -2,8 +2,7 @@
Release Build for Android.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-react-native/executors/bundle.md
View File

@ -2,8 +2,7 @@
Builds the JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-react-native/executors/ensure-symlink.md
View File

@ -2,5 +2,4 @@
Ensure workspace node_modules is symlink under app's node_modules folder.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.

3
docs/node/api-react-native/executors/run-android.md
View File

@ -2,8 +2,7 @@
Runs Android application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-react-native/executors/run-ios.md
View File

@ -2,8 +2,7 @@
Runs iOS application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-react-native/executors/start.md
View File

@ -2,8 +2,7 @@
Starts the dev server for JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-react-native/executors/sync-deps.md
View File

@ -2,8 +2,7 @@
Syncs dependencies to package.json (required for autolinking).
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-storybook/executors/build.md
View File

@ -2,8 +2,7 @@
Build Storybook
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-storybook/executors/storybook.md
View File

@ -2,8 +2,7 @@
Serve Storybook
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-web/executors/build.md
View File

@ -2,8 +2,7 @@
Build a application
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-web/executors/dev-server.md
View File

@ -2,8 +2,7 @@
Serve a web application
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-web/executors/file-server.md
View File

@ -2,8 +2,7 @@
Serve a web application from a folder
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/node/api-web/executors/package.md
View File

@ -2,8 +2,7 @@
Package a library
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

23
docs/node/api-workspace/executors/run-commands.md
View File

@ -2,8 +2,7 @@
Run any custom commands with Nx
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Examples
@ -12,10 +11,10 @@ Read more about how to use executors and the CLI here: https://nx.dev/getting-st
```json
//...
"frontend": {
"architect": {
"targets": {
//...
"ls-project-root": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "ls apps/frontend/src"
}
@ -40,7 +39,7 @@ You can run them sequentially by setting `parallel: false`:
```json
"create-script": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"commands": [
"mkdir -p scripts",
@ -79,7 +78,7 @@ nx run frontend:webpack --args="--config=example.config.js"
```json
"webpack": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "webpack"
}
@ -93,7 +92,7 @@ that sets the `forwardAllArgs` option to `false` as shown below:
```json
"webpack": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"commands": [
{
@ -111,7 +110,7 @@ Normally, `run-commands` considers the commands done when all of them have finis
```json
"finish-when-ready": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"commands": [
"sleep 5 && echo 'FINISHED'",
@ -142,10 +141,10 @@ nx affected --target=generate-docs
```json
//...
"frontend": {
"architect": {
"targets": {
//...
"generate-docs": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "npx compodoc -p apps/frontend/tsconfig.app.json"
}
@ -153,10 +152,10 @@ nx affected --target=generate-docs
}
},
"api": {
"architect": {
"targets": {
//...
"generate-docs": {
"builder": "@nrwl/workspace:run-commands",
"executor": "@nrwl/workspace:run-commands",
"options": {
"command": "npx compodoc -p apps/api/tsconfig.app.json"
}

48
docs/node/api-workspace/executors/run-script.md
View File

@ -2,8 +2,50 @@
Run an npm script using Nx
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Examples
`workspace.json`:
```json
"frontend": {
"root": "packages/frontend",
"targets": {
"build": {
"executor": "@nrwl/workspace:run-script",
"options": {
"script": "build-my-project"
}
}
}
}
```
```bash
nx run frontend:build
```
The `build` target is going to run `npm run build-my-project` (or `yarn build-my-project`) in the `packages/frontend` directory.
#### Caching Artifacts
By default, Nx is going to cache `dist/packages/frontend`, `packages/frontend/dist`, `packages/frontend/build`, `packages/frontend/public`. If your npm script writes files to other places, you can override the list of cached outputs as follows:
```json
"frontend": {
"root": "packages/frontend",
"targets": {
"build": {
"executor": "@nrwl/workspace:run-script",
"outputs": ["packages/frontend/dist", "packaged/frontend/docs"],
"options": {
"script": "build-my-project"
}
}
}
}
```
## Options
@ -11,4 +53,4 @@ Read more about how to use executors and the CLI here: https://nx.dev/getting-st
Type: `string`
Script to run in child process
An npm script name in the package.json file of the project (e.g., build)

3
docs/node/api-workspace/executors/tsc.md
View File

@ -2,8 +2,7 @@
Build a project using TypeScript.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

4
docs/node/cli/print-affected.md
View File

@ -1,6 +1,6 @@
# print-affected
Graph execution plan
Prints information about the projects and targets affected by changes
## Usage
@ -86,6 +86,8 @@ This is the name of the tasks runner configured in nx.json
### select
Select the subset of the returned json document (e.g., --selected=projects)
### skip-nx-cache
Default: `false`

3
docs/react/api-angular/executors/delegate-build.md
View File

@ -2,8 +2,7 @@
Delegates the build to a different target while supporting incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-angular/executors/ng-packagr-lite.md
View File

@ -2,8 +2,7 @@
Builds a library with support for incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-angular/executors/package.md
View File

@ -2,8 +2,7 @@
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-angular/executors/webpack-browser.md
View File

@ -2,8 +2,7 @@
Builds a browser application with support for incremental builds and custom webpack configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-angular/executors/webpack-server.md
View File

@ -2,8 +2,7 @@
Serves a browser application with support for a custom webpack configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-cypress/executors/cypress.md
View File

@ -2,8 +2,7 @@
Run Cypress e2e tests
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-detox/executors/build.md
View File

@ -2,8 +2,7 @@
Run the command defined in build property of the specified configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-detox/executors/test.md
View File

@ -2,8 +2,7 @@
Initiating your detox test suite.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-gatsby/executors/build.md
View File

@ -2,8 +2,7 @@
Build a Gatsby app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-gatsby/executors/server.md
View File

@ -2,8 +2,7 @@
Starts server for app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-jest/executors/jest.md
View File

@ -2,8 +2,7 @@
Run Jest unit tests
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-linter/executors/eslint.md
View File

@ -2,8 +2,7 @@
Run ESLint on a project
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-linter/executors/lint.md
View File

@ -2,8 +2,7 @@
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-next/executors/build.md
View File

@ -2,8 +2,7 @@
Build a Next.js app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-next/executors/export.md
View File

@ -2,8 +2,7 @@
Export a Next.js app. The exported application is located at dist/$outputPath/exported.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-next/executors/server.md
View File

@ -2,8 +2,7 @@
Serve a Next.js app
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-node/executors/build.md
View File

@ -2,8 +2,7 @@
Build a Node application
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-node/executors/execute.md
View File

@ -2,8 +2,7 @@
Execute a Node application
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-node/executors/package.md
View File

@ -2,8 +2,7 @@
Package a Node library
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-nx-plugin/executors/e2e.md
View File

@ -2,8 +2,7 @@
Creates and runs the e2e tests for an Nx Plugin.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-react-native/executors/build-android.md
View File

@ -2,8 +2,7 @@
Release Build for Android.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-react-native/executors/bundle.md
View File

@ -2,8 +2,7 @@
Builds the JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-react-native/executors/ensure-symlink.md
View File

@ -2,5 +2,4 @@
Ensure workspace node_modules is symlink under app's node_modules folder.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.

3
docs/react/api-react-native/executors/run-android.md
View File

@ -2,8 +2,7 @@
Runs Android application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-react-native/executors/run-ios.md
View File

@ -2,8 +2,7 @@
Runs iOS application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

3
docs/react/api-react-native/executors/start.md
View File

@ -2,8 +2,7 @@
Starts the dev server for JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
Options can be configured in `workspace.json` when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/core-concepts/configuration#targets.
## Options

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