Better explain the syntax and semantics of CLI pattern arguments

avajs · Mar 1, 2022 · 7276f08 · 7276f08
1 parent e13d499
commit 7276f08
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 26 deletions.
diff --git a/docs/05-command-line.md b/docs/05-command-line.md
@@ -12,36 +12,38 @@ Commands:
   ava debug [<pattern>...]  Activate Node.js inspector and run a single test
                             file
   ava reset-cache           Delete any temporary files and state kept by AVA,
-	                          then exit
+                            then exit
 
 Positionals:
   pattern  Select which test files to run. Leave empty if you want AVA to run
            all test files as per your configuration. Accepts glob patterns,
-           directories that (recursively) contain test files, and file paths.
-           Add a colon and specify line numbers of specific tests
-           to run                                                       [string]
+           directories that (recursively) contain test files, and file paths
+           optionally suffixed with a colon and comma-separated numbers and/or
+           ranges identifying the 1-based line(s) of specific tests to run
+                                                                        [string]
+
 Options:
-  --version               Show version number                          [boolean]
-  --color                 Force color output                           [boolean]
-  --config                Specific JavaScript file for AVA to read its config
-                          from, instead of using package.json or ava.config.*
-                          files
-  --help                  Show help                                    [boolean]
-  --concurrency, -c       Max number of test files running at the same time
-                          (default: CPU cores)                          [number]
-  --no-worker-threads     Don't use worker threads                     [boolean]
-  --fail-fast             Stop after first test failure                [boolean]
-  --match, -m             Only run tests with matching title (can be repeated)
+      --version            Show version number                         [boolean]
+      --color              Force color output                          [boolean]
+      --config             Specific JavaScript file for AVA to read its config
+                           from, instead of using package.json or ava.config.*
+                           files
+      --help               Show help                                   [boolean]
+  -c, --concurrency        Max number of test files running at the same time
+                           (default: CPU cores)                         [number]
+      --fail-fast          Stop after first test failure               [boolean]
+  -m, --match              Only run tests with matching title (can be repeated)
                                                                         [string]
-  --node-arguments        Additional Node.js arguments for launching worker
-                          processes (specify as a single string)        [string]
-  --serial, -s            Run tests serially                           [boolean]
-  --tap, -t               Generate TAP output                          [boolean]
-  --timeout, -T           Set global timeout (milliseconds or human-readable,
-                          e.g. 10s, 2m)                                 [string]
-  --update-snapshots, -u  Update snapshots                             [boolean]
-  --verbose, -v           Enable verbose output (default)              [boolean]
-  --watch, -w             Re-run tests when files change               [boolean]
+      --no-worker-threads  Don't use worker threads                    [boolean]
+      --node-arguments     Additional Node.js arguments for launching worker
+                           processes (specify as a single string)       [string]
+  -s, --serial             Run tests serially                          [boolean]
+  -t, --tap                Generate TAP output                         [boolean]
+  -T, --timeout            Set global timeout (milliseconds or human-readable,
+                           e.g. 10s, 2m)                                [string]
+  -u, --update-snapshots   Update snapshots                            [boolean]
+  -v, --verbose            Enable verbose output (default)             [boolean]
+  -w, --watch              Re-run tests when files change              [boolean]
 
 Examples:
   ava

diff --git a/lib/cli.js b/lib/cli.js
@@ -163,7 +163,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 		})
 		.command('* [<pattern>...]', 'Run tests', yargs => yargs.options(FLAGS).positional('pattern', {
 			array: true,
-			describe: 'Select which test files to run. Leave empty if you want AVA to run all test files as per your configuration. Accepts glob patterns, directories that (recursively) contain test files, and file paths. Add a colon and specify line numbers of specific tests to run',
+			describe: 'Select which test files to run. Leave empty if you want AVA to run all test files as per your configuration. Accepts glob patterns, directories that (recursively) contain test files, and file paths optionally suffixed with a colon and comma-separated numbers and/or ranges identifying the 1-based line(s) of specific tests to run',
 			type: 'string',
 		}), argv => {
 			if (activeInspector) {
@@ -190,7 +190,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 				},
 			}).positional('pattern', {
 				demand: true,
-				describe: 'Glob patterns to select a single test file to debug. Add a colon and specify line numbers of specific tests to run',
+				describe: 'Glob pattern to select a single test file to debug, optionally suffixed with a colon and comma-separated numbers and/or ranges identifying the 1-based line(s) of specific tests to run',
 				type: 'string',
 			}),
 			argv => {