ABQ with Jest

Jest is released as many small packages. ABQ requires a few of them to be overridden using features of your package manager. We rely on overrides instead of releasing an omnibus package to maximize your ability to work with other packages in the Jest ecosystem.

How you override packages will depend on your project's package manager. We'll assume your project has already configured a supported version of the official Jest packages.

Using NPM

Add the following overrides to your package.json:

"overrides": {
  "@jest/core": "npm:@rwx-research/[email protected]",
  "jest-circus": "npm:@rwx-research/[email protected]",
  "jest-config": "npm:@rwx-research/[email protected]",
  "jest-runner": "npm:@rwx-research/[email protected]"
}

Run npm install, and your project is prepared. Continue on to setting up CI.

If you are using a different version of Jest, be sure to adjust the overrides as appropriate. For example, if you are using Jest 29.4.3, the corresponding @jest/core override would be npm:@rwx-research/[email protected].

Using Yarn

Add the following resolutions to your package.json:

"resolutions": {
  "@jest/core": "npm:@rwx-research/[email protected]",
  "jest-circus": "npm:@rwx-research/[email protected]",
  "jest-config": "npm:@rwx-research/[email protected]",
  "jest-runner": "npm:@rwx-research/[email protected]"
}

Run yarn install, and your project is prepared. Continue on to setting up CI.

If you are using a different version of Jest, be sure to adjust the resolutions as appropriate. For example, if you are using Jest 29.4.3, the corresponding @jest/core resolution would be npm:@rwx-research/[email protected].

Using pnpm

Add the following overrides to the pnpm key in your package.json:

"pnpm: {
  "overrides": {
    "@jest/core": "npm:@rwx-research/jest-core@29.5.3",
    "jest-circus": "npm:@rwx-research/jest-circus@29.5.3",
    "jest-config": "npm:@rwx-research/jest-config@29.5.3",
    "jest-runner": "npm:@rwx-research/jest-runner@29.5.3"
  }
}

Run pnpm install, and your project is prepared. Continue on to setting up CI.

If you are using a different version of Jest, be sure to adjust the overrides as appropriate. For example, if you are using Jest 29.4.3, the corresponding @jest/core override would be npm:@rwx-research/[email protected].