@fe-boilerplate/eslint-config/src/rules/jest.js

eslint configuration for projects.

const { filePatterns } = require('../configs/file-patterns')

module.exports = {
  env: {
    es6: true,
    node: true,
  },
  overrides: [
    {
      // @see https://github.com/jest-community/eslint-plugin-jest
      extends: ['plugin:jest/recommended'],
      // Perf: To ensure best performance enable eslint-plugin-jest for test files only.
      files: filePatterns.test,
      rules: {
        // No standalone expect is relaxed for test files
        'jest/no-standalone-expect': 'off',
        'jest/consistent-test-it': ['error', { fn: 'it' }],
        'jest/no-commented-out-tests': 'error',
        'jest/no-conditional-in-test': 'error',
        'jest/no-duplicate-hooks': 'error',
        // Enable Jest rules
        'jest/no-focused-tests': 'error',
        'jest/no-test-return-statement': 'error',
        'jest/prefer-hooks-in-order': 'error',
        'jest/prefer-hooks-on-top': 'error',
        'jest/prefer-mock-promise-shorthand': 'error',
        'jest/prefer-strict-equal': 'error',
        'jest/prefer-to-have-length': 'error',
        'jest/unbound-method': 'error',
        'jest/prefer-to-be': 'error',
        'jest/prefer-to-contain': 'error',
        'jest/no-restricted-matchers': [
          'error',
          {
            toBeFalsy: null,
            toBeTruthy: null,
            /*
            resolves: 'Use `expect(await promise)` instead.',
            toHaveBeenCalledWith: null,
            'not.toHaveBeenCalledWith': null,
            'resolves.toHaveBeenCalledWith': null,
            'rejects.toHaveBeenCalledWith': null,
            'resolves.not.toHaveBeenCalledWith': null,
            'rejects.not.toHaveBeenCalledWith': null,
             */
          },
        ],
      },
    },
  ],
  settings: {
    // To prevent autodetection issues in monorepos or via vitest
    jest: {
      version: 'latest',
    },
  },
}