richardscull's eslint-config

richardscull's ESLint Fork (original by hyoban) Config enables most of the recommended rules for js, ts, and react, uses ESLint for formatting, and provides a lot of useful plugins.

[!TIP] You may not need lint-staged and simple-git-hooks if you don't ignore auto-fix for rules in the editor.

ni i -D eslint @richardscull/eslint-config lint-staged simple-git-hooks

If you are using ESLint 9.9.0 and eslint.config.ts, you need to install jiti.

ni -D jiti

[!TIP] You can install the nightly version from pkg.pr.new, for example, ni -D https://pkg.pr.new/hyoban/eslint-config-hyoban@{commit}.

eslint.config.mjs or eslint.config.ts if you are using ESLint 9.9.0.

// @ts-check
import { defineConfig } from '@richardscull/eslint-config'

export default defineConfig()

[!TIP] You can customize the preset by passing options according to available options

package.json

{
  "scripts": {
    "lint": "eslint",
    "lint:fix": "eslint --fix",
    "prepare": "simple-git-hooks"
  },
  "simple-git-hooks": {
    "pre-commit": "npx lint-staged"
  },
  "lint-staged": {
    "*": "eslint --fix"
  }
}

{
  "eslint.rules.customizations": [
    { "rule": "unused-imports/no-unused-imports", "severity": "warn" },
    { "rule": "test/no-only-tests", "severity": "warn" },
    { "rule": "prefer-const", "severity": "warn" }
  ],

  "eslint.codeActionsOnSave.rules": [
    "!unused-imports/no-unused-imports",
    "!test/no-only-tests",
    "!prefer-const",
    "*"
  ]
}