Migration Guide

Migration between minor versions follows the same steps:

Update @perfective/eslint-config-react and its peer dependencies.
Disable all new rules.
Gradually enable the new rules:
- remove one or more rules from the list;
- fix errors or check auto-fixes of warnings;
- check for the regressions.

From `v0.13.0` to `v0.14.0`

Replace customized eslint-plugin-node rules (if any) with eslint-plugin-n:
- Replace customized node/ rules with n/.
- Replace node/shebang rule with n/hashbang.
- Disable n/no-hide-core-modules as deprecated.
- Change n/exports-style severity to warn.
Update customizations (if any) for the deprecated @typescript-eslint rules:
- Replace @typescript-eslint/no-throw-literal with @typescript-eslint/only-throw-error.
- Replace @typescript-eslint/no-useless-template-literals with @typescript-eslint/no-unnecessary-template-expression.
- Disabled deprecated @typescript-eslint/prefer-ts-expect-error.
Add @jest/globals to the devDependencies for the jest/prefer-importing-jest-globals rule.

Disable and gradually enable new rules in the .eslintrc.js.

module.exports = {
    extends: [
        '@perfective/eslint-config',
    ],
    overrides: [
        {
            files: ['*.[jt]s?(x)'],
            rules: {
                '@stylistic/js/line-comment-position': 'off',
                '@stylistic/js/multiline-comment-style': 'off', // Auto-fixable
                '@stylistic/jsx/jsx-function-call-newline': 'off', // Auto-fixable
                '@typescript-eslint/consistent-return': 'off',
                '@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
                'cypress/no-async-before': 'off',
                'jest/prefer-importing-jest-globals': 'off', // Auto-fixable
                'jest/prefer-jest-mocked': 'off', // Auto-fixable
                'unicorn/consistent-empty-array-spread': 'off', // Auto-fixable
                'unicorn/no-anonymous-default-export': 'off',
                'unicorn/no-await-in-promise-methods': 'off',
                'unicorn/no-invalid-fetch-options': 'off',
                'unicorn/no-magic-array-flat-depth': 'off',
                'unicorn/no-single-promise-in-promise-methods': 'off', // Auto-fixable
            },
        },
    ],
};

From `v0.12.3` to `v0.13.0`

Check customizations of the eslint and @typescript-eslint rules replaced by the ESLint Stylistic rules. Replace the name of the customized rules with the new rules. See Stylistic migration documentation for details.

Disable and gradually enable new rules in the .eslintrc.js.

module.exports = {
    extends: [
        '@perfective/eslint-config-react',
    ],
    overrides: [
        {
            files: ['*.[jt]s?(x)'],
            rules: {
                '@typescript-eslint/no-array-delete': 'off',
                '@typescript-eslint/prefer-find': 'off',
                '@typescript-eslint/prefer-promise-reject-errors': 'off',
                'react/checked-requires-onchange-or-readonly': 'off',
            },
        },
    ],
};

From `v0.11.0` to `v0.12.3`

Disable and gradually enable new rules in the .eslintrc.js.

module.exports = {
    extends: [
        '@perfective/eslint-config-react',
    ],
    overrides: [
        {
            files: ['*.[jt]s?(x)'],
            rules: {
                '@typescript-eslint/no-useless-template-literals': 'off',
                '@typescript-eslint/no-unsafe-unary-minus': 'off',
                'jest/no-confusing-set-timeout': 'off',
                'no-object-constructor': 'off',
                'testing-library/prefer-implicit-assert': 'off',
            },
        },
    ],
};

From `v0.10.0` to `v0.11.0`

If you do not use jest, remove eslint-plugin-jest, eslint-plugin-jest-formatting, eslint-plugin-jest-dom, and eslint-plugin-testing-library from devDependencies.
If you do not use @testing-library/jest-dom, remove eslint-plugin-jest-dom from devDependencies.
If you do not use @testing-library, remove eslint-plugin-testing-library from devDependencies.
If you do not use cypress, remove eslint-plugin-cypress from devDependencies.
If you do not use rxjs, remove eslint-plugin-rxjs from devDependencies.

Note	After removing optional peer dependencies, you may need to regenerate your `package-lock.json`, as these dependencies may remain in it and in the `node_modules`.

If you use eslint-plugin-testing-library, update rules:
- Replace testing-library/await-async-query with testing-library/await-async-queries.
- Replace testing-library/await-fire-event with testing-library/await-async-events.
- Replace testing-library/no-await-sync-query with testing-library/no-await-sync-queries.
- Replace testing-library/no-render-in-setup with testing-library/no-render-in-lifecycle.
Remove the jsdoc/newline-after-description rule customizations, if you have any.

Disable new rules in the .eslintrc.js.

module.exports = {
    extends: [
        '@perfective/eslint-config-react',
    ],
    overrides: [
        {
            files: ['*.[jt]s?(x)'],
            rules: {
                '@typescript-eslint/block-spacing': 'off', // auto-fixable
                '@typescript-eslint/no-duplicate-type-constituents': 'off',
                '@typescript-eslint/no-unsafe-enum-comparison': 'off',
                'jsdoc/imports-as-dependencies': 'off',
                'jsdoc/no-blank-blocks': 'off', // auto-fixable
                'jsdoc/tag-lines': 'off', // auto-fixable
                'unicorn/prefer-blob-reading-methods': 'off',
            },
        },
    ],
};