\r\n\r\n---\r\n\r\n\r\n\r\n## About\r\n\r\nSherif is an opinionated, zero-config linter for TypeScript & JavaScript monorepos. It runs fast in any monorepo and enforces rules to provide a better, standardized DX.\r\n\r\n## Features\r\n\r\n- ✨ **PNPM, Bun, NPM, Yarn...**: sherif works with all package managers\r\n- 🔎 **Zero-config**: it just works and prevents regressions\r\n- ⚡ **Fast**: doesn't need `node_modules` installed, written in 🦀 Rust\r\n\r\n## Installation\r\n\r\nRun `sherif` in the root of your monorepo to list the found issues. By default, any error will cause Sherif to [exit with a code 1](#exit-code):\r\n\r\n```bash\r\n# PNPM\r\npnpm dlx sherif@latest\r\n# Bun\r\nbunx sherif@latest\r\n# NPM\r\nnpx sherif@latest\r\n# Yarn\r\nyarn dlx sherif@latest\r\n```\r\n\r\nWe recommend running Sherif in your CI once [all errors are fixed](#autofix). Run it by **specifying a version instead of latest**. This is useful to prevent regressions (e.g. when adding a library to a package but forgetting to update the version in other packages of the monorepo).\r\n\r\nWhen using the GitHub Action, it will search for a `sherif` script in the root `package.json` and use the same arguments automatically to avoid repeating them twice. You can override this behaviour with the `args` parameter.\r\n\r\n\r\n\r\nGitHub Actions example\r\n\r\n```yaml\r\n# Using the `QuiiBz/sherif` action\r\nname: Sherif\r\non:\r\n pull_request:\r\njobs:\r\n check:\r\n name: Run Sherif\r\n runs-on: ubuntu-22.04\r\n steps:\r\n - uses: actions/checkout@v4\r\n - uses: QuiiBz/sherif@v1\r\n # Optionally, you can specify a version and arguments to run Sherif with:\r\n # with:\r\n # version: 'v1.13.0'\r\n # args: '--ignore-rule root-package-manager-field'\r\n\r\n# Using `npx` to run Sherif\r\nname: Sherif\r\non:\r\n pull_request:\r\njobs:\r\n check:\r\n name: Run Sherif\r\n runs-on: ubuntu-22.04\r\n steps:\r\n - uses: actions/checkout@v4\r\n - uses: actions/setup-node@v3\r\n with:\r\n node-version: 24\r\n - run: npx sherif@1.13.0\r\n```\r\n\r\n\r\n\r\n## Autofix\r\n\r\nMost issues can be automatically fixed by using the `--fix` (or `-f`) flag. Sherif will automatically run your package manager's `install` command (see [No-install mode](#no-install-mode) to disable this behavior) to update the lockfile. Note that autofix is disabled in CI environments (when `$CI` is set):\r\n\r\n```bash\r\nsherif --fix\r\n```\r\n\r\n### Autofixing the [`multiple-dependency-versions`](#multiple-dependency-versions-) rule\r\n\r\nBy default, running `--fix` with the `multiple-dependency-versions` rule will ask you to select which version to use for each dependency with multiple versions across the monorepo. If that doesn't work for you (e.g., you are running Sherif in a non-interactive environment), you can use the `--select` (of `-s`) flag to automatically select the highest or lowest version of every dependency:\r\n\r\n```bash\r\n# Autofix and select the highest version for each dependency matching the `multiple-dependency-versions` rule\r\nsherif --fix --select highest\r\n```\r\n\r\n### No-install mode\r\n\r\nIf you don't want Sherif to run your packager manager's `install` command after running autofix, you can use the `--no-install` flag:\r\n\r\n```bash\r\n# Autofix without running the package manager's install command\r\nsherif --fix --no-install\r\n```\r\n\r\n## Exit code\r\n\r\nBy default, Sherif will exit with code `1` if any error issues are found. If you only have warning issues or no issues at all, Sherif will exit with code `0`. You can change this behavior to always exit with code `1` if any issues are found, including warnings, by using the `--fail-on-warnings` option.\r\n\r\n## Rules\r\n\r\nYou can ignore a specific rule by using `--ignore-rule ` (or `-r `):\r\n\r\n```bash\r\n# Ignore both rules\r\nsherif -r packages-without-package-json -r root-package-manager-field\r\n```\r\n\r\nYou can ignore all issues in a package by using `--ignore-package ` (or `-p `):\r\n\r\n```bash\r\n# Ignore all issues in the `@repo/tools` package\r\nsherif -p @repo/tools\r\n# Ignore all issues for packages inside `./integrations/*`\r\nsherif -p \"./integrations/*\"\r\n```\r\n\r\n#### `empty-dependencies` ❌\r\n\r\n`package.json` files should not have empty dependencies fields.\r\n\r\n#### `multiple-dependency-versions` ❌\r\n\r\nA given dependency should use the same version across the monorepo.\r\n\r\nYou can ignore this rule for a specific dependency and version or all versions of a dependency if it's expected in your monorepo by using `--ignore-dependency ` / `--ignore-dependency ` (or `-i ` / `-i `):\r\n\r\n```bash\r\n# Ignore only the specific dependency version mismatch\r\nsherif -i react@17.0.2 -i next@13.2.4\r\n\r\n# Ignore all versions mismatch of dependencies that start with @next/\r\nsherif -i @next/*\r\n\r\n# Completely ignore all versions mismatch of these dependencies\r\nsherif -i react -i next\r\n```\r\n\r\n#### `unsync-similar-dependencies` ❌\r\n\r\nSimilar dependencies in a given `package.json` should use the same version. For example, if you use both `react` and `react-dom` dependencies in the same `package.json`, this rule will enforce that they use the same version.\r\n\r\n\r\n\r\nList of detected similar dependencies\r\n\r\n- `react`, `react-dom`\r\n- `eslint-config-next`, `@next/eslint-plugin-next`, `@next/font` `@next/bundle-analyzer`, `@next/third-parties`, `@next/mdx`, `next`\r\n- `@trpc/client`, `@trpc/server`, `@trpc/next`, `@trpc/react-query`\r\n- `eslint-config-turbo`, `eslint-plugin-turbo`, `@turbo/gen`, `turbo-ignore`, `turbo`\r\n- `sb`, `storybook`, `@storybook/codemod`, `@storybook/cli`, `@storybook/channels`, `@storybook/addon-actions`, `@storybook/addon-links`, `@storybook/react`, `@storybook/react-native`, `@storybook/components`, `@storybook/addon-backgrounds`, `@storybook/addon-viewport`, `@storybook/angular`, `@storybook/addon-a11y`, `@storybook/addon-jest`, `@storybook/client-logger`, `@storybook/node-logger`, `@storybook/core`, `@storybook/addon-storysource`, `@storybook/html`, `@storybook/core-events`, `@storybook/svelte`, `@storybook/ember`, `@storybook/addon-ondevice-backgrounds`, `@storybook/addon-ondevice-notes`, `@storybook/preact`, `@storybook/theming`, `@storybook/router`, `@storybook/addon-docs`, `@storybook/addon-ondevice-actions`, `@storybook/source-loader`, `@storybook/preset-create-react-app`, `@storybook/web-components`, `@storybook/addon-essentials`, `@storybook/server`, `@storybook/addon-toolbars`, `@storybook/addon-controls`, `@storybook/core-common`, `@storybook/builder-webpack5`, `@storybook/core-server`, `@storybook/csf-tools`, `@storybook/addon-measure`, `@storybook/addon-outline`, `@storybook/addon-ondevice-controls`, `@storybook/instrumenter`, `@storybook/addon-interactions`, `@storybook/docs-tools`, `@storybook/builder-vite`, `@storybook/telemetry`, `@storybook/core-webpack`, `@storybook/preset-html-webpack`, `@storybook/preset-preact-webpack`, `@storybook/preset-svelte-webpack`, `@storybook/preset-react-webpack`, `@storybook/html-webpack5`, `@storybook/preact-webpack5`, `@storybook/svelte-webpack5`, `@storybook/web-components-webpack5`, `@storybook/preset-server-webpack`, `@storybook/react-webpack5`, `@storybook/server-webpack5`, `@storybook/addon-highlight`, `@storybook/blocks`, `@storybook/builder-manager`, `@storybook/react-vite`, `@storybook/svelte-vite`, `@storybook/web-components-vite`, `@storybook/nextjs`, `@storybook/types`, `@storybook/manager`, `@storybook/csf-plugin`, `@storybook/preview`, `@storybook/manager-api`, `@storybook/preview-api`, `@storybook/html-vite`, `@storybook/sveltekit`, `@storybook/preact-vite`, `@storybook/addon-mdx-gfm`, `@storybook/react-dom-shim`, `create-storybook`, `@storybook/addon-onboarding`, `@storybook/react-native-theming`, `@storybook/addon-themes`, `@storybook/test`, `@storybook/react-native-ui`, `@storybook/experimental-nextjs-vite`, `@storybook/experimental-addon-test`, `@storybook/react-native-web-vite`\r\n- `prisma`, `@prisma/client`, `@prisma/instrumentation`\r\n- `typescript-eslint`, `@typescript-eslint/eslint-plugin`, `@typescript-eslint/parser`\r\n- `@stylistic/eslint-plugin-js`, `@stylistic/eslint-plugin-ts`, `@stylistic/eslint-plugin-migrate`, `@stylistic/eslint-plugin`, `@stylistic/eslint-plugin-jsx`, `@stylistic/eslint-plugin-plus`\r\n- `playwright`, `@playwright/test`\r\n\r\n\r\n\r\n#### `non-existant-packages` ⚠️\r\n\r\nAll paths defined in the workspace (the root `package.json`' `workspaces` field or `pnpm-workspace.yaml`) should match at least one package.\r\n\r\n#### `packages-without-package-json` ⚠️\r\n\r\nAll packages matching the workspace (the root `package.json`' `workspaces` field or `pnpm-workspace.yaml`) should have a `package.json` file.\r\n\r\n#### `root-package-dependencies` ⚠️\r\n\r\nThe root `package.json` is private, so making a distinction between `dependencies` and `devDependencies` is useless - only use `devDependencies`.\r\n\r\n#### `root-package-manager-field` ❌\r\n\r\nThe root `package.json` should specify the package manager and version to use, either via the `packageManager` field or the `devEngines.packageManager` field. Useful for tools like corepack.\r\n\r\n#### `root-package-private-field` ❌\r\n\r\nThe root `package.json` should be private to prevent accidentaly publishing it to a registry.\r\n\r\n#### `types-in-dependencies` ❌\r\n\r\nPrivate packages shouldn't have `@types/*` in `dependencies`, since they don't need it at runtime. Move them to `devDependencies`.\r\n\r\n#### `unordered-dependencies` ❌\r\n\r\nDependencies should be ordered alphabetically to prevent complex diffs when installing a new dependency via a package manager.\r\n\r\n## Configuration\r\n\r\nWhen using many CLI arguments, it might be easier to move to the configuration format. In your root `package.json`, add a `sherif` field containing the same options as the CLI, but in camelCase. Default values are shown below:\r\n\r\n```jsonc\r\n{\r\n \"sherif\": {\r\n \"fix\": false,\r\n \"select\": \"highest\", // \"highest\" | \"lowest\"\r\n \"noInstall\": false,\r\n \"failOnWarnings\": false,\r\n \"ignoreDependency\": [], // string[]\r\n \"ignorePackage\": [], // string[]\r\n \"ignoreRule\": [] // string[]\r\n }\r\n}\r\n```\r\n\r\nWhen using both the configuration in the root `package.json` and CLI arguments, the CLI arguments will take precedence.\r\n\r\n## Credits\r\n\r\n- [dedubcheck](https://github.com/innovatrics/dedubcheck) that given me the idea for Sherif\r\n- [Manypkg](https://github.com/Thinkmill/manypkg) for some of their rules\r\n- [This article](https://blog.orhun.dev/packaging-rust-for-npm/) for the Rust releases on NPM\r\n\r\n## Sponsors\r\n\r\n\r\n\r\n## License\r\n\r\n[MIT](./LICENSE)\r\n","readmeFilename":"README.md"}
![\"\"](\"https://github.com/QuiiBz/sherif/blob/main/assets/logo.png\"){kind=logo}
\r\n