# @sapphire/eslint-config

> Standard ESLint config for the Sapphire Community

Latest version **5.0.6** (published 2025-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sapphire/eslint-config
pnpm add @sapphire/eslint-config
yarn add @sapphire/eslint-config
bun add @sapphire/eslint-config
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads; no types.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 5.0.6 |
| Published | 2025-05-08 |
| First published | 2020-09-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=v14.0.0 |
| Dependencies | 7 |
| Unpacked size | 62.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 191 |
| Author | @sapphire |
| Maintainers | favna, vladfrangu, kyranet |
| Keywords | sapphiredev, bot, typescript, ts, yarn, discord, sapphire, standalone |

## Links

- npm: https://www.npmjs.com/package/@sapphire/eslint-config
- Repository: https://github.com/sapphiredev/utilities
- Homepage: https://github.com/sapphiredev/utilities/tree/main/packages/eslint-config
- Issues: https://github.com/sapphiredev/utilities/issues
- npm.io page: https://npm.io/package/@sapphire/eslint-config

## Dependencies (7)

- [eslint](https://npm.io/package/eslint.md) ^8.57.1
- [prettier](https://npm.io/package/prettier.md) ^3.5.3
- [typescript](https://npm.io/package/typescript.md) ~5.4.5
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^10.1.3
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^5.4.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^7.18.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^7.18.0

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 5.0.6 (latest) — 2025-05-08
- 5.0.7-next.c1299bac (next) — 2026-03-08
- 6.0.0-pr-935.7da5c8bb (pr-935) — 2025-11-25
- 5.0.5-pr-725.55b1ff7b.0 (pr-725) — 2024-03-17
- 5.0.4-pr-684.9d7e2fce.0 (pr-684) — 2023-12-14
- 5.0.0-pr-601.2f2c308a.0 (pr-601) — 2023-05-28
- 5.0.0-pr-589.aa473f9.0 (pr-589) — 2023-05-04
- 5.0.0-pr-587.e9607661.0 (pr-587) — 2023-05-04
- 5.0.0-pr-584.b444d5b.0 (pr-584) — 2023-05-02
- 4.4.2-pr-575.91d23d87.0 (pr-575) — 2023-04-16
- 4.4.0-pr-567.8638d898.0 (pr-567) — 2023-04-06
- 4.3.9-pr-434.77ef153.0 (pr-434) — 2023-01-06
- 4.1.0-pr-270.b2c4518.0 (pr-270) — 2022-01-26
- 3.3.0-pr-160.676f855.0 (pr-160) — 2021-08-23
- 3.3.0-pr-159.fae7a606.0 (pr-159) — 2021-08-23
- … 1120 more at https://npm.io/package/@sapphire/eslint-config/versions

## README

<div align="center">

![Sapphire Logo](https://raw.githubusercontent.com/sapphiredev/assets/main/banners/SapphireCommunity.png)

# @sapphire/eslint-config

**ESLint configuration for all Sapphire Community repositories.**

[![GitHub](https://img.shields.io/github/license/sapphiredev/utilities)](https://github.com/sapphiredev/utilities/blob/main/LICENSE.md)
[![npm bundle size](https://img.shields.io/bundlephobia/min/@sapphire/eslint-config?logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=@sapphire/eslint-config)
[![npm](https://img.shields.io/npm/v/@sapphire/eslint-config?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/eslint-config)

</div>

## Installation

You can use the following command to install this package, or replace `npm install` with your package manager of choice.

```sh
npm install --save-dev @sapphire/eslint-config
```

---

## Usage

Add the ESLint config to your `package.json`:

```json
{
	"name": "my-project",
	"eslintConfig": {
		"extends": "@sapphire"
	}
}
```

Or to `eslintrc.js` / `.eslintrc.json`:

```json
{
	"extends": "@sapphire"
}
```

Or to `eslint.config.js`:

```
const { FlatCompat } = require('@eslint/eslintrc')
const sapphireEslintConfig = require('@sapphire/eslint-config')

const compat = new FlatCompat()

module.exports = [
	...compat.config(sapphireEslintConfig),
	{
		// other configs
	}
]
```

Create `tsconfig.eslint.json` next to the eslint config file, for example with content:

```json
{
	"extends": "./tsconfig.json",
	"include": ["src", "test"]
}
```

## Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

|   Donate With   |                       Address                       |
| :-------------: | :-------------------------------------------------: |
| Open Collective | [Click Here](https://sapphirejs.dev/opencollective) |
|      Ko-fi      |      [Click Here](https://sapphirejs.dev/kofi)      |
|     Patreon     |    [Click Here](https://sapphirejs.dev/patreon)     |
|     PayPal      |     [Click Here](https://sapphirejs.dev/paypal)     |

## Contributors

Please make sure to read the [Contributing Guide][contributing] before making a pull request.

Thank you to all the people who already contributed to Sapphire!

<a href="https://github.com/sapphiredev/utilities/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=sapphiredev/utilities" />
</a>

[contributing]: https://github.com/sapphiredev/.github/blob/main/.github/CONTRIBUTING.md

---
_Source: https://npm.io/package/@sapphire/eslint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
