🧐 Prior art

Why yet another ESLint config?

As you may have noticed, plenty of ESLint configurations in the wild already exist (have a look here or here).
None of these projects share the same goals of Sheriff.
Sheriff has a particular vision.

The main needs that led to its creation are a need for:

• Breezy setup and use (thanks to @sherifforg/cli).
• Ease of customization (thanks to the “flat” configuration format).
• Sensible defaults based on years of real world experience in production scenarios.

After exploring every possible alternative, I came to the conclusion that none of the other options where close to what I needed for my projects and everyday use. That is why I opted for making Sheriff.

Related projects

Standard ESLint configs

• eslint-config-airbnb (comparison)
• @antfu/eslint-config (comparison)
• eslint-config-canonical
• eslint-config-hardcore
• eslint-config-galex
• eslint-config-everywhere
• eslint-prettier-typescript-config

ESLint wrappers

These tools are not just sharable ESLint configs, but are wrappers for ESLint (and sometimes Prettier) that have their own CLI and their Editor integrations.

• XO (comparison)
• Standard JS
• gts
• Eslint Kit

In-depth comparisons

The main technical difference between Sheriff and the other projects is that Sheriff is updated to the most recent version of ESLint and supports the new “flat” configuration format instead of relying on hacks like as @rushstack/eslint-patch. Because of the technical limitation imposed by this hack, these configs are harder to work with at multiple levels.

Another key difference is that the design of most of these configs seems to revolve around the idea of stuffing as many rules as possible into the config, regardless of the quality of the plugins.
Sheriff instead was shaped around solid principles and only includes the rules that let it achieve its goals.

Sheriff features unique goodies and little niceties that other libraries lack. For a quick glance at the differences between Sheriff and some of the other popular ESLint configurations mentioned above, have a look at the table below.

Feature comparison table

Feature	sheriff	eslint-config-airbnb	standard	eslint-config-standard	@antfu/eslint-config	XO	eslint-config-canonical	eslint-kit	eslint-config-galex	eslint-config-hardcore
FlatConfig	✅	❌	❌	✅	✅	❌	❌	❌	❌	❌
Maintained	✅	❌	❌	❌	✅	✅	✅	✅	❌	✅
Customizable	✅	✅	❌	✅	✅	✅	✅	✅	✅	✅
Rich Docs	✅	✅	✅	❌	✅	✅	✅	✅	✅	✅
Functional programming	✅	❌	❌	❌	❌	❌	❌	❌	❌	✅
Advanced ignores management	✅	❌	❌	❌	✅	✅	❌	❌	❌	❌
Learning curve	😊	😐	😔	😐	😊	😐	😔	😔	😔	😐
Incremental adoption	✅	❌	❌	❌	❌	❌	❌	✅	✅	❌
Typesafe config	✅	❌	❌	❌	✅	❌	❌	❌	❌	❌
Typescript	✅	❌	❌	❌	✅	✅	✅	✅	✅	✅
React	✅	✅	❌	❌	✅	✅	✅	✅	✅	✅
Vue	❌	❌	❌	❌	✅	✅	❌	✅	❌	✅
Solidjs	❌	❌	❌	❌	✅	❌	❌	✅	❌	❌
Svelte	❌	❌	❌	❌	✅	❌	❌	✅	❌	❌
GraphQL	❌	❌	❌	❌	❌	❌	✅	❌	❌	❌
Unicorn	✅	❌	❌	❌	✅	✅	✅	✅	✅	✅
Sonarjs	✅	❌	❌	❌	❌	❌	❌	❌	✅	✅
JSDoc	✅	❌	❌	❌	✅	❌	✅	❌	❌	❌
TSDoc	✅	❌	❌	❌	❌	❌	❌	❌	❌	❌
Import	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Lodash	✅	❌	❌	❌	❌	❌	✅	❌	❌	❌
Remeda	✅	❌	❌	❌	❌	❌	❌	❌	❌	❌
Nextjs	✅	❌	❌	❌	✅	❌	✅	✅	✅	❌
Jest	✅	❌	❌	❌	❌	❌	✅	❌	✅	✅
Vitest	✅	❌	❌	❌	✅	❌	✅	❌	❌	❌
Testing-library	❌	❌	❌	❌	❌	❌	❌	❌	✅	✅
Playwright	✅	❌	❌	❌	❌	❌	❌	❌	❌	❌
Storybook	✅	❌	❌	❌	❌	❌	❌	❌	✅	✅
Astro	✅	❌	❌	❌	✅	❌	❌	❌	❌	❌

Sheriff vs. eslint-config-airbnb

I cannot help mentioning that eslint-config-airbnb is apparently the most popular ESLint config.

However, a few specific reasons that led to this, and none of them has to do with the quality of the config itself:

• It was one of the first ESLint configs to be created.
• The starred repository actually contains a stylistic guide, not just the ESLint config. Plenty of the endorsements are for the guide, not the ESLint config.
• Airbnb owns the repository. Many developers through the years starred it just for their enthusiasm for the company, not for the ESLint library in particular.
• For many years, it was the default ESLint config in many popular boilerplates, guides, and tutorials.

Nowadays, it is frowned on by many industry professionals. Some of the most glaring issues include:

• It is largely outdated and has not been maintained in some time.
• It is big, bloated, and too strict for most projects.
• It does not support TypeScript out of the box, to get it you actually have to use a different library that is even less maintained and supported than the original one.

Sheriff vs. @antfu/eslint-config

Anthony Fu’s personal config shares many similarities with Sheriff, but is less mature and has fewer features.

Also, it is important to note that it goes for a particularly opinionated route toward styling, where instead of adopting Prettier, it relies on eslint-stylistic for its formatting needs.

That said, Anthony is a prominent figure in the JavaScript community and Sheriff takes some inspiration from his config.
Ultimately, both Sheriff and the Anthony’s config are good choices, but they have different stylistic choices.

Sheriff vs. XO

XO is an interesting project. It uses ESLint and Prettier under the hood, but does not directly expose them to you. Instead of relying on the ESLint CLI and VS Code extension, it has its own CLI and VS Code extension. On the surface, it can seem like a good thing because it allows them to provide a more integrated experience, but it also means that you are locked into their ecosystem and cannot freely extend it.

It is rather opinionated in its stylistic and formatting choices and is not flexible.

XO has many issues that ESLint and Prettier do not have.