ben 0ac030b09f docs(nx): update affected files description

Update the description of the `--files` options for the `affected`
command, making it clearer (hopefully).

close #1535

2019-09-17 08:51:32 -04:00

1.9 KiB

Raw Blame History

affected:dep-graph

Graph dependencies affected by changes

Usage

nx affected:dep-graph

Install @nrwl/cli globally to invoke the command directly using nx, or use npm run nx or yarn nx.

Examples

Open the dep graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file:

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 master and HEAD (e.g., PR):

nx affected:dep-graph --base=master --head=HEAD

Save the dep graph of the workspace in a json file, and highlight the projects affected by the changes between master and HEAD (e.g., PR):

nx affected:dep-graph --base=master --head=HEAD --file=output.json

Save the dep graph of the workspace in a html file, and highlight the projects affected by the changes between master and HEAD (e.g., PR):

nx affected:dep-graph --base=master --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 master:

nx affected:dep-graph --base=master~1 --head=master

Options

all

All projects

base

Base of the current branch (usually master)

exclude

Default: ``

Exclude certain projects from being processed

file

output file (e.g. --file=.vis/output.json)

files

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

head

Latest commit of the current branch (usually HEAD)

help

Show help

only-failed

Default: false

Isolate projects which previously failed

uncommitted

Uncommitted changes

untracked

Untracked changes

verbose

Print additional error stack trace on failure

version

Show version number

1.9 KiB Raw Blame History