create-jest-runner - GitLite

KO | EN

gitlite — search

#python #react #ai #typescript #go #golang #android #docker #java #awesome #cli #pytorch #mcp #open-source

create-jest-runner

(★ 137)

A highly opinionated way for creating Jest Runners

파일 탐색기

최종 버전 다운로드 (.zip)

- - nodejs.yml
- dependabot.yml
- renovate.json
- settings.json
- - yarn-4.11.0.cjs
- - _package.json
  - _README.md
  - index.js
  - run.js
- config.js
- index.js
- - failing.test.js.snap
  - passing.test.js.snap
  - skipped.test.js.snap
  - slow.test.js.snap
  - todo.test.js.snap
- - index.js
  - run.js
- failing.test.js
- passing.test.js
- runJest.js
- skipped.test.js
- slow.test.js
- todo.test.js
- createJestRunner.ts
- fail.ts
- index.ts
- pass.ts
- skip.ts
- todo.ts
- toTestResult.ts
- types.ts
.dockerignore
.gitignore
.yarnrc
.yarnrc.yml
babel.config.js
CHANGELOG.md
CONTRIBUTING.md
Dockerfile
eslint.config.mjs
jest.config.js
LICENSE
package.json
README.md
tsconfig.json
yarn.lock

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# create-jest-runner

[![Actions Status](https://github.com/jest-community/create-jest-runner/actions/workflows/nodejs.yml/badge.svg?branch=main)](https://github.com/jest-community/create-jest-runner/actions)

A highly opinionated way for creating Jest Runners

## Install

```bash
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

```js
// index.js
const { createJestRunner } = require('create-jest-runner');
module.exports = createJestRunner(require.resolve('./run'));
```

#### createJestRunner(pathToRunFile, config?: { getExtraOptions })

- `pathToRunFile`: path to your run file. This must be an absolute path or a `file://` URL.
- `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 => {};
```

### 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:

- `testResult`: Needs to be an object of type https://github.com/facebook/jest/blob/4d3c1a187bd429fd8611f6b0f19e4aa486fa2a85/packages/jest-test-result/src/types.ts#L103-L135
- `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');
module.exports = createJestRunner(require.resolve('./run'));
```

```js
// 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

```shell
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`

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

Or in `jest.config.js`

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

### Run Jest

```bash
yarn jest
```