Minimise use of engines property to improve yarn v1 support

lovell · Aug 13, 2024 · 998c9b2 · 998c9b2
1 parent 82cebc3
commit 998c9b2
Show file tree

Hide file tree

Showing 16 changed files with 34 additions and 52 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -15,6 +15,9 @@ Requires libvips v8.15.3
   [#4111](https://github.com/lovell/sharp/pull/4111)
   [@project0](https://github.com/project0)
 
+* Minimise use of `engines` property to improve yarn v1 support.
+  [#4130](https://github.com/lovell/sharp/issues/4130)
+
 * Ensure `sharp.format.heif` includes only AVIF when using prebuilt binaries.
   [#4132](https://github.com/lovell/sharp/issues/4132)
 

diff --git a/docs/install.md b/docs/install.md
@@ -92,7 +92,7 @@ Use the [supportedArchitectures](https://pnpm.io/package_json#pnpmsupportedarchi
 ## Custom libvips
 
 To use a custom, globally-installed version of libvips instead of the provided binaries,
-make sure it is at least the version listed under `engines.libvips` in the `package.json` file
+make sure it is at least the version listed under `config.libvips` in the `package.json` file
 and that it can be located using `pkg-config --modversion vips-cpp`.
 
 For help compiling libvips and its dependencies, please see

diff --git a/lib/libvips.js b/lib/libvips.js
@@ -10,10 +10,10 @@ const semverGreaterThanOrEqualTo = require('semver/functions/gte');
 const semverSatisfies = require('semver/functions/satisfies');
 const detectLibc = require('detect-libc');
 
-const { engines, optionalDependencies } = require('../package.json');
+const { config, engines, optionalDependencies } = require('../package.json');
 
 const minimumLibvipsVersionLabelled = process.env.npm_package_config_libvips || /* istanbul ignore next */
-  engines.libvips;
+  config.libvips;
 const minimumLibvipsVersion = semverCoerce(minimumLibvipsVersionLabelled).version;
 
 const prebuiltPlatforms = [

diff --git a/lib/sharp.js b/lib/sharp.js
@@ -73,9 +73,9 @@ if (sharp) {
   }
   if (isLinux && /(symbol not found|CXXABI_)/i.test(messages)) {
     try {
-      const { engines } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
+      const { config } = require(`@img/sharp-libvips-${runtimePlatform}/package`);
       const libcFound = `${familySync()} ${versionSync()}`;
-      const libcRequires = `${engines.musl ? 'musl' : 'glibc'} ${engines.musl || engines.glibc}`;
+      const libcRequires = `${config.musl ? 'musl' : 'glibc'} ${config.musl || config.glibc}`;
       help.push(
         '- Update your OS:',
         `    Found ${libcFound}`,

diff --git a/npm/darwin-arm64/package.json b/npm/darwin-arm64/package.json
@@ -29,11 +29,7 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
-    "glibc": ">=2.26"
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
   },
   "os": [
     "darwin"

diff --git a/npm/darwin-x64/package.json b/npm/darwin-x64/package.json
@@ -29,11 +29,7 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
-    "glibc": ">=2.26"
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
   },
   "os": [
     "darwin"

diff --git a/npm/linux-arm/package.json b/npm/linux-arm/package.json
@@ -29,10 +29,9 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
     "glibc": ">=2.28"
   },
   "os": [

diff --git a/npm/linux-arm64/package.json b/npm/linux-arm64/package.json
@@ -29,10 +29,9 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
     "glibc": ">=2.26"
   },
   "os": [

diff --git a/npm/linux-s390x/package.json b/npm/linux-s390x/package.json
@@ -29,10 +29,9 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
     "glibc": ">=2.31"
   },
   "os": [

diff --git a/npm/linux-x64/package.json b/npm/linux-x64/package.json
@@ -29,10 +29,9 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
     "glibc": ">=2.26"
   },
   "os": [

diff --git a/npm/linuxmusl-arm64/package.json b/npm/linuxmusl-arm64/package.json
@@ -29,10 +29,9 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
     "musl": ">=1.2.2"
   },
   "os": [

diff --git a/npm/linuxmusl-x64/package.json b/npm/linuxmusl-x64/package.json
@@ -29,10 +29,9 @@
     "./package": "./package.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0",
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
     "musl": ">=1.2.2"
   },
   "os": [

diff --git a/npm/wasm32/package.json b/npm/wasm32/package.json
@@ -28,10 +28,7 @@
     "./versions": "./versions.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0"
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
   },
   "dependencies": {
     "@emnapi/runtime": "^1.2.0"

diff --git a/npm/win32-ia32/package.json b/npm/win32-ia32/package.json
@@ -28,10 +28,7 @@
     "./versions": "./versions.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0"
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
   },
   "os": [
     "win32"

diff --git a/npm/win32-x64/package.json b/npm/win32-x64/package.json
@@ -28,10 +28,7 @@
     "./versions": "./versions.json"
   },
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
-    "npm": ">=9.6.5",
-    "yarn": ">=3.2.0",
-    "pnpm": ">=7.1.0"
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
   },
   "os": [
     "win32"

diff --git a/package.json b/package.json
@@ -187,7 +187,9 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": "^18.17.0 || ^20.3.0 || >=21.0.0",
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "config": {
     "libvips": ">=8.15.3"
   },
   "funding": {