https://github.com/srbrahma/eslint-config-biome

Disables ESLint rules that have a recommended and equivalent Biome rule
https://github.com/srbrahma/eslint-config-biome

biome biome-js eslint eslint-config eslint-rules javascript typescript

Last synced: 6 days ago
JSON representation

Disables ESLint rules that have a recommended and equivalent Biome rule

• Host: GitHub
• URL: https://github.com/srbrahma/eslint-config-biome
• Owner: SrBrahma
• License: other
• Created: 2023-12-21T20:51:49.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-21T18:02:35.000Z (12 days ago)
• Last Synced: 2024-09-28T01:20:13.920Z (6 days ago)
• Topics: biome, biome-js, eslint, eslint-config, eslint-rules, javascript, typescript
• Language: JavaScript
• Homepage:
• Size: 452 KB
• Stars: 96
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        







# eslint-config-biome

[![npm](https://img.shields.io/npm/v/eslint-config-biome)](https://www.npmjs.com/package/eslint-config-biome) [![npm](https://img.shields.io/npm/dw/eslint-config-biome)](https://www.npmjs.com/package/eslint-config-biome)



Disables ESLint rules that have an [**equivalent and recommended**](https://github.com/biomejs/biome/discussions/3) [Biome](https://biomejs.dev/) rule, allowing the simultaneous use of Biome and ESLint.








## 💿 Installation

```bash

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.

    ```json5

    {

      "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

    ```js

    import biome from "eslint-config-biome";

    export default [

      // other configs,

      biome,

    ];

    ```

## ℹ️ Info

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

    ```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.

  ```json

  "scripts": {

    "format:check": "biome check . && eslint .",

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

  }

  ```

- Since v1.4.0, this package includes [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier), so formatting rules are also disabled as Biome is equivalent to Prettier. [Attribution](ATTRIBUTION.md).

- This package had its origin [in this discussion](https://github.com/biomejs/biome/discussions/3#discussioncomment-7876363). Thanks [DaniGuardiola

](https://github.com/DaniGuardiola) for [your *related initial crawler code*](https://github.com/biomejs/biome/discussions/3#discussioncomment-7910787)!

## 📰 [Changelog](CHANGELOG.md)