framework/js-packages/jest-config/README.md

Jest config for Flarum

This package provides a Jest config object to run unit & integration tests on Flarum extensions.

Usage

• Install the package: yarn add --dev @flarum/jest-config
• Add "type": "module" to your package.json
• Add "test": "yarn node --experimental-vm-modules $(yarn bin jest)" to your package.json scripts
• Rename webpack.config.js to webpack.config.cjs
• Create a jest.config.cjs file with the following content:

module.exports = require('@flarum/jest-config')();

• If you are using TypeScript, create tsconfig.test.json with the following content:

{
  "extends": "./tsconfig.json",
  "include": ["tests/**/*"],
  "files": ["../../../node_modules/@flarum/jest-config/shims.d.ts"]
}