🌎 Monorepo support

General guidelines

While Sheriff can technically be used at the root of monorepos, it's not recommended.
It works best when applied to individual packages within a monorepo.

Examples

├── apps
│   ├── website
│   │   └── eslint.config.js
│   ├── docs
│   │   └── eslint.config.js
├── packages
│   ├── ui
│   │   └── eslint.config.js
│   ├── utils
│   │   └── eslint.config.js
│   ├── types
│   │   └── eslint.config.js
├── node_modules
├── README
├── package.json
├── pnpm-lock.yaml
└── .gitignore

├── apps
│   ├── website
│   ├── docs
├── packages
│   ├── ui
│   ├── utils
│   ├── types
├── node_modules
├── eslint.config.js
├── README
├── package.json
├── pnpm-lock.yaml
└── .gitignore

Usage in VSCode

To make use of the ESLint VScode extension in monorepos, use the eslint.workingDirectories setting.

Setup with create-sheriff-config

If you want to use create-sheriff-config to bootstrap Sheriff in one of your workspaces, you can actually do so by following the general usage rules of workspaces, Sheriff will try to mimic the behaviour of popular monorepo CLI tools, so it will feel seamless, intuitive and familiar.

Run the command from the root of your monorepo, and then filter by the workspace you want to apply Sheriff to. A chain of prompts will start to guide you through the correct process of installation.

Examples:

npm

npx create-sheriff-config --filter=packages/my-package

Yarn

npx create-sheriff-config --filter=packages/my-package

pnpm

pnpm dlx create-sheriff-config --filter=packages/my-package