🌎 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 VS Code

To use the ESLint VS Code extension in monorepos, use the eslint.workingDirectories setting.

Setup with npm init @sherifforg/config

If you want to use npm init @sherifforg/config to bootstrap Sheriff in one of your workspace packages, you can do so by following the general rules of workspaces. Sheriff will try to mimic the behavior 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.

Example:

npm

npm init @sherifforg/config --filter=path/to/my/package

Yarn

yarn create @sherifforg/config --filter=path/to/my/package

pnpm

pnpm create @sherifforg/config --filter=path/to/my/package

bun

bunx @sherifforg/create-config --filter path/to/my/package

Footnotes

1. See discussion #61 for more detailed information. ↩