docs: Add instructions for pnpm compat (#19422)

nzakas · web-flow · commit 93c78a5c58ed · 2025-02-11T11:37:02.000-05:00
fixes #19421
diff --git a/README.md b/README.md
@@ -56,6 +56,17 @@ After that, you can run ESLint on any file or directory like this:
 npx eslint yourfile.js
 ```
 
+### pnpm Installation
+
+To use ESLint with pnpm, we recommend setting up a `.npmrc` file with at least the following settings:
+
+```text
+auto-install-peers=true
+node-linker=hoisted
+```
+
+This ensures that pnpm installs dependencies in a way that is more compatible with npm and is less likely to produce errors.
+
 ## Configuration
 
 You can configure rules in your `eslint.config.js` files as in this example:
diff --git a/docs/src/use/getting-started.md b/docs/src/use/getting-started.md
@@ -102,6 +102,17 @@ It is also possible to install ESLint globally, rather than locally, using `npm
 
 You can also manually set up ESLint in your project.
 
+::: important
+If you are using [pnpm](https://pnpm.io), be sure to create a `.npmrc` file with at least the following settings:
+
+```text
+auto-install-peers=true
+node-linker=hoisted
+```
+
+This ensures that pnpm installs dependencies in a way that is more compatible with npm and is less likely to produce errors.
+:::
+
 Before you begin, you must already have a `package.json` file. If you don't, make sure to run `npm init` or `yarn init` to create the file beforehand.
 
 1. Install the ESLint packages in your project:
