Skip to content

Commit

Permalink
feat(nxdev): add types to CLI docs (#9607)
Browse files Browse the repository at this point in the history
  • Loading branch information
meeroslav committed Mar 31, 2022
1 parent 7880de5 commit 15d8222
Show file tree
Hide file tree
Showing 16 changed files with 378 additions and 55 deletions.
32 changes: 29 additions & 3 deletions docs/generated/cli/affected-apps.md
Expand Up @@ -39,37 +39,53 @@ nx affected:apps --base=main~1 --head=main

### 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

Default: ``
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

### ~~only-failed~~

Default: `false`
Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Expand All @@ -81,20 +97,28 @@ Produces a plain output for affected:apps and affected:libs

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Default: `false`
Type: boolean

Default: false

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

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose
Expand All @@ -103,4 +127,6 @@ Print additional error stack trace on failure

### version

Type: boolean

Show version number
50 changes: 45 additions & 5 deletions docs/generated/cli/affected-graph.md
Expand Up @@ -57,84 +57,120 @@ nx affected:graph --exclude=project-one,project-two

### 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

Default: ``
Type: array

Default:

Exclude certain projects from being processed

### file

Type: string

Output file (e.g. --file=output.json or --file=dep-graph.html)

### files

Type: array

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

### focus

Type: string

Use to show the project graph for a particular project and every node that is either an ancestor or a descendant.

### groupByFolder

Type: boolean

Group projects by folder in the project graph

### head

Type: string

Latest commit of the current branch (usually HEAD)

### help

Type: boolean

Show help

### host

Type: string

Bind the project graph server to a specific ip address.

### ~~only-failed~~

Default: `false`
Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Isolate projects which previously failed

### open

Default: `true`
Type: boolean

Default: true

Open the project graph in the browser.

### port

Type: number

Bind the project graph server to a specific port.

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Default: `false`
Type: boolean

Default: false

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

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose
Expand All @@ -143,10 +179,14 @@ Print additional error stack trace on failure

### version

Type: boolean

Show version number

### watch

Default: `false`
Type: boolean

Default: false

Watch for changes to project graph and update in-browser
32 changes: 29 additions & 3 deletions docs/generated/cli/affected-libs.md
Expand Up @@ -39,37 +39,53 @@ nx affected:libs --base=main~1 --head=main

### 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

Default: ``
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

### ~~only-failed~~

Default: `false`
Type: boolean

Default: false

**Deprecated:** The command to rerun failed projects will appear if projects fail. This now does nothing and will be removed in v15.

Expand All @@ -81,20 +97,28 @@ Produces a plain output for affected:apps and affected:libs

### runner

Type: string

This is the name of the tasks runner configured in nx.json

### skip-nx-cache

Default: `false`
Type: boolean

Default: false

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

### uncommitted

Type: boolean

Uncommitted changes

### untracked

Type: boolean

Untracked changes

### verbose
Expand All @@ -103,4 +127,6 @@ Print additional error stack trace on failure

### version

Type: boolean

Show version number

1 comment on commit 15d8222

@vercel
Copy link

@vercel vercel bot commented on 15d8222 Mar 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.