eslint-config-biome
Version:
Disables ESLint rules that have a recommended and equivalent Biome rule
82 lines (56 loc) • 2.23 kB
Markdown
<div align="center">
<br/>
<img src="logo.svg" alt="logo" width="250"/>
# eslint-config-biome
[](https://www.npmjs.com/package/eslint-config-biome) [](https://www.npmjs.com/package/eslint-config-biome)
<h4>
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.
</h4>
<br/>
</div>
## 💿 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).
## 📰 [Changelog](CHANGELOG.md)