Docs: make use of optional dependencies even clearer

lovell · Dec 2, 2023 · 4d049ee · 4d049ee
1 parent c80e92f
commit 4d049ee
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/install.md b/docs/install.md
@@ -2,7 +2,7 @@
 
 Works with your choice of JavaScript package manager.
 
-Please ensure optional dependencies can be installed.
+> ⚠️  **Please ensure your package manager is configured to install optional dependencies**
 
 ```sh
 npm install sharp

diff --git a/lib/sharp.js b/lib/sharp.js
@@ -46,6 +46,8 @@ if (sharp) {
   // Common error messages
   if (prebuiltPlatforms.includes(runtimePlatform)) {
     const [os, cpu] = runtimePlatform.split('-');
+    help.push('- Ensure optional dependencies can be installed:');
+    help.push('    npm install --include=optional');
     help.push('- Add platform-specific dependencies:');
     help.push(`    npm install --os=${os} --cpu=${cpu} sharp`);
     help.push('  or');