Add getExtraOptions to entry file (#12)

* Add getExtraOptions

* Update changelog

Author: rogeliog

CHANGELOG.md

@@ -1,28 +1,41 @@
 ## master
 
+### Features
+
+* Add `getExtraOptions` to entry file ([#12](https://github.com/rogeliog/create-jest-runner/pull/12))
+
+### Breaking changes
+
+* Drop Node 4 ([#4](https://github.com/rogeliog/create-jest-runner/pull/4))
+
 ## 0.3.1
 
 ### Fixes
+
 * Use a mutex when running in band as well ([#7](https://github.com/rogeliog/create-jest-runner/pull/7))
 * Use import/export ([#8](https://github.com/rogeliog/create-jest-runner/pull/8))
 * Removing un-needed packages ([#1](https://github.com/rogeliog/create-jest-runner/pull/1))
 
 ## 0.3.0
 
 ### Fixes
+
 * Mutex the workers, to behave more like native jest test runs ([#5](https://github.com/rogeliog/create-jest-runner/pull/5))
 
 ### Features
+
 * Support serial execution ([#6](https://github.com/rogeliog/create-jest-runner/pull/6))
 
 ## O.2.0
 
 ### Features
+
 * Add skip functionality
 
 ## O.1.1
 
 ### Fixes
+
 * TTY support for jest-worker
 
 ## 0.1.0

README.md

@@ -14,8 +14,8 @@ yarn add create-jest-runner
 
 create-jest-runner takes care of handling the appropriate parallelization and creating a worker farm for your runner.
 
-
 You simply need two files:
+
 * Entry file: Used by Jest as an entrypoint to your runner.
 * Run file: Runs once per test file, and it encapsulates the logic of your runner
 
@@ -27,34 +27,39 @@ const { createJestRunner } = require('create-jest-runner');
 module.exports = createJestRunner(require.resolve('./run'));
 ```
 
+#### createJestRunner(pathToRunFile, config?: { getExtraOptions })
+
+* `pathToRunFile`: path to your run file.
+* `config`: Optional argument for configuring the runner.
+  * `getExtraOptions`: `() => object` used for passing extra options to the runner. It needs to be a serializable object because it will be send to a different Node process.
+
 ### 2) Create your run file
 
 ```js
-module.exports = (options) => {
-};
+module.exports = options => {};
 ```
 
 ### Run File API
 
 This file should export a function that receives one parameter with the options
 
 #### `options: { testPath, config, globalConfig }`
-  - `testPath`: Path of the file that is going to be tests
-  - `config`: Jest Project config used by this file
-  - `globalConfig`: Jest global config
 
-You can return one of the following values:
-- `testResult`: Needs to be an object of type https://github.com/facebook/jest/blob/master/types/TestResult.js#L137-L165
-- `Promise<testResult|Error>`: needs to be of above type.
-- `Error`: good for reporting system error, not failed tests.
+* `testPath`: Path of the file that is going to be tests
+* `config`: Jest Project config used by this file
+* `globalConfig`: Jest global config
+* `extraOptions`: The return value of the `{ getExtraOptions }` argument of `createJestRunner(...)` the entry file.
 
+You can return one of the following values:
 
+* `testResult`: Needs to be an object of type https://github.com/facebook/jest/blob/master/types/TestResult.js#L137-L165
+* `Promise<testResult|Error>`: needs to be of above type.
+* `Error`: good for reporting system error, not failed tests.
 
 ## Example of a runner
 
 This runner "blade-runner" makes sure that these two emojis `⚔️ 🏃` are present in every file
 
-
 ```js
 // index.js
 const { createJestRunner } = require('create-jest-runner');
@@ -83,12 +88,12 @@ module.exports = ({ testPath }) => {
 };
 ```
 
-
 ## Add your runner to Jest config
 
 Once you have your Jest runner you can add it to your Jest config.
 
 In your `package.json`
+
 ```json
 {
   "jest": {
@@ -98,13 +103,15 @@ In your `package.json`
 ```
 
 Or in `jest.config.js`
+
 ```js
 module.exports = {
   runner: '/path/to/my-runner',
-}
+};
 ```
 
 ### Run Jest
+
 ```bash
 yarn jest
 ```

lib/createJestRunner.js

@@ -8,7 +8,7 @@ class CancelRun extends Error {
   }
 }
 
-const createRunner = runPath => {
+const createRunner = (runPath, { getExtraOptions } = {}) => {
   class BaseTestRunner {
     constructor(globalConfig) {
       this._globalConfig = globalConfig;
@@ -63,6 +63,7 @@ const createRunner = runPath => {
                       ? test.context.moduleMap.getRawModuleMap()
                       : null,
                     options,
+                    extraOptions: getExtraOptions ? getExtraOptions() : {},
                   };
 
                   if (typeof runner.default === 'function') {
@@ -110,6 +111,7 @@ const createRunner = runPath => {
                 ? test.context.moduleMap.getRawModuleMap()
                 : null,
               options,
+              extraOptions: getExtraOptions ? getExtraOptions() : {},
             };
 
             return worker.default(baseOptions);