index.js

module.exports = {
    plugins: ['react', 'react-hooks', '@typescript-eslint/eslint-plugin'],
    extends: ['eslint:recommended'],

    parser: '@typescript-eslint/parser',

    parserOptions: {
        sourceType: 'module',
        babelOptions: {
            configFile: '@xh/eslint-config/babel.config.js'
        }
    },

    // Browser is deliberately set to false to catch errors where a missing import falls back
    // to a global without that being obvious - e.g. lodash `find` vs `window.find`.
    // Selected browser globals are then whitelisted below.
    env: {
        browser: false,
        commonjs: true,
        es6: true,
        node: true
    },

    globals: {
        // Setting to "false" here means "don't warn" - these are expected/valid globals.
        AbortController: false,
        Blob: false,
        DOMRect: false,
        Element: false,
        Event: false,
        File: false,
        FileReader: false,
        FocusEvent: false,
        FormData: false,
        Headers: false,
        HTMLButtonElement: false,
        HTMLElement: false,
        HTMLDivElement: false,
        HTMLImageElement: false,
        HTMLInputElement: false,
        HTMLTextAreaElement: true,
        Intl: false,
        JSX: true,
        KeyboardEvent: false,
        MouseEvent: false,
        WebSocket: false,
        document: false,
        fetch: false,
        window: false,
        xhAgGridLicenseKey: false,
        xhAppBuild: false,
        xhAppBuildTimestamp: false,
        xhAppCode: false,
        xhAppName: false,
        xhAppVersion: false,
        xhBaseUrl: false,
        xhBuildTimestamp: false,
        xhIsDevelopmentMode: false,
        // Flag use of `window.isFinite`. Not handled by `browser:false` config above and is a
        // similar case where we more likely intend to use the lodash version (which yields a
        // different result for `null`).
        isFinite: 'off'
    },

    rules: {
        // Hoist - disabled
        'eqeqeq': 'off',
        'no-console': 'off',
        'no-empty': 'off',
        'no-multi-spaces': 'off',
        'no-prototype-builtins': 'off',
        'no-trailing-spaces': 'off',
        'no-underscore-dangle': 'off',
        'semi-spacing': 'off',
        'space-infix-ops': 'off',
        'space-unary-ops': 'off',
        'strict': 'off',

        // React + Hooks
        'react/jsx-uses-react': 'error',
        'react/jsx-uses-vars': 'error',
        'react-hooks/exhaustive-deps': 'warn',
        // Linter unable to interpret our factory pattern w/hook calls in render fn config.
        'react-hooks/rules-of-hooks': 'off',

        // Hoist - enabled / customized
        'no-unused-vars': ['error', {
            ignoreRestSiblings: true,
            args: 'none'
        }],
        'array-bracket-spacing': ['error', 'never'],
        'comma-dangle': 'error',
        'comma-spacing': ['error', {
            before: false,
            after: true
        }],
        'comma-style': 'error',
        'brace-style': ['error', '1tbs', {
            allowSingleLine: true
        }],
        'curly': ['error', 'multi-line'],
        'key-spacing': ['error', {
            beforeColon: false,
            afterColon: true,
            mode: 'minimum'
        }],
        'keyword-spacing': ['error', {
            before: true,
            after: true
        }],
        'space-before-function-paren': ['error', {
            anonymous: 'never',
            named: 'never',
            asyncArrow: 'always'
        }],
        'no-spaced-func': 'error',
        'space-in-parens': 'error',
        'space-before-blocks': 'error',
        'spaced-comment': ['error', 'always', {
            markers: ['=', 'noinspection'],
            exceptions: ['-']
        }],
        'quotes': ['error', 'single', {
            avoidEscape: true,
            allowTemplateLiterals: true
        }],
        'indent': ['error', 4, {
            SwitchCase: 1,
            // Workaround for esLint v8 indent issue w/decorators.
            // See https://github.com/eslint/eslint/issues/15299#issuecomment-968099681
            ignoredNodes: ['PropertyDefinition']
        }],
        'operator-linebreak': ['error', 'after'],
        'no-multiple-empty-lines': ['error', {
            max: 2
        }],
        'block-scoped-var': 'error',
        'semi': ['error', 'always', {
            omitLastInOneLineBlock: true
        }],
        'no-return-await': 'error'
    },
    // Run typescript-specific rules only on typescript files
    overrides: [
        {
            files: ['*.ts', '*.tsx'],
            parserOptions: {'project': ['./tsconfig.json']},
            // Note: Remember to disable the base rules when enabling the ts version
            rules: {
                'no-unused-vars': 'off',
                '@typescript-eslint/no-unused-vars': ['error', {
                    ignoreRestSiblings: true,
                    args: 'none'
                }],
                // Sets 'return-await' to 'in-try-catch' mode
                'no-return-await': 'off',
                '@typescript-eslint/return-await': ['error', 'in-try-catch'],
                // Allow for multiple method signatures in TS (which appear as dupe class members)
                'no-dupe-class-members': 'off',
                'no-redeclare': 'off',
                '@typescript-eslint/no-redeclare': ['error', {
                    ignoreDeclarationMerge: true
                }]
            }
        }
    ]
};