Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 10:30:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: make use of optional dependencies even clearer

Browse Source
This commit is contained in:
Lovell Fuller 2023-12-02 09:20:42 +00:00
parent c80e92fa16
commit 4d049ee8f5
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/install.md
View File

@ -2,7 +2,7 @@
Works with your choice of JavaScript package manager. 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 ```sh
npm install sharp npm install sharp

2
lib/sharp.js
View File

@ -46,6 +46,8 @@ if (sharp) {
// Common error messages // Common error messages
if (prebuiltPlatforms.includes(runtimePlatform)) { if (prebuiltPlatforms.includes(runtimePlatform)) {
const [os, cpu] = runtimePlatform.split('-'); 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('- Add platform-specific dependencies:');
help.push(` npm install --os=${os} --cpu=${cpu} sharp`); help.push(` npm install --os=${os} --cpu=${cpu} sharp`);
help.push(' or'); help.push(' or');