✨ A comprehensive and opinionated Typescript-first ESLint configuration ✨
This repository is a monorepo that hosts the sourcecode of the following projects:
| Link | Source | Description | Version |
|---|---|---|---|
| Sheriff docs website | docs-website | Sheriff documentation website | |
eslint-config-sheriff |
eslint-config-sheriff | A comprehensive and opinionated Typescript-first ESLint configuration |  |
@sherifforg/create-config |
sheriff-create-config | Package used to create Sheriff-based ESLint configs |  |
@sherifforg/cli |
sheriff-cli | The Sheriff CLI. Used to manage Sheriff-based ESLint configs |  |
Visit the official docs to get started with Sheriff.
You can follow the latest updates on the project in the official blog.
I consider Sheriff a community effort, and I welcome suggestions and contributions of any kind.
Feel free to propose suggestions about new rules to implement, or tweaks to existing rules.
Please use the discussions tab or the issues tab for new rules proposals.
- Clone this repository
- Enable Corepack using
corepack enable - Install dependencies using
pnpm install - Do the changes
For some of this configuration, eslint-config-red was partially used as a base.
Additionally, inspiration was drawn from eslint-config-airbnb for some of the rules in no-restricted-syntax.
I don't take any attribution for the rules in the various eslint-plugins used here (except for the few that I personally created). Please consider starring the respective projects for the awesome work their authors made. Sheriff wouldn't be possible without their efforts.
The full list of the plugins used is here.