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

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

View File

@ -2,7 +2,7 @@
Delegates the build to a different target while supporting incremental builds. 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 ## Options

View File

@ -2,7 +2,7 @@
Builds a library with support for incremental builds. 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 ## Options

View File

@ -2,7 +2,7 @@
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds. 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 ## Options

View File

@ -2,7 +2,7 @@
Builds a browser application with support for incremental builds and custom webpack configuration. 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 ## Options

View File

@ -2,7 +2,7 @@
Serves a browser application with support for a custom webpack configuration. 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 ## Options

View File

@ -2,7 +2,7 @@
Run Cypress e2e tests 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 ## Options

View File

@ -2,7 +2,7 @@
Run the command defined in build property of the specified configuration. 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 ## Options

View File

@ -2,7 +2,7 @@
Initiating your detox test suite. 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 ## Options

View File

@ -2,7 +2,7 @@
Build a Gatsby app 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 ## Options

View File

@ -2,7 +2,7 @@
Starts server for app 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 ## Options

View File

@ -2,7 +2,7 @@
Run Jest unit tests 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 ## Options

View File

@ -2,7 +2,7 @@
Run ESLint on a project 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 ## Options

View File

@ -2,7 +2,7 @@
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0 **[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 ## Options

View File

@ -2,7 +2,7 @@
Build a Next.js app 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 ## Options

View File

@ -2,7 +2,7 @@
Export a Next.js app. The exported application is located at dist/$outputPath/exported. 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 ## Options

View File

@ -2,7 +2,7 @@
Serve a Next.js app 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 ## Options

View File

@ -2,7 +2,7 @@
Build a Node application 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 ## Options

View File

@ -2,7 +2,7 @@
Execute a Node application 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 ## Options

View File

@ -2,7 +2,7 @@
Package a Node library 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 ## Options

View File

@ -2,7 +2,7 @@
Creates and runs the e2e tests for an Nx Plugin. 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 ## Options

View File

@ -2,7 +2,7 @@
Release Build for Android. 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 ## Options

View File

@ -2,7 +2,7 @@
Builds the JS bundle. 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 ## Options

View File

@ -2,4 +2,4 @@
Ensure workspace node_modules is symlink under app's node_modules folder. 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.

View File

@ -2,7 +2,7 @@
Runs Android application. 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 ## Options

View File

@ -2,7 +2,7 @@
Runs iOS application. 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 ## Options

View File

@ -2,7 +2,7 @@
Starts the dev server for JS bundle. 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 ## Options

View File

@ -2,7 +2,7 @@
Syncs dependencies to package.json (required for autolinking). 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 ## Options

View File

@ -2,7 +2,7 @@
Build Storybook 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 ## Options

View File

@ -2,7 +2,7 @@
Serve Storybook 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 ## Options

View File

@ -2,7 +2,7 @@
Build a application 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 ## Options

View File

@ -2,7 +2,7 @@
Serve a web application 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 ## Options

View File

@ -2,7 +2,7 @@
Serve a web application from a folder 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 ## Options

View File

@ -2,7 +2,7 @@
Package a library 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 ## Options

View File

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

View File

@ -2,7 +2,50 @@
Run an npm script using Nx 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 ## Options
@ -10,4 +53,4 @@ Options can be configured in `angular.json` when defining the executor, or when
Type: `string` Type: `string`
Script to run in child process An npm script name in the package.json file of the project (e.g., build)

View File

@ -2,7 +2,7 @@
Build a project using TypeScript. 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 ## Options

View File

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

View File

@ -2,8 +2,7 @@
Delegates the build to a different target while supporting incremental builds. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

@ -2,8 +2,7 @@
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

@ -2,8 +2,7 @@
Builds a browser application with support for incremental builds and custom webpack configuration. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

@ -2,8 +2,7 @@
Serves a browser application with support for a custom webpack configuration. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

@ -2,8 +2,7 @@
Run the command defined in build property of the specified configuration. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -2,8 +2,7 @@
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0 **[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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

@ -2,8 +2,7 @@
Export a Next.js app. The exported application is located at dist/$outputPath/exported. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

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

View File

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

View File

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

View File

@ -2,8 +2,7 @@
Creates and runs the e2e tests for an Nx Plugin. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

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

View File

@ -2,5 +2,4 @@
Ensure workspace node_modules is symlink under app's node_modules folder. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -2,8 +2,50 @@
Run an npm script using Nx Run an npm script using Nx
Options can be configured in `workspace.json` when defining the executor, or when invoking it. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## 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 ## Options
@ -11,4 +53,4 @@ Read more about how to use executors and the CLI here: https://nx.dev/getting-st
Type: `string` Type: `string`
Script to run in child process An npm script name in the package.json file of the project (e.g., build)

View File

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

View File

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

View File

@ -2,8 +2,7 @@
Delegates the build to a different target while supporting incremental builds. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

@ -2,8 +2,7 @@
Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

@ -2,8 +2,7 @@
Builds a browser application with support for incremental builds and custom webpack configuration. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

@ -2,8 +2,7 @@
Serves a browser application with support for a custom webpack configuration. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

@ -2,8 +2,7 @@
Run the command defined in build property of the specified configuration. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -2,8 +2,7 @@
**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0 **[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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

@ -2,8 +2,7 @@
Export a Next.js app. The exported application is located at dist/$outputPath/exported. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

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

View File

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

View File

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

View File

@ -2,8 +2,7 @@
Creates and runs the e2e tests for an Nx Plugin. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options ## Options

View File

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

View File

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

View File

@ -2,5 +2,4 @@
Ensure workspace node_modules is symlink under app's node_modules folder. 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. 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.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.

View File

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

View File

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

View File

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

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