jam/eslint.config.js

// For more info, see https://github.com/storybookjs/eslint-plugin-storybook#configuration-flat-config-format
import js from '@eslint/js'
import pluginQuery from '@tanstack/eslint-plugin-query'
import compat from 'eslint-plugin-compat'
import reactHooks from 'eslint-plugin-react-hooks'
import reactRefresh from 'eslint-plugin-react-refresh'
import storybook from 'eslint-plugin-storybook'
import eslintPluginUnicorn from 'eslint-plugin-unicorn'
import { defineConfig } from 'eslint/config'
import globals from 'globals'
import tseslint from 'typescript-eslint'

export default defineConfig(
  {
    ignores: ['dist', './.storybook/**', './storybook-static/**', 'public/mockServiceWorker.js'],
  },
  {
    extends: [js.configs.recommended, ...tseslint.configs.recommended],
    files: ['**/*.{ts,tsx}'],
    languageOptions: {
      ecmaVersion: 2023,
      globals: globals.browser,
    },
    plugins: {
      'react-hooks': reactHooks,
      'react-refresh': reactRefresh,
    },
    rules: {
      ...reactHooks.configs.recommended.rules,
      'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
      // Allow unused variables when they start with underscore
      '@typescript-eslint/no-unused-vars': [
        'error',
        {
          argsIgnorePattern: '^_',
          varsIgnorePattern: '^_',
          destructuredArrayIgnorePattern: '^_',
          caughtErrorsIgnorePattern: '_ignoredOnPurpose',
          enableAutofixRemoval: {
            imports: true,
          },
        },
      ],
    },
  },
  {
    ignores: [
      './src/components/ui/*.tsx', // shadcn components
      './src/**/*.stories.tsx',
    ],
    files: ['./src/**/*.{ts,tsx}'],
    languageOptions: {
      parserOptions: {
        projectService: true,
      },
    },
    extends: [...tseslint.configs.recommendedTypeChecked],
    rules: {
      '@typescript-eslint/no-redundant-type-constituents': ['off'], // shows intent
    },
  },
  {
    files: ['./src/**/*.{ts,tsx}'],
    extends: [...pluginQuery.configs['flat/recommended']],
    rules: {
      '@tanstack/query/exhaustive-deps': [
        'error',
        {
          allowlist: {
            variables: ['client', 'token'],
          },
        },
      ],
    },
  },
  {
    extends: [eslintPluginUnicorn.configs.recommended],
    ignores: [
      './src/components/ui/*.tsx', // shadcn components
    ],
    rules: {
      'unicorn/filename-case': ['off'],
      'unicorn/no-array-reduce': ['off'],
      'unicorn/no-array-for-each': ['off'],
      'unicorn/prefer-optional-catch-binding': ['off'],
      'unicorn/prefer-string-slice': ['off'],
      'unicorn/prefer-global-this': ['off'],
      'unicorn/no-thenable': ['off'], // used by yup schema validation
      'unicorn/prefer-ternary': ['off'], // can improve readability
      'unicorn/no-nested-ternary': ['off'], // can improve readability
      'unicorn/no-useless-undefined': ['off'], // can improve comprehensibility
      'unicorn/no-negated-condition': ['off'], // allows handling errors first
      'unicorn/catch-error-name': [
        'error',
        {
          ignore: ['_ignoredOnPurpose'],
        },
      ],
      'unicorn/numeric-separators-style': [
        'error',
        {
          onlyIfContainsSeparator: true, // TODO: set to false
          number: {
            minimumDigits: 4,
            groupLength: 3,
          },
        },
      ],
      'unicorn/prevent-abbreviations': [
        'error',
        {
          checkFilenames: false,
          allowList: {
            acc: true,
            args: true,
            i: true,
            val: true,
            Fn: true,
            props: true,
            Props: true,
            dev: true,
            Dev: true,
            ref: true,
            Ref: true,
          },
        },
      ],
      'unicorn/number-literal-case': [
        'error',
        {
          hexadecimalValue: 'lowercase',
        },
      ],

      'unicorn/switch-case-braces': ['off'], // TODO: enable
      'unicorn/no-null': ['off'], // TODO: enable
    },
  },
  compat.configs['flat/recommended'],
  storybook.configs['flat/recommended'],
)