README.md

June 22, 2025 Β· View on GitHub

Sheriff

✨ A comprehensive and opinionated TypeScript-first ESLint configuration ✨

npm downloads Libraries.io SourceRank
CodeFactor Contributor Covenant

πŸ₯³ Overview

This repository is a monorepo that hosts the sourcecode of the following projects:

LinkSourceDescriptionVersion
Sheriff docs websitedocs-websiteSheriff documentation website
eslint-config-sheriffeslint-config-sheriffA comprehensive and opinionated TypeScript-first ESLint configurationnpm
@sherifforg/create-configsheriff-create-configPackage used to create Sheriff-based ESLint configsnpm
@sherifforg/clisheriff-cliThe Sheriff CLI. Used to manage Sheriff-based ESLint configsnpm

πŸš€ Quickstart

pnpm create @sherifforg/config

πŸ“‹ Docs

VisitΒ the official docsΒ to learn more.

πŸ“ Blog

You can follow the latest updates on the project in the official blog.

πŸ“ˆ Activity

Alt

πŸ’Œ Acknowledgments

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.

Full list of the plugins integrated in Sheriff.