Skip to content

Latest commit

 

History

History
executable file
·
42 lines (30 loc) · 4.17 KB

README.md

File metadata and controls

executable file
·
42 lines (30 loc) · 4.17 KB

✨ A comprehensive and opinionated Typescript-first ESLint configuration ✨

Contributor Covenant npm downloads

🥳 Overview

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 npm
@sherifforg/create-config sheriff-create-config Package used to create Sheriff-based ESLint configs npm
@sherifforg/cli sheriff-cli The Sheriff CLI. Used to manage Sheriff-based ESLint configs npm

🚀 Getting Started

Visit the official docs to get started with Sheriff.

📝 Updates

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

💌 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.
The full list of the plugins used is here.