mirror of
https://github.com/lovell/sharp.git
synced 2025-07-09 10:30:15 +02:00
9e3b021b1a
The official Node.js Snap as distributed via the Ubuntu Snap Store does not provide support for native modules. Sometimes, if the version of the core matches the version of the underlying OS, then it will appear to work. There are quite a few open issues relating to this in the nodejs/snap repo.
110 lines
3.4 KiB
JavaScript
110 lines
3.4 KiB
JavaScript
// Copyright 2013 Lovell Fuller and others.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
'use strict';
|
|
|
|
// Inspects the runtime environment and exports the relevant sharp.node binary
|
|
|
|
const { familySync, versionSync } = require('detect-libc');
|
|
|
|
const { runtimePlatformArch, prebuiltPlatforms, minimumLibvipsVersion } = require('./libvips');
|
|
const runtimePlatform = runtimePlatformArch();
|
|
|
|
const paths = [
|
|
`../src/build/Release/sharp-${runtimePlatform}.node`,
|
|
'../src/build/Release/sharp-wasm32.node',
|
|
`@img/sharp-${runtimePlatform}/sharp.node`,
|
|
'@img/sharp-wasm32/sharp.node'
|
|
];
|
|
|
|
let sharp;
|
|
const errors = [];
|
|
for (const path of paths) {
|
|
try {
|
|
sharp = require(path);
|
|
break;
|
|
} catch (err) {
|
|
/* istanbul ignore next */
|
|
errors.push(err);
|
|
}
|
|
}
|
|
|
|
/* istanbul ignore next */
|
|
if (sharp) {
|
|
module.exports = sharp;
|
|
} else {
|
|
const [isLinux, isMacOs, isWindows] = ['linux', 'darwin', 'win32'].map(os => runtimePlatform.startsWith(os));
|
|
|
|
const help = [`Could not load the "sharp" module using the ${runtimePlatform} runtime`];
|
|
errors.forEach(err => {
|
|
if (err.code !== 'MODULE_NOT_FOUND') {
|
|
help.push(`${err.code}: ${err.message}`);
|
|
}
|
|
});
|
|
const messages = errors.map(err => err.message).join(' ');
|
|
help.push('Possible solutions:');
|
|
// Common error messages
|
|
if (prebuiltPlatforms.includes(runtimePlatform)) {
|
|
const [os, cpu] = runtimePlatform.split('-');
|
|
help.push(
|
|
'- Ensure optional dependencies can be installed:',
|
|
' npm install --include=optional sharp',
|
|
' or',
|
|
' yarn add sharp --ignore-engines',
|
|
'- Add platform-specific dependencies:',
|
|
` npm install --os=${os} --cpu=${cpu} sharp`,
|
|
' or',
|
|
` npm install --force @img/sharp-${runtimePlatform}`
|
|
);
|
|
} else {
|
|
help.push(
|
|
`- Manually install libvips >= ${minimumLibvipsVersion}`,
|
|
'- Add experimental WebAssembly-based dependencies:',
|
|
' npm install --cpu=wasm32 sharp',
|
|
' or',
|
|
' npm install --force @img/sharp-wasm32'
|
|
);
|
|
}
|
|
if (isLinux && /symbol not found/i.test(messages)) {
|
|
try {
|
|
const { engines } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
|
|
const libcFound = `${familySync()} ${versionSync()}`;
|
|
const libcRequires = `${engines.musl ? 'musl' : 'glibc'} ${engines.musl || engines.glibc}`;
|
|
help.push(
|
|
'- Update your OS:',
|
|
` Found ${libcFound}`,
|
|
` Requires ${libcRequires}`
|
|
);
|
|
} catch (errEngines) {}
|
|
}
|
|
if (isLinux && /\/snap\/core[0-9]{2}/.test(messages)) {
|
|
help.push(
|
|
'- Remove the Node.js Snap, which does not support native modules',
|
|
' snap remove node'
|
|
);
|
|
}
|
|
if (isMacOs && /Incompatible library version/.test(messages)) {
|
|
help.push(
|
|
'- Update Homebrew:',
|
|
' brew update && brew upgrade vips'
|
|
);
|
|
}
|
|
if (errors.some(err => err.code === 'ERR_DLOPEN_DISABLED')) {
|
|
help.push('- Run Node.js without using the --no-addons flag');
|
|
}
|
|
// Link to installation docs
|
|
if (isWindows && /The specified procedure could not be found/.test(messages)) {
|
|
help.push(
|
|
'- Using the canvas package on Windows?',
|
|
' See https://sharp.pixelplumbing.com/install#canvas-and-windows',
|
|
'- Check for outdated versions of sharp in the dependency tree:',
|
|
' npm ls sharp'
|
|
);
|
|
}
|
|
help.push(
|
|
'- Consult the installation documentation:',
|
|
' https://sharp.pixelplumbing.com/install'
|
|
);
|
|
throw new Error(help.join('\n'));
|
|
}
|