document --runTestsByPath CLI parameter (#7046)

* document --runTestsByPath CLI parameter

* update changelog

* update versioned docs

CHANGELOG.md

@@ -22,6 +22,7 @@
 
 ### Chore & Maintenance
 
+- `[docs]` Document `--runTestsByPath` CLI parameter ([#7046](https://github.com/facebook/jest/pull/7046))
 - `[docs]` Fix babel-core installation instructions ([#6745](https://github.com/facebook/jest/pull/6745))
 - `[docs]` Explain how to rewrite assertions to avoid large irrelevant diff ([#6971](https://github.com/facebook/jest/pull/6971))
 - `[examples]` add example using Babel 7 ([#6983](https://github.com/facebook/jest/pull/6983))

docs/CLI.md

@@ -227,6 +227,12 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-22.0/CLI.md

@@ -190,6 +190,12 @@ Run tests from one or more projects.
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-22.2/CLI.md

@@ -192,6 +192,12 @@ Run tests from one or more projects.
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-22.3/CLI.md

@@ -192,6 +192,12 @@ Run tests from one or more projects.
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-22.4/CLI.md

@@ -210,6 +210,12 @@ Run tests from one or more projects.
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-23.0/CLI.md

@@ -214,6 +214,12 @@ Run tests from one or more projects.
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-23.1/CLI.md

@@ -218,6 +218,12 @@ Run tests from one or more projects.
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-23.2/CLI.md

@@ -222,6 +222,12 @@ Run tests from one or more projects.
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-23.3/CLI.md

@@ -228,6 +228,12 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-23.5/CLI.md

@@ -228,6 +228,12 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.

website/versioned_docs/version-23.6/CLI.md

@@ -228,6 +228,12 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
 
+### `--runTestsByPath`
+
+Run only the tests that were specified with their exact paths.
+
+_Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files_
+
 ### `--setupTestFrameworkScriptFile=<file>`
 
 The path to a module that runs some code to configure or set up the testing framework before each test. Beware that files imported by the setup script will not be mocked during testing.