Skip to main content

♻ Migration guide

If you are setting up Sheriff in an already established codebase, follow these steps:

  1. Start by running the npm init sheriff-config command and follow the advices that it prints in the console
  2. Make sure that the only ESLint config file present in any workspace' package is the eslint.config.js
  3. If you want to keep your existing custom rules on-top of Sheriff, move them to the eslint.config.js, after the sheriff function, so they will override it. Refer to the configuration instructions
  4. Make sure to uninstall all the packages that Sheriff already incorporates out-of-the-box. Here is the list

Progressive adoption story​

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 and focused PRs.
You can achieve this by leveraging 2 techniques:

  • open the eslint.config.js file and add a key files in the sheriffOptions object. The value accepts an array of filepaths, dictated by minimatch syntax. Only the matching files found in this array will be linted.

    See example below:

eslint.config.js
import sheriff from "eslint-config-sheriff";
import { defineFlatConfig } from "eslint-define-config";

const sheriffOptions = {
  files: ["./src/**/*"], // Only the files in the src directory will be linted.
  react: false,
  next: false,
  astro: false,
  lodash: false,
  playwright: false,
  jest: false,
  vitest: false,
};

export default defineFlatConfig([...sheriff(sheriffOptions)]);
info

By default, the automatic setup process will not add the files in the object and every js/ts file will be linted. Use this only if you want to specifically lint just a subsection of the codebase.