@void0/eslint-config/dist/rules/jest.js

Strict ESlint config for TypeScript projects using Prettier and JS modules.

"use strict";
/* eslint-env commonjs */
/* eslint-disable import/unambiguous */
/* eslint-disable import/no-commonjs */
/* eslint-disable sort-keys */
module.exports = {
    plugins: ['jest'],
    rules: {
        // Enforce consistent test or it keyword
        'jest/consistent-test-it': ['error', { fn: 'test' }],
        // Enforce assertion to be made in a test body
        'jest/expect-expect': 'error',
        // Disallow capitalized test names
        'jest/lowercase-name': 'error',
        // Disallow alias methods
        'jest/no-alias-methods': 'error',
        // Disallow disabled tests
        'jest/no-disabled-tests': 'error',
        // Disallow commented out tests
        'jest/no-commented-out-tests': 'error',
        // Prevent calling expect conditionally
        'jest/no-conditional-expect': 'error',
        // Disallow use of deprecated functions
        'jest/no-deprecated-functions': 'error',
        // Disallow duplicate hooks withing a describe block
        'jest/no-duplicate-hooks': 'error',
        // Prevent exporting from test files
        'jest/no-export': 'error',
        // Disallow focused tests
        'jest/no-focused-tests': 'error',
        // Disallow setup and teardown hooks
        'jest/no-hooks': 'off',
        // Disallow identical titles
        'jest/no-identical-title': 'error',
        // Disallow conditional logic
        'jest/no-if': 'error',
        // Disallow Jasmine globals
        'jest/no-jasmine-globals': 'error',
        // Disallow importing jest
        'jest/no-jest-import': 'error',
        // Disallow manually importing from __mocks__
        'jest/no-mocks-import': 'error',
        // Disallow specific matchers & modifiers
        'jest/no-restricted-matchers': 'error',
        // Prevents expects that are outside of an it or test block.
        'jest/no-standalone-expect': 'error',
        // Disallow large snapshots
        'jest/no-large-snapshots': 'off',
        // Using a callback in asynchronous tests
        'jest/no-test-callback': 'error',
        // Disallow using f & x prefixes to define focused/skipped tests
        'jest/no-test-prefixes': 'error',
        // Disallow explicitly returning from tests
        'jest/no-test-return-statement': 'error',
        // Suggest using expect.assertions() OR expect.hasAssertions()
        'jest/prefer-expect-assertions': 'error',
        // Suggest to have all hooks at top level
        'jest/prefer-hooks-on-top': 'error',
        // Suggest using jest.spyOn()
        'jest/prefer-spy-on': 'error',
        // Suggest using toStrictEqual()
        'jest/prefer-strict-equal': 'error',
        // Suggest using toBeNull()
        'jest/prefer-to-be-null': 'error',
        // Suggest using toBeUndefined()
        'jest/prefer-to-be-undefined': 'error',
        // Suggest using toContain()
        'jest/prefer-to-contain': 'error',
        // Suggest using toHaveLength()
        'jest/prefer-to-have-length': 'error',
        // Enforce valid describe() callback
        'jest/valid-describe': 'error',
        // Enforce having return statement when testing with promises
        'jest/valid-expect-in-promise': 'error',
        // Enforce valid expect() usage
        'jest/valid-expect': 'error',
        // Suggest using test.todo()
        'jest/prefer-todo': 'error',
        // Require a message for toThrow()
        'jest/require-to-throw-message': 'error',
        // Prevents test cases and hooks to be outside of a describe block
        'jest/require-top-level-describe': 'error',
        // Suggest using toBeCalledWith() OR toHaveBeenCalledWith()
        'jest/prefer-called-with': 'error',
        // Enforce valid titles
        'jest/valid-title': 'error',
    },
};
//# sourceMappingURL=jest.js.map