updated docs regarding testSequencer (#9174)

jestjs · May 3, 2020 · 4216b86 · 4216b86
1 parent 2e8f8d5
commit 4216b86
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -1085,6 +1085,7 @@ Example:
 Sort test path alphabetically.
 
 ```js
+// testSequencer.js
 const Sequencer = require('@jest/test-sequencer').default;
 
 class CustomSequencer extends Sequencer {
@@ -1099,6 +1100,14 @@ class CustomSequencer extends Sequencer {
 module.exports = CustomSequencer;
 ```
 
+Use it in your Jest config file like this:
+
+```json
+{
+  "testSequencer": "path/to/testSequencer.js"
+}
+```
+
 ### `testTimeout` [number]
 
 Default: `5000`

diff --git a/website/versioned_docs/version-24.x/Configuration.md b/website/versioned_docs/version-24.x/Configuration.md
@@ -1064,6 +1064,7 @@ Example:
 Sort test path alphabetically.
 
 ```js
+// testSequencer.js
 const Sequencer = require('@jest/test-sequencer').default;
 
 class CustomSequencer extends Sequencer {
@@ -1078,6 +1079,14 @@ class CustomSequencer extends Sequencer {
 module.exports = CustomSequencer;
 ```
 
+Use it in your Jest config file like this:
+
+```json
+{
+  "testSequencer": "path/to/testSequencer.js"
+}
+```
+
 ### `testURL` [string]
 
 Default: `http://localhost`

diff --git a/website/versioned_docs/version-25.5/Configuration.md b/website/versioned_docs/version-25.5/Configuration.md
@@ -1086,6 +1086,7 @@ Example:
 Sort test path alphabetically.
 
 ```js
+// testSequencer.js
 const Sequencer = require('@jest/test-sequencer').default;
 
 class CustomSequencer extends Sequencer {
@@ -1100,6 +1101,14 @@ class CustomSequencer extends Sequencer {
 module.exports = CustomSequencer;
 ```
 
+Use it in your Jest config file like this:
+
+```json
+{
+  "testSequencer": "path/to/testSequencer.js"
+}
+```
+
 ### `testTimeout` [number]
 
 Default: `5000`