Sheriff

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
create-sheriff-config	create-sheriff-config	CLI/starter to bootstrap a Sheriff config
@sherifforg/types	sheriff-types	Sheriff types package

🚀 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.

🧡 Contributing

Suggestions

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.

Development

1. Clone the repo
2. Install the dependencies with pnpm
3. Do the changes

🌤 Changelog

Releases.

💌 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.