Skip to content

Commit

Permalink
fix(nx): npm scripts documentation generation
Browse files Browse the repository at this point in the history
Before, a single instance of yargs was accumulating options, so commands parsed later would have options from prior commands. That's because all yargs options are global by default. Now, a new instance of yargs is required before each command is parsed, so global options aren't accumulated.

fixes nrwl#1567
  • Loading branch information
BuckyMaler committed Jul 7, 2019
1 parent 4297aef commit 84a9576
Show file tree
Hide file tree
Showing 19 changed files with 24 additions and 420 deletions.
14 changes: 0 additions & 14 deletions docs/api-workspace/npmscripts/affected-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,12 @@ Latest commit of the current branch (usually HEAD)

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
2 changes: 0 additions & 2 deletions docs/api-workspace/npmscripts/affected-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
14 changes: 0 additions & 14 deletions docs/api-workspace/npmscripts/affected-dep-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,12 @@ Latest commit of the current branch (usually HEAD)

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
14 changes: 0 additions & 14 deletions docs/api-workspace/npmscripts/affected-e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,12 @@ Latest commit of the current branch (usually HEAD)

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
14 changes: 0 additions & 14 deletions docs/api-workspace/npmscripts/affected-libs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,12 @@ Latest commit of the current branch (usually HEAD)

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
6 changes: 0 additions & 6 deletions docs/api-workspace/npmscripts/affected-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@ Default: ``

Exclude certain projects from being processed

### file

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

### files

A list of files delimited by commas
Expand Down Expand Up @@ -58,8 +54,6 @@ Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
2 changes: 0 additions & 2 deletions docs/api-workspace/npmscripts/affected-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
2 changes: 0 additions & 2 deletions docs/api-workspace/npmscripts/affected.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
14 changes: 0 additions & 14 deletions docs/api-workspace/npmscripts/dep-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,12 @@ Latest commit of the current branch (usually HEAD)

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
18 changes: 0 additions & 18 deletions docs/api-workspace/npmscripts/format-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ Default: ``

Exclude certain projects from being processed

### file

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

### files

A list of files delimited by commas
Expand All @@ -42,26 +38,12 @@ Latest commit of the current branch (usually HEAD)

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
18 changes: 0 additions & 18 deletions docs/api-workspace/npmscripts/format-write.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ Default: ``

Exclude certain projects from being processed

### file

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

### files

A list of files delimited by commas
Expand All @@ -42,26 +38,12 @@ Latest commit of the current branch (usually HEAD)

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes
Expand Down
60 changes: 0 additions & 60 deletions docs/api-workspace/npmscripts/lint-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,70 +10,10 @@ lint [files..]

## Options

### all

All projects

### apps-and-libs

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

A list of files delimited by commas

### head

Latest commit of the current branch (usually HEAD)

### help

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes

### untracked

Untracked changes

### verbose

Print additional error stack trace on failure

### version

Show version number
60 changes: 0 additions & 60 deletions docs/api-workspace/npmscripts/update-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,70 +10,10 @@ update:check

## Options

### all

All projects

### apps-and-libs

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

A list of files delimited by commas

### head

Latest commit of the current branch (usually HEAD)

### help

Show help

### maxParallel

Default: `3`

Max number of parallel processes

### only-failed

Default: `false`

Isolate projects which previously failed

### parallel

Default: `false`

Parallelize the command

### quiet

### uncommitted

Uncommitted changes

### untracked

Untracked changes

### verbose

Print additional error stack trace on failure

### version

Show version number
Loading

0 comments on commit 84a9576

Please sign in to comment.