From 0ac030b09f06de88c6b3e488214165feb1afce0c Mon Sep 17 00:00:00 2001 From: ben Date: Thu, 12 Sep 2019 10:26:49 -0400 Subject: [PATCH] docs(nx): update affected files description Update the description of the `--files` options for the `affected` command, making it clearer (hopefully). close #1535 --- docs/angular/api-workspace/npmscripts/affected-apps.md | 2 +- docs/angular/api-workspace/npmscripts/affected-build.md | 2 +- docs/angular/api-workspace/npmscripts/affected-dep-graph.md | 2 +- docs/angular/api-workspace/npmscripts/affected-e2e.md | 2 +- docs/angular/api-workspace/npmscripts/affected-libs.md | 2 +- docs/angular/api-workspace/npmscripts/affected-lint.md | 2 +- docs/angular/api-workspace/npmscripts/affected-test.md | 2 +- docs/angular/api-workspace/npmscripts/affected.md | 2 +- docs/angular/api-workspace/npmscripts/dep-graph.md | 2 +- docs/angular/api-workspace/npmscripts/format-check.md | 2 +- docs/angular/api-workspace/npmscripts/format-write.md | 2 +- docs/react/api-workspace/npmscripts/affected-apps.md | 2 +- docs/react/api-workspace/npmscripts/affected-build.md | 2 +- docs/react/api-workspace/npmscripts/affected-dep-graph.md | 2 +- docs/react/api-workspace/npmscripts/affected-e2e.md | 2 +- docs/react/api-workspace/npmscripts/affected-libs.md | 2 +- docs/react/api-workspace/npmscripts/affected-lint.md | 2 +- docs/react/api-workspace/npmscripts/affected-test.md | 2 +- docs/react/api-workspace/npmscripts/affected.md | 2 +- docs/react/api-workspace/npmscripts/dep-graph.md | 2 +- docs/react/api-workspace/npmscripts/format-check.md | 2 +- docs/react/api-workspace/npmscripts/format-write.md | 2 +- docs/web/api-workspace/npmscripts/affected-apps.md | 2 +- docs/web/api-workspace/npmscripts/affected-build.md | 2 +- docs/web/api-workspace/npmscripts/affected-dep-graph.md | 2 +- docs/web/api-workspace/npmscripts/affected-e2e.md | 2 +- docs/web/api-workspace/npmscripts/affected-libs.md | 2 +- docs/web/api-workspace/npmscripts/affected-lint.md | 2 +- docs/web/api-workspace/npmscripts/affected-test.md | 2 +- docs/web/api-workspace/npmscripts/affected.md | 2 +- docs/web/api-workspace/npmscripts/dep-graph.md | 2 +- docs/web/api-workspace/npmscripts/format-check.md | 2 +- docs/web/api-workspace/npmscripts/format-write.md | 2 +- packages/workspace/src/command-line/nx-commands.ts | 3 ++- 34 files changed, 35 insertions(+), 34 deletions(-) diff --git a/docs/angular/api-workspace/npmscripts/affected-apps.md b/docs/angular/api-workspace/npmscripts/affected-apps.md index 80013f5d00..06a0d16946 100644 --- a/docs/angular/api-workspace/npmscripts/affected-apps.md +++ b/docs/angular/api-workspace/npmscripts/affected-apps.md @@ -48,7 +48,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/affected-build.md b/docs/angular/api-workspace/npmscripts/affected-build.md index 8b449c45c6..c5d8cec222 100644 --- a/docs/angular/api-workspace/npmscripts/affected-build.md +++ b/docs/angular/api-workspace/npmscripts/affected-build.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/affected-dep-graph.md b/docs/angular/api-workspace/npmscripts/affected-dep-graph.md index d10f9ba624..027170aa99 100644 --- a/docs/angular/api-workspace/npmscripts/affected-dep-graph.md +++ b/docs/angular/api-workspace/npmscripts/affected-dep-graph.md @@ -64,7 +64,7 @@ output file (e.g. --file=.vis/output.json) ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/affected-e2e.md b/docs/angular/api-workspace/npmscripts/affected-e2e.md index 293c876542..6d5faff2e3 100644 --- a/docs/angular/api-workspace/npmscripts/affected-e2e.md +++ b/docs/angular/api-workspace/npmscripts/affected-e2e.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/affected-libs.md b/docs/angular/api-workspace/npmscripts/affected-libs.md index 1a10608a1c..ed38395689 100644 --- a/docs/angular/api-workspace/npmscripts/affected-libs.md +++ b/docs/angular/api-workspace/npmscripts/affected-libs.md @@ -48,7 +48,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/affected-lint.md b/docs/angular/api-workspace/npmscripts/affected-lint.md index 82e14e8103..51fcfec248 100644 --- a/docs/angular/api-workspace/npmscripts/affected-lint.md +++ b/docs/angular/api-workspace/npmscripts/affected-lint.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/affected-test.md b/docs/angular/api-workspace/npmscripts/affected-test.md index 9cd2c067a3..74a06889cf 100644 --- a/docs/angular/api-workspace/npmscripts/affected-test.md +++ b/docs/angular/api-workspace/npmscripts/affected-test.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/affected.md b/docs/angular/api-workspace/npmscripts/affected.md index 5b19879ba0..c76e14988b 100644 --- a/docs/angular/api-workspace/npmscripts/affected.md +++ b/docs/angular/api-workspace/npmscripts/affected.md @@ -72,7 +72,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/dep-graph.md b/docs/angular/api-workspace/npmscripts/dep-graph.md index 001e8f8abf..86e5cd548f 100644 --- a/docs/angular/api-workspace/npmscripts/dep-graph.md +++ b/docs/angular/api-workspace/npmscripts/dep-graph.md @@ -52,7 +52,7 @@ output file (e.g. --file=.vis/output.json) ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/format-check.md b/docs/angular/api-workspace/npmscripts/format-check.md index 4add210266..10d120feb3 100644 --- a/docs/angular/api-workspace/npmscripts/format-check.md +++ b/docs/angular/api-workspace/npmscripts/format-check.md @@ -30,7 +30,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/angular/api-workspace/npmscripts/format-write.md b/docs/angular/api-workspace/npmscripts/format-write.md index bc4309adab..c35710d75f 100644 --- a/docs/angular/api-workspace/npmscripts/format-write.md +++ b/docs/angular/api-workspace/npmscripts/format-write.md @@ -30,7 +30,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected-apps.md b/docs/react/api-workspace/npmscripts/affected-apps.md index 80013f5d00..06a0d16946 100644 --- a/docs/react/api-workspace/npmscripts/affected-apps.md +++ b/docs/react/api-workspace/npmscripts/affected-apps.md @@ -48,7 +48,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected-build.md b/docs/react/api-workspace/npmscripts/affected-build.md index 8b449c45c6..c5d8cec222 100644 --- a/docs/react/api-workspace/npmscripts/affected-build.md +++ b/docs/react/api-workspace/npmscripts/affected-build.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected-dep-graph.md b/docs/react/api-workspace/npmscripts/affected-dep-graph.md index d10f9ba624..027170aa99 100644 --- a/docs/react/api-workspace/npmscripts/affected-dep-graph.md +++ b/docs/react/api-workspace/npmscripts/affected-dep-graph.md @@ -64,7 +64,7 @@ output file (e.g. --file=.vis/output.json) ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected-e2e.md b/docs/react/api-workspace/npmscripts/affected-e2e.md index 293c876542..6d5faff2e3 100644 --- a/docs/react/api-workspace/npmscripts/affected-e2e.md +++ b/docs/react/api-workspace/npmscripts/affected-e2e.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected-libs.md b/docs/react/api-workspace/npmscripts/affected-libs.md index 1a10608a1c..ed38395689 100644 --- a/docs/react/api-workspace/npmscripts/affected-libs.md +++ b/docs/react/api-workspace/npmscripts/affected-libs.md @@ -48,7 +48,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected-lint.md b/docs/react/api-workspace/npmscripts/affected-lint.md index 82e14e8103..51fcfec248 100644 --- a/docs/react/api-workspace/npmscripts/affected-lint.md +++ b/docs/react/api-workspace/npmscripts/affected-lint.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected-test.md b/docs/react/api-workspace/npmscripts/affected-test.md index 9cd2c067a3..74a06889cf 100644 --- a/docs/react/api-workspace/npmscripts/affected-test.md +++ b/docs/react/api-workspace/npmscripts/affected-test.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/affected.md b/docs/react/api-workspace/npmscripts/affected.md index 5b19879ba0..c76e14988b 100644 --- a/docs/react/api-workspace/npmscripts/affected.md +++ b/docs/react/api-workspace/npmscripts/affected.md @@ -72,7 +72,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/dep-graph.md b/docs/react/api-workspace/npmscripts/dep-graph.md index 001e8f8abf..86e5cd548f 100644 --- a/docs/react/api-workspace/npmscripts/dep-graph.md +++ b/docs/react/api-workspace/npmscripts/dep-graph.md @@ -52,7 +52,7 @@ output file (e.g. --file=.vis/output.json) ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/format-check.md b/docs/react/api-workspace/npmscripts/format-check.md index 4add210266..10d120feb3 100644 --- a/docs/react/api-workspace/npmscripts/format-check.md +++ b/docs/react/api-workspace/npmscripts/format-check.md @@ -30,7 +30,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/react/api-workspace/npmscripts/format-write.md b/docs/react/api-workspace/npmscripts/format-write.md index bc4309adab..c35710d75f 100644 --- a/docs/react/api-workspace/npmscripts/format-write.md +++ b/docs/react/api-workspace/npmscripts/format-write.md @@ -30,7 +30,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected-apps.md b/docs/web/api-workspace/npmscripts/affected-apps.md index 80013f5d00..06a0d16946 100644 --- a/docs/web/api-workspace/npmscripts/affected-apps.md +++ b/docs/web/api-workspace/npmscripts/affected-apps.md @@ -48,7 +48,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected-build.md b/docs/web/api-workspace/npmscripts/affected-build.md index 8b449c45c6..c5d8cec222 100644 --- a/docs/web/api-workspace/npmscripts/affected-build.md +++ b/docs/web/api-workspace/npmscripts/affected-build.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected-dep-graph.md b/docs/web/api-workspace/npmscripts/affected-dep-graph.md index d10f9ba624..027170aa99 100644 --- a/docs/web/api-workspace/npmscripts/affected-dep-graph.md +++ b/docs/web/api-workspace/npmscripts/affected-dep-graph.md @@ -64,7 +64,7 @@ output file (e.g. --file=.vis/output.json) ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected-e2e.md b/docs/web/api-workspace/npmscripts/affected-e2e.md index 293c876542..6d5faff2e3 100644 --- a/docs/web/api-workspace/npmscripts/affected-e2e.md +++ b/docs/web/api-workspace/npmscripts/affected-e2e.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected-libs.md b/docs/web/api-workspace/npmscripts/affected-libs.md index 1a10608a1c..ed38395689 100644 --- a/docs/web/api-workspace/npmscripts/affected-libs.md +++ b/docs/web/api-workspace/npmscripts/affected-libs.md @@ -48,7 +48,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected-lint.md b/docs/web/api-workspace/npmscripts/affected-lint.md index 82e14e8103..51fcfec248 100644 --- a/docs/web/api-workspace/npmscripts/affected-lint.md +++ b/docs/web/api-workspace/npmscripts/affected-lint.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected-test.md b/docs/web/api-workspace/npmscripts/affected-test.md index 9cd2c067a3..74a06889cf 100644 --- a/docs/web/api-workspace/npmscripts/affected-test.md +++ b/docs/web/api-workspace/npmscripts/affected-test.md @@ -66,7 +66,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/affected.md b/docs/web/api-workspace/npmscripts/affected.md index 5b19879ba0..c76e14988b 100644 --- a/docs/web/api-workspace/npmscripts/affected.md +++ b/docs/web/api-workspace/npmscripts/affected.md @@ -72,7 +72,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/dep-graph.md b/docs/web/api-workspace/npmscripts/dep-graph.md index 001e8f8abf..86e5cd548f 100644 --- a/docs/web/api-workspace/npmscripts/dep-graph.md +++ b/docs/web/api-workspace/npmscripts/dep-graph.md @@ -52,7 +52,7 @@ output file (e.g. --file=.vis/output.json) ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/format-check.md b/docs/web/api-workspace/npmscripts/format-check.md index 4add210266..10d120feb3 100644 --- a/docs/web/api-workspace/npmscripts/format-check.md +++ b/docs/web/api-workspace/npmscripts/format-check.md @@ -30,7 +30,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/docs/web/api-workspace/npmscripts/format-write.md b/docs/web/api-workspace/npmscripts/format-write.md index bc4309adab..c35710d75f 100644 --- a/docs/web/api-workspace/npmscripts/format-write.md +++ b/docs/web/api-workspace/npmscripts/format-write.md @@ -30,7 +30,7 @@ Exclude certain projects from being processed ### files -A list of files delimited by commas +Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas ### head diff --git a/packages/workspace/src/command-line/nx-commands.ts b/packages/workspace/src/command-line/nx-commands.ts index 70e6636c67..ce8a47fe42 100644 --- a/packages/workspace/src/command-line/nx-commands.ts +++ b/packages/workspace/src/command-line/nx-commands.ts @@ -206,7 +206,8 @@ function withFormatOptions(yargs: yargs.Argv): yargs.Argv { function withAffectedOptions(yargs: yargs.Argv): yargs.Argv { return yargs .option('files', { - describe: 'A list of files delimited by commas', + describe: + 'Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas', type: 'array', requiresArg: true, coerce: parseCSV