Migration Guide

Step-by-step instructions

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

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 a few techniques:

• open the eslint.config.mjs 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:

import { sheriff, tseslint } from "eslint-config-sheriff";

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

export default tseslint.config(sheriff(sheriffOptions));

import { sheriff, type SheriffSettings, tseslint  } from "eslint-config-sheriff";

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

export default tseslint.config(sheriff(sheriffOptions));

• use eslint-interactive
• use ESLint Bulk Suppressions