eslint-config-sheriff
Advanced tools
Note For a better reading experience, checkout the official docs.
Sheriff is a comprehensive Eslint configuration. It supports various popular technologies.
⚠️ At the moment, Sheriff supports only Typescript codebases with modern Ecmascript standards. Support for vanilla Javascript will come at a later time. See: roadmap.
FlatConfig, introduced in Eslint v8.23.0.Managing a complex Eslint configuration takes time and effort. Sheriff does it for you.
This library is very opinionated, but it's for the better. I took a lot of decisions so you don't have to 1.
You can now quickstart static analysis in all your Typescript projects with ease. It's just 1 create-sheriff-config.
You can think of Sheriff like prettier or create-react-app. It's a tool that comes battery-packed with optimal defaults. It removes configuration decisions from the equation, so you or your team can focus on developing the actual product.
And if you don't like something, you can easily override it, and just as easily you can extend it. See: configuration.
This config is highly opinionated, so make sure to meet the hard requirements in your project.
Then, let create-sheriff-config handle the whole setup for you automatically, or do it yourself manually.
Let the CLI take care of everything! Just run this command in your terminal:
❯ npx create-sheriff-config
...and you are good to go! Happy hacking 🎉
Follow these steps:
Install the package from npm.
# npm
❯ npm install -D eslint-config-sheriff
# yarn
❯ yarn add -D eslint-config-sheriff
# pnpm
❯ pnpm add -D eslint-config-sheriff
Create a eslint.config.js 2 file at the root of your project and copy/paste the contents of this snippet:
// eslint.config.js
import sheriff from 'eslint-config-sheriff';
export default [...sheriff];
or, if you already have a eslint.config.js in your project, just append sheriff to the configs array, like this:
// eslint.config.js
import sheriff from 'eslint-config-sheriff';
// my other imports...
export default [
// my other configurations...
...sheriff,
];
Configure Sheriff (optional)
Setup prettier (optional)
eslint.config.js beyond Sheriff as much as you like, just like you normally would. Or you can disable any rule Sheriff comes with. Sheriff doesn't impose any limitation. See: configuration.npx create-sheriff-config. The command will automatically infer the details of your project and figure out the optimal Sheriff configuration by itself.create-sheriff-config will config automatically everything for you and will warn you if you need to take any special precautions. Bottom line: it's never too late to install Sheriff.FlatConfig. You can use Sheriff to easily and safely migrate your project to the new config format without effort. See: migration guide..sheriffrc.json. See: configuration.See Rules.
Configure Sheriff as desired in the .sheriffrc.json file 3.
Every config option can be set on/off (you just pass them a boolean value). As they are all opt-in, they are all disabled by default.
// .sheriffrc.json (default)
{
"react": false,
"next": false,
"lodash": false,
"playwright": false,
"jest": false,
"vitest": false
}
Override any Sheriff rule as desired in the eslint.config.js file.
For example:
// eslint.config.js
import sheriff from 'eslint-config-sheriff';
export default [...sheriff];
Let's say you want to disable a Sheriff rule, like import/first:
// eslint.config.js
import sheriff from 'eslint-config-sheriff';
export default [
...sheriff,
{
rules: {
'import/first': 0, // 👉 'import/first' is now disabled everywhere.
},
},
];
Likewise, let's say you want to enable a new rule:
// eslint.config.js
import sheriff from 'eslint-config-sheriff';
export default [
...sheriff,
{
rules: {
'no-undef': 2,
},
},
];
This is just the standard behavior of the new configuration system of Eslint, which I'm illustrating here for your convenience. Sheriff doesn't alter this in any way.
For more in-depth information, refer to the official docs.
Sheriff tries to incorporate prettier out-of-the-box.
The create-sheriff-config command will spin up for you a default .prettierrc.json configuration. You can modify it if you need to, but it is discouraged. Act with caution.
If you don't use the create-sheriff-config command, you will have to provide a prettier config yourself. Also don't forget the .prettierignore file.
If you already have a prettier config in your project, the create-sheriff-config command won't create a new prettier config, nor will attempt to modify the existing one.
Sheriff comes with the rules of eslint-config-prettier out-of-the-box.
By design, Sheriff doesn't incorporate eslint-plugin-prettier. Its use is discouraged by the prettier team itself, as it just slows down your editor.
Instead, for your local editing experience, it's recommended to install a editor extension.
If you want to enforce Prettier at pre-commit stage, see the official docs.
To enforce Prettier in CI, see the CLI docs.
The main difference between Sheriff and the other projects is that Sheriff is updated to the most recent version of Eslint and supports the new FlatConfig instead of relying on weird hacks using the @rushstack/eslint-patch.
There are of course other differences as well, but you can get an idea for yourself by reading their READMEs.
If you are setting up Sheriff in an already established codebase, follow these steps:
Start by running the create-sheriff-config command and follow the advices that it prints in the console.
Make sure that the only eslint config file present in the whole project is the eslint.config.js.
If you want to keep your existing custom rules on-top of Sheriff, move them to the eslint.config.js, after the sheriff config. Refer to the configuration instructions.
Make sure to uninstall all the packages that Sheriff already incorporates out-of-the-box. Here is the list.
In massive codebases it can be troublesome to adapt to all these rules all at once. It is preferable to progressively fix the errors at your own pace, possibly with atomic commits. You can achieve this by leveraging 2 techniques:
open the .sheriffrc.json file and add a key files in the JSON object. The value accepts an array of filepaths, dictaced by minimatch syntax. Only the matching files found in this array will be linted. See example below:
// .sheriffrc.json
{
"files": ["./src/**/*"],
"react": false,
"next": false,
"lodash": false,
"playwright": false,
"jest": false,
"vitest": false
}
Note By deafult the
fileskey is absent in the object and every js/ts file will be linted. Use this only if you want to specifically lint only a subsection of the codebase.
use eslint-interactive.
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.
See Releases.
eslint-plugin-next.sheriffrc.json file supportcreate-react-appreact as a hard requirementFor some of this config i partially used eslint-config-red as a base.
Also took inspiration 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.
This config is particularly useful for big teams with developers of various skill levels. Sheriff was made to prevent all kind of mistakes and to align the team on the same playing field. It is battle-tested in real-world scenarios and shines especially in such. ↩
Sheriff is based on the new format of Eslint configs. You cannot extend Sheriff from a old config format, it wouldn't work. ↩
Sheriff utilizes cosmiconfig under-the-hood to power-up the Sheriff configuration. You are not forced to call the config file ".sheriffrc.json", you can choose one of the alternative file types. See cosmiconfig for details. ↩
FAQs
A comprehensive and opinionated Typescript-first ESLint configuration.
The npm package eslint-config-sheriff receives a total of 108 weekly downloads. As such, eslint-config-sheriff popularity was classified as not popular.
We found that eslint-config-sheriff demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket is tracking a new trend where malicious actors are now exploiting the popularity of LLM research to spread malware through seemingly useful open source packages.
Security News
Research
Noxia, a new dark web bulletproof host, offers dirt cheap servers for Python, Node.js, Go, and Rust, enabling cybercriminals to distribute malware and execute supply chain attacks.
Company News
Socket safeguards companies from software supply chain attacks by detecting and preventing threats in open source code and empowering developers to secure their applications and critical services against malware and other security risks.