Skip to content

Commit

Permalink
fix: only use overrides for jest config (#128)
Browse files Browse the repository at this point in the history
  • Loading branch information
@MichaelDeBoey
MichaelDeBoey committed Jan 7, 2022
1 parent 14dd4b5 commit f28506e
Showing 1 changed file with 95 additions and 110 deletions.
205 changes: 95 additions & 110 deletions jest.js
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
const readPkgUp = require('read-pkg-up')

const disableRules = deprecatedRules =>
deprecatedRules.reduce(
(allRules, rule) => ({
...allRules,
[rule]: 'off',
}),
{},
)

let hasJestDom = false
let hasTestingLibrary = false

Expand All @@ -31,101 +22,6 @@ try {
// ignore error
}

const rules = {
'react/display-name': 'off', // we don't need a display name in test files

'jest/consistent-test-it': 'off',
'jest/expect-expect': 'off',
'jest/max-nested-describe': 'error',
'jest/no-alias-methods': 'off',
'jest/no-commented-out-tests': 'warn',
'jest/no-conditional-expect': 'error',
'jest/no-deprecated-functions': 'error',
'jest/no-disabled-tests': 'warn',
'jest/no-done-callback': 'error',
'jest/no-duplicate-hooks': 'off',
'jest/no-export': 'error',
'jest/no-focused-tests': 'error',
'jest/no-hooks': 'off',
'jest/no-identical-title': 'error',
'jest/no-if': 'error',
'jest/no-interpolation-in-snapshots': 'error',
'jest/no-jasmine-globals': 'off',
'jest/no-jest-import': 'error',
'jest/no-large-snapshots': ['warn', {maxSize: 300}],
'jest/no-mocks-import': 'error',
'jest/no-restricted-matchers': 'off',
'jest/no-standalone-expect': 'off',
'jest/no-test-prefixes': 'error',
'jest/no-test-return-statement': 'off',
'jest/prefer-called-with': 'error',
'jest/prefer-expect-assertions': 'off',
'jest/prefer-expect-resolves': 'off',
'jest/prefer-hooks-on-top': 'error',
'jest/prefer-lowercase-title': 'off',
'jest/prefer-spy-on': 'off',
'jest/prefer-strict-equal': 'off',
'jest/prefer-to-be': 'off',
'jest/prefer-to-contain': 'warn',
'jest/prefer-to-have-length': 'warn',
'jest/prefer-todo': 'warn',
'jest/require-hook': 'off',
'jest/require-to-throw-message': 'off',
'jest/require-top-level-describe': 'off',
'jest/unbound-method': 'off',
'jest/valid-describe-callback': 'error',
'jest/valid-expect': 'error',
'jest/valid-expect-in-promise': 'error',
'jest/valid-title': 'warn',

...(hasJestDom
? {
'jest-dom/prefer-checked': 'error',
'jest-dom/prefer-empty': 'error',
'jest-dom/prefer-enabled-disabled': 'error',
'jest-dom/prefer-focus': 'error',
'jest-dom/prefer-in-document': 'error',
'jest-dom/prefer-required': 'error',
'jest-dom/prefer-to-have-attribute': 'error',
'jest-dom/prefer-to-have-class': 'error',
'jest-dom/prefer-to-have-style': 'error',
'jest-dom/prefer-to-have-text-content': 'error',
'jest-dom/prefer-to-have-value': 'error',
}
: null),

...(hasTestingLibrary
? {
'testing-library/await-async-query': 'error',
'testing-library/await-async-utils': 'error',
'testing-library/await-fire-event': 'off',
'testing-library/consistent-data-testid': 'off',
'testing-library/no-await-sync-events': 'error',
'testing-library/no-await-sync-query': 'error',
'testing-library/no-container': 'error',
'testing-library/no-debugging-utils': 'error',
'testing-library/no-dom-import': ['error', 'react'],
'testing-library/no-manual-cleanup': 'error',
'testing-library/no-node-access': 'error',
'testing-library/no-promise-in-fire-event': 'error',
'testing-library/no-render-in-setup': 'error',
'testing-library/no-unnecessary-act': 'error',
'testing-library/no-wait-for-empty-callback': 'error',
'testing-library/no-wait-for-multiple-assertions': 'error',
'testing-library/no-wait-for-side-effects': 'error',
'testing-library/no-wait-for-snapshot': 'error',
'testing-library/prefer-explicit-assert': 'warn',
'testing-library/prefer-find-by': 'error',
'testing-library/prefer-presence-queries': 'error',
'testing-library/prefer-query-by-disappearance': 'error',
'testing-library/prefer-screen-queries': 'error',
'testing-library/prefer-user-event': 'error',
'testing-library/prefer-wait-for': 'error',
'testing-library/render-result-naming-convention': 'error',
}
: null),
}

module.exports = {
env: {
'jest/globals': true,
Expand All @@ -135,18 +31,107 @@ module.exports = {
hasJestDom ? 'jest-dom' : null,
hasTestingLibrary ? 'testing-library' : null,
].filter(Boolean),
rules: {
// Workaround until `eslint-find-rules` supports 'overrides'
// See https://github.com/sarbbottam/eslint-find-rules/issues/317
...disableRules(Object.keys(rules)),
},
rules: {},
overrides: [
{
files: [
'**/__tests__/**/*.+(js|ts)?(x)',
'**/*.{spec,test}.+(js|ts)?(x)',
],
rules,
rules: {
'react/display-name': 'off', // we don't need a display name in test files

'jest/consistent-test-it': 'off',
'jest/expect-expect': 'off',
'jest/max-nested-describe': 'error',
'jest/no-alias-methods': 'off',
'jest/no-commented-out-tests': 'warn',
'jest/no-conditional-expect': 'error',
'jest/no-deprecated-functions': 'error',
'jest/no-disabled-tests': 'warn',
'jest/no-done-callback': 'error',
'jest/no-duplicate-hooks': 'off',
'jest/no-export': 'error',
'jest/no-focused-tests': 'error',
'jest/no-hooks': 'off',
'jest/no-identical-title': 'error',
'jest/no-if': 'error',
'jest/no-interpolation-in-snapshots': 'error',
'jest/no-jasmine-globals': 'off',
'jest/no-jest-import': 'error',
'jest/no-large-snapshots': ['warn', {maxSize: 300}],
'jest/no-mocks-import': 'error',
'jest/no-restricted-matchers': 'off',
'jest/no-standalone-expect': 'off',
'jest/no-test-prefixes': 'error',
'jest/no-test-return-statement': 'off',
'jest/prefer-called-with': 'error',
'jest/prefer-expect-assertions': 'off',
'jest/prefer-expect-resolves': 'off',
'jest/prefer-hooks-on-top': 'error',
'jest/prefer-lowercase-title': 'off',
'jest/prefer-spy-on': 'off',
'jest/prefer-strict-equal': 'off',
'jest/prefer-to-be': 'off',
'jest/prefer-to-contain': 'warn',
'jest/prefer-to-have-length': 'warn',
'jest/prefer-todo': 'warn',
'jest/require-hook': 'off',
'jest/require-to-throw-message': 'off',
'jest/require-top-level-describe': 'off',
'jest/unbound-method': 'off',
'jest/valid-describe-callback': 'error',
'jest/valid-expect': 'error',
'jest/valid-expect-in-promise': 'error',
'jest/valid-title': 'warn',

...(hasJestDom
? {
'jest-dom/prefer-checked': 'error',
'jest-dom/prefer-empty': 'error',
'jest-dom/prefer-enabled-disabled': 'error',
'jest-dom/prefer-focus': 'error',
'jest-dom/prefer-in-document': 'error',
'jest-dom/prefer-required': 'error',
'jest-dom/prefer-to-have-attribute': 'error',
'jest-dom/prefer-to-have-class': 'error',
'jest-dom/prefer-to-have-style': 'error',
'jest-dom/prefer-to-have-text-content': 'error',
'jest-dom/prefer-to-have-value': 'error',
}
: null),

...(hasTestingLibrary
? {
'testing-library/await-async-query': 'error',
'testing-library/await-async-utils': 'error',
'testing-library/await-fire-event': 'off',
'testing-library/consistent-data-testid': 'off',
'testing-library/no-await-sync-events': 'error',
'testing-library/no-await-sync-query': 'error',
'testing-library/no-container': 'error',
'testing-library/no-debugging-utils': 'error',
'testing-library/no-dom-import': ['error', 'react'],
'testing-library/no-manual-cleanup': 'error',
'testing-library/no-node-access': 'error',
'testing-library/no-promise-in-fire-event': 'error',
'testing-library/no-render-in-setup': 'error',
'testing-library/no-unnecessary-act': 'error',
'testing-library/no-wait-for-empty-callback': 'error',
'testing-library/no-wait-for-multiple-assertions': 'error',
'testing-library/no-wait-for-side-effects': 'error',
'testing-library/no-wait-for-snapshot': 'error',
'testing-library/prefer-explicit-assert': 'warn',
'testing-library/prefer-find-by': 'error',
'testing-library/prefer-presence-queries': 'error',
'testing-library/prefer-query-by-disappearance': 'error',
'testing-library/prefer-screen-queries': 'error',
'testing-library/prefer-user-event': 'error',
'testing-library/prefer-wait-for': 'error',
'testing-library/render-result-naming-convention': 'error',
}
: null),
},
},
{
files: ['**/__tests__/**/*.ts?(x)', '**/*.{spec,test}.ts?(x)'],
Expand Down

0 comments on commit f28506e

Please sign in to comment.