Skip to content

Commit c419d7e

Browse files
authored
docs(ideal-image): Add warning for pnpm 10+ and sharp install script (facebook#11180)
1 parent f3e3f54 commit c419d7e

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

website/docs/api/plugins/plugin-ideal-image.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,20 @@ This plugin registers a [Webpack loader](https://webpack.js.org/loaders/) that c
4545

4646
:::
4747

48+
:::warning For pnpm users
49+
50+
Starting with [pnpm 10](https://github.com/pnpm/pnpm/releases/tag/v10.0.0), running `pnpm install` won't run dependency install scripts by default. You'll need additional pnpm configuration ([issue](https://github.com/lovell/sharp/issues/4343)) for our `sharp` image resizing dependency to install correctly, such as:
51+
52+
```json title="package.json"
53+
{
54+
"pnpm": {
55+
"onlyBuiltDependencies": ["fsevents"]
56+
}
57+
}
58+
```
59+
60+
:::
61+
4862
## Configuration {#configuration}
4963

5064
Accepted fields:

website/versioned_docs/version-3.7.0/api/plugins/plugin-ideal-image.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,18 @@ This plugin registers a [Webpack loader](https://webpack.js.org/loaders/) that c
4545

4646
:::
4747

48+
:::warning For pnpm users
49+
50+
Starting with [pnpm 10](https://github.com/pnpm/pnpm/releases/tag/v10.0.0), running `pnpm install` won't run dependency install scripts by default. You'll need additional pnpm configuration ([issue](https://github.com/lovell/sharp/issues/4343)) for our `sharp` image resizing dependency to install correctly, such as:
51+
52+
```json title="package.json"
53+
{
54+
"pnpm": {
55+
"onlyBuiltDependencies": ["fsevents"]
56+
}
57+
}
58+
```
59+
4860
## Configuration {#configuration}
4961

5062
Accepted fields:

0 commit comments

Comments
 (0)