From c419d7ec88c142c6b3f602cdc842729cbc867e84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Thu, 15 May 2025 12:45:28 +0200 Subject: [PATCH] docs(ideal-image): Add warning for pnpm 10+ and `sharp` install script (#11180) --- website/docs/api/plugins/plugin-ideal-image.mdx | 14 ++++++++++++++ .../api/plugins/plugin-ideal-image.mdx | 12 ++++++++++++ 2 files changed, 26 insertions(+) diff --git a/website/docs/api/plugins/plugin-ideal-image.mdx b/website/docs/api/plugins/plugin-ideal-image.mdx index 16f3a4d987..c6793466db 100644 --- a/website/docs/api/plugins/plugin-ideal-image.mdx +++ b/website/docs/api/plugins/plugin-ideal-image.mdx @@ -45,6 +45,20 @@ This plugin registers a [Webpack loader](https://webpack.js.org/loaders/) that c ::: +:::warning For pnpm users + +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: + +```json title="package.json" +{ + "pnpm": { + "onlyBuiltDependencies": ["fsevents"] + } +} +``` + +::: + ## Configuration {#configuration} Accepted fields: diff --git a/website/versioned_docs/version-3.7.0/api/plugins/plugin-ideal-image.mdx b/website/versioned_docs/version-3.7.0/api/plugins/plugin-ideal-image.mdx index 16f3a4d987..bbc5442861 100644 --- a/website/versioned_docs/version-3.7.0/api/plugins/plugin-ideal-image.mdx +++ b/website/versioned_docs/version-3.7.0/api/plugins/plugin-ideal-image.mdx @@ -45,6 +45,18 @@ This plugin registers a [Webpack loader](https://webpack.js.org/loaders/) that c ::: +:::warning For pnpm users + +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: + +```json title="package.json" +{ + "pnpm": { + "onlyBuiltDependencies": ["fsevents"] + } +} +``` + ## Configuration {#configuration} Accepted fields: