eslint-config-biome

eslint-config-biome

Disables ESLint rules that have an equivalent and recommended Biome rule, allowing the simultaneous use of Biome and ESLint.

💿 Installation

npm install -D eslint-config-biome # or your preferred package manager ;)

• .eslintrc.*: Add the following as the last item in the "overrides" array. Create it if necessary.

  {
    "overrides": [
      // other overrides,
      {
        files: ["*.ts", "*.js", "*.tsx", "*.jsx"],
        extends: ["biome"],
      }
    ],
  }
  

• Or eslint.config.js: Import eslint-config-biome and have it as the last item in the configuration array

  import eslintConfigBiome from "eslint-config-biome";
  
  export default [
    // other configs,
    eslintConfigBiome,
  ];
  

ℹ️ Info

• In VSCode, to apply Biome and ESLint on save, you should have these in your project's .vscode/settings.json:

  {
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": "explicit",
      "source.organizeImports.biome": "explicit",
      "quickfix.biome": "explicit"
    },
    "editor.defaultFormatter": "biomejs.biome"
  }
  

• For package.json scripts and CI, I recommend running biome before eslint for faster failure detection.

  "scripts": {
    "format:check": "biome check . && eslint .",
    "format": "biome check --apply-unsafe . && eslint --fix .",
  }
  

• Since v1.4.0, this package includes eslint-config-prettier, so formatting rules are also disabled as Biome is equivalent to Prettier. Attribution.

• This package had its origin in this discussion. Thanks DaniGuardiola for your related initial crawler code!

📰 Changelog

Changelog

1.8.3

• Fix issue with ESLint's Flat Config (#7).