🥳 Introduction
This is the official website of the open-source library Sheriff.
What is Sheriff?
Sheriff is a comprehensive ESLint configuration that supports many popular technologies.
warning
Sheriff is a TypeScript-first library, and thus only supports TypeScript codebases written with modern ECMAScript standards. Vanilla JavaScript codebases are not supported for now. See FAQ.
Key points
- This library is pioneering in the adoption of the ESLint’s flat configuration system, introduced in ESLint v8.23.0
- Sheriff emphasizes ease of setup and use. It promotes a “zero overhead approach”. See also: philosophy.
- Sheriff is a “plug & play” solution, but you can still customize it as much as you want. See also: features.
Trivia
The name “Sheriff” comes from the idea that it is a tool that watches over your codebase to keep everything in order.
Ok, let’s do this!
To get started, head over to the automatic setup guide and follow the instructions.