nx/docs/generated/cli/affected.md
2022-10-28 10:54:05 -04:00

2.4 KiB

title description
affected - CLI command Run target for affected projects

affected

Run target for affected projects

Usage

nx affected

Install nx globally to invoke the command directly using nx, or use npx nx, yarn nx, or pnpm nx.

Examples

Run custom target for all affected projects:

 nx affected --target=custom-target```
Run tests in parallel:
```bash
 nx affected --target=test --parallel=5```
Run the test target for all projects:
```bash
 nx affected --target=test --all```
Run tests for all the projects affected by changing the index.ts file:
```bash
 nx affected --target=test --files=libs/mylib/src/index.ts```
Run tests for all the projects affected by the changes between main and HEAD (e.g., PR):
```bash
 nx affected --target=test --base=main --head=HEAD```
Run tests for all the projects affected by the last commit on main:
```bash
 nx affected --target=test --base=main~1 --head=main```

## Options

### all

Type: `boolean`

All projects
### base

Type: `string`

Base of the current branch (usually main)
### configuration

Type: `string`

This is the configuration to use when performing tasks on projects
### exclude

Type: `array`

Default: `[]`

Exclude certain projects from being processed
### files

Type: `array`

Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
### head

Type: `string`

Latest commit of the current branch (usually HEAD)
### help

Type: `boolean`

Show help
### nx-bail

Type: `boolean`

Default: `false`

Stop command execution after the first failed task
### nx-ignore-cycles

Type: `boolean`

Default: `false`

Ignore cycles in the task graph
### output-style

Type: `string`

Choices: [dynamic, static, stream, stream-without-prefixes]

Defines how Nx emits outputs tasks logs
### parallel

Type: `string`

Max number of parallel processes [default is 3]
### runner

Type: `string`

This is the name of the tasks runner configured in nx.json
### skip-nx-cache

Type: `boolean`

Default: `false`

Rerun the tasks even when the results are available in the cache
### target

Type: `string`

Task to run for affected projects
### uncommitted

Type: `boolean`

Uncommitted changes
### untracked

Type: `boolean`

Untracked changes
### verbose

Type: `boolean`

Default: `false`

Prints additional information about the commands (e.g., stack traces)
### version

Type: `boolean`

Show version number