8435bdfb6f
* chore(core): fix some broken tests * docs(core): update docs to represent master -> main * chore(core): review changes Co-authored-by: Jason Jean <jasonjean1993@gmail.com> * chore(core): add migration script for backwards-compat w/ main default. Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
146 lines
2.9 KiB
Markdown
146 lines
2.9 KiB
Markdown
# affected:dep-graph
|
|
|
|
Graph dependencies affected by changes
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
nx affected:dep-graph
|
|
```
|
|
|
|
[Install `nx` globally]({{framework}}/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.
|
|
|
|
### Examples
|
|
|
|
Open the dep graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:
|
|
|
|
```bash
|
|
nx affected:dep-graph --files=libs/mylib/src/index.ts
|
|
```
|
|
|
|
Open the dep graph of the workspace in the browser, and highlight the projects affected by the changes between main and HEAD (e.g., PR):
|
|
|
|
```bash
|
|
nx affected:dep-graph --base=main --head=HEAD
|
|
```
|
|
|
|
Save the dep graph of the workspace in a json file, and highlight the projects affected by the changes between main and HEAD (e.g., PR):
|
|
|
|
```bash
|
|
nx affected:dep-graph --base=main --head=HEAD --file=output.json
|
|
```
|
|
|
|
Generate a static website with dep graph data in an html file, highlighting the projects affected by the changes between main and HEAD (e.g., PR):
|
|
|
|
```bash
|
|
nx affected:dep-graph --base=main --head=HEAD --file=output.html
|
|
```
|
|
|
|
Open the dep graph of the workspace in the browser, and highlight the projects affected by the last commit on main:
|
|
|
|
```bash
|
|
nx affected:dep-graph --base=main~1 --head=main
|
|
```
|
|
|
|
Open the dep graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two:
|
|
|
|
```bash
|
|
nx affected:dep-graph --exclude=project-one,project-two
|
|
```
|
|
|
|
## Options
|
|
|
|
### all
|
|
|
|
All projects
|
|
|
|
### base
|
|
|
|
Base of the current branch (usually main)
|
|
|
|
### configuration
|
|
|
|
This is the configuration to use when performing tasks on projects
|
|
|
|
### exclude
|
|
|
|
Default: ``
|
|
|
|
Exclude certain projects from being processed
|
|
|
|
### file
|
|
|
|
Output file (e.g. --file=output.json or --file=dep-graph.html)
|
|
|
|
### files
|
|
|
|
Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas
|
|
|
|
### focus
|
|
|
|
Use to show the dependency graph for a particular project and every node that is either an ancestor or a descendant.
|
|
|
|
### groupByFolder
|
|
|
|
Group projects by folder in the dependency graph
|
|
|
|
### head
|
|
|
|
Latest commit of the current branch (usually HEAD)
|
|
|
|
### help
|
|
|
|
Show help
|
|
|
|
### host
|
|
|
|
Bind the dependency graph server to a specific ip address.
|
|
|
|
### only-failed
|
|
|
|
Default: `false`
|
|
|
|
Isolate projects which previously failed
|
|
|
|
### open
|
|
|
|
Default: `true`
|
|
|
|
Open the dependency graph in the browser.
|
|
|
|
### port
|
|
|
|
Bind the dependecy graph server to a specific port.
|
|
|
|
### runner
|
|
|
|
This is the name of the tasks runner configured in nx.json
|
|
|
|
### skip-nx-cache
|
|
|
|
Default: `false`
|
|
|
|
Rerun the tasks even when the results are available in the cache
|
|
|
|
### uncommitted
|
|
|
|
Uncommitted changes
|
|
|
|
### untracked
|
|
|
|
Untracked changes
|
|
|
|
### verbose
|
|
|
|
Print additional error stack trace on failure
|
|
|
|
### version
|
|
|
|
Show version number
|
|
|
|
### watch
|
|
|
|
Default: `false`
|
|
|
|
Watch for changes to dependency graph and update in-browser
|