Skip to main content

⚡ Performance tips

Depending on the device you are operating on, in-editor performance can be a concern with Sheriff.
@typescript-eslint can be particularly taxing on the system, so, some performance considerations are in order.

Rules performance benchmarking​

The currently known slowest rules in Sheriff are the ones of @typescript-eslint that requires type information ↗ to work.

List of types-aware rules ↗.

You can benchmark rules performance by yourself by running the following command in the terminal:

TIMING=1 npm run eslint

Learn more in the ESLint official docs section ↗.

Rules performance optimization strategies​

There are a few techniques you can leverage to improve linting time.
You can choose which technique to employ or mix-and-match them.

Disable some of the heaviest rules​

As simple as it sounds, you could assess which of the slowest rules you can live without and simply disable them.

Enable some of the heaviest rules only on CI​

This approach has a little more overhead, but you could try to run the heaviest rules only on CI.

Here is an example on how you can achieve it:

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

const sheriffOptions = {
  react: false,
  next: false,
  astro: false,
  lodash: false,
  playwright: false,
  jest: false,
  vitest: false,
};

export default defineFlatConfig([
  ...sheriff(sheriffOptions),
  {
    rules: {
      "@typescript-eslint/no-misused-promises": process.env.CI ? 2 : 0,
    },
  },
]);

This is a tradeoff, as this approach is a DX degradation and could lead to some developer frustration, because perfectly valid code in local environment could instead fail in CI.

Adopt ESLint cache​

ESLint features an internal cache where you can store your previous runs.

This technique has pretty much no downsides and you should employ it in any case, regardless of any other factor.

Read the official docs on ESLint caching here: command-line-interface#caching ↗.
Instead, if your project lives in a monorepo, you can follow this guide ↗.

Review glob patterns​

ESLint, Typescript and Sheriff use minimatch syntax to handle glob patterns.
Wide glob patterns can lead to performance degradation.

Pay special attention to: