@yeger/eslint-config/src/index.mjs

ESLint config preset based on @antfu/eslint-config.

import { dirname } from 'node:path'
import { fileURLToPath } from 'node:url'

import antfu from '@antfu/eslint-config'
import { FlatCompat } from '@eslint/eslintrc'
import pluginCypress from 'eslint-plugin-cypress'

const __dirname = dirname(fileURLToPath(import.meta.url))

/**
 * @param  {...Linter.Config[]} configs
 * @returns {Linter.Config[]} a preset ESLint config.
 */
export default function (...configs) {
  const compat = new FlatCompat({ resolvePluginsRelativeTo: __dirname })
  return antfu(
    {
      formatters: {
        css: true,
        html: true,
      },
      markdown: true,
      react: true,
      stylistic: {
        indent: 2,
        quotes: 'single',
      },
      typescript: true,
      vue: true,
      yaml: true,
    },
    pluginCypress.configs.recommended,
    compat.extends(
      'plugin:astro/recommended',
      'plugin:md/recommended',
      'plugin:tailwindcss/recommended',
    ),
    compat.plugins('jsx-a11y', 'md', 'tailwindcss', 'tsdoc'),
    {
      ignores: ['**/vite.config.ts.*'],
    },
    {
      rules: {
        curly: ['error', 'all'],
        'style/brace-style': ['error', '1tbs'],
        '@/brace-style': ['error', '1tbs'],
        'ts/explicit-member-accessibility': [
          'error',
          {
            accessibility: 'explicit',
            overrides: {
              accessors: 'explicit',
              constructors: 'explicit',
              parameterProperties: 'explicit',
            },
          },
        ],
        'ts/no-unused-vars': 'off',
        'brace-style': ['error', '1tbs'],
        'perfectionist/sort-imports': 'off',
        'perfectionist/sort-named-imports': 'off',
        'test/prefer-lowercase-title': 'off',
        'jsdoc/check-param-names': 'off',
        'md/remark': [
          'error',
          {
            plugins: ['frontmatter', ['lint-maximum-line-length', false]],
          },
        ],
        'no-multiple-empty-lines': [
          'error',
          {
            max: 1,
            maxEOF: 1,
          },
        ],
        'no-unused-vars': 'off',
        'prefer-template': 'error',
        'prefer-const': 'error',
        'react/prop-types': 'off',
        'style/arrow-parens': ['error', 'always'],
        'style/operator-linebreak': 'off',
        'style/quote-props': 'off',
        'tailwindcss/enforces-shorthand': 'error',
        'tailwindcss/no-custom-classname': 'off',
        'tsdoc/syntax': 'error',
        // The following unicorn rules are disabled due to implementation issues
        'unicorn/error-message': 'off',
        'unicorn/no-instanceof-array': 'off',
        'unicorn/prefer-includes': 'off',
        'unicorn/prefer-number-properties': 'off',
        'unused-imports/no-unused-imports': 'error',
        'unused-imports/no-unused-vars': [
          'error',
          {
            vars: 'all',
            varsIgnorePattern: '^_',
            args: 'after-used',
            argsIgnorePattern: '^_',
          },
        ],
        'yml/quotes': ['error', { prefer: 'single' }],
      },
    },
    {
      files: ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
      rules: {
        'tsdoc/syntax': 'off',
        'tsdoc-escape-right-brace': 'off',
        'tsdoc-malformed-inline-tag': 'off',
        'tsdoc-undefined-tag': 'off',
      },
    },
    {
      files: ['**/*.md'],
      rules: {
        'no-unused-vars': 'off',
        'tsdoc/syntax': 'off',
        'unused-imports/no-unused-imports': 'off',
      },
    },
    {
      files: ['**/*.astro'],
      rules: {
        'antfu/no-top-level-await': 'off',
        'style/indent-binary-ops': 'off',
        'style/jsx-closing-bracket-location': 'off',
        'style/jsx-closing-tag-location': 'off',
        'style/jsx-indent': 'off',
        'style/jsx-one-expression-per-line': 'off',
        'style/jsx-wrap-multilines': 'off',
        'style/multiline-ternary': 'off',
        'unused-imports/no-unused-vars': 'off',
      },
    },
    {
      ignores: ['**/*.astro/*.js'],
    },
    {
      files: ['**/*.bench.ts'],
      rules: {
        'test/consistent-test-it': 'off',
      },
    },
    ...configs,
  )
}