No Packages Misplaced

    create-jest-runner
    TypeScript icon, indicating that this package has built-in type declarations

    0.12.2 • Public • Published

    create-jest-runner

    Actions Status

    A highly opinionated way for creating Jest Runners

    Install

    yarn add create-jest-runner

    Usage

    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

    1) Create your entry file

    // index.js
    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

    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
    • extraOptions: The return value of the { getExtraOptions } argument of createJestRunner(...) the entry file.

    You can return one of the following values:

    Example of a runner

    This runner "blade-runner" makes sure that these two emojis ⚔️ 🏃 are present in every file

    // index.js
    const { createJestRunner } = require('create-jest-runner');
    module.exports = createJestRunner(require.resolve('./run'));
    // run.js
    const fs = require('fs');
    const { pass, fail } = require('create-jest-runner');
    
    /** @type {import('create-jest-runner').RunTest} */
    const runTest = ({ testPath }) => {
      const start = Date.now();
      const contents = fs.readFileSync(testPath, 'utf8');
      const end = Date.now();
    
      if (contents.includes('⚔️🏃')) {
        return pass({ start, end, test: { path: testPath } });
      }
      const errorMessage = 'Company policies require ⚔️ 🏃 in every file';
      return fail({
        start,
        end,
        test: { path: testPath, errorMessage, title: 'Check for ⚔️ 🏃' },
      });
    };
    
    module.exports = runTest;

    Create runner from binary

    yarn create jest-runner my-runner
    
    # Or with npm
    npm init jest-runner my-runner

    Note: You will have to update the package name in package.json of the generated runner.

    Add your runner to Jest config

    Once you have your Jest runner you can add it to your Jest config.

    In your package.json

    {
      "jest": {
        "runner": "/path/to/my-runner"
      }
    }

    Or in jest.config.js

    module.exports = {
      runner: '/path/to/my-runner',
    };

    Run Jest

    yarn jest

    Keywords

    none

    Install

    npm i create-jest-runner

    DownloadsWeekly Downloads

    156,011

    Version

    0.12.2

    License

    MIT

    Unpacked Size

    25 kB

    Total Files

    25

    Last publish

    Collaborators

    • simenb
    • rickhanlonii
    • thymikee
    • jsonp
    • orta
    • rogeliog
    • mattphillips
    • jeysal