Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2026-02-04 05:36:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove install script, building from source is now opt-in

Browse Source 
The vast majority of people don't need this. Package managers
are (correctly) starting to block install scripts by default,
so this change should reduce install-time warnings.
This commit is contained in:
Lovell Fuller
2025-12-21 12:35:18 +00:00
parent 1a2c1c8833
commit e1bad5470e
7 changed files with 17 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/src/content/docs/changelog/v0.35.0.md
View File

@@ -3,9 +3,12 @@ title: v0.35.0 - TBC
slug: changelog/v0.35.0
---
* Upgrade to libvips v8.18.0 for upstream bug fixes.
* Breaking: Drop support for Node.js 18, now requires Node.js >= 20.9.0.
* Drop support for Node.js 18, now requires Node.js >= 20.9.0.
* Breaking: Remove `install` script from `package.json` file.
Compiling from source is now opt-in via the `build` script.
* Upgrade to libvips v8.18.0 for upstream bug fixes.
* Add `withGainMap` to process HDR JPEG images with embedded gain maps.
[#4314](https://github.com/lovell/sharp/issues/4314)

31
docs/src/content/docs/install.md
View File

@@ -20,10 +20,6 @@ npm install sharp
pnpm add sharp
```
When using `pnpm`, add `sharp` to
[ignoredBuiltDependencies](https://pnpm.io/settings#ignoredbuiltdependencies)
to silence warnings.
```sh frame="none"
yarn add sharp
```
@@ -112,13 +108,13 @@ and on macOS when running Node.js under Rosetta.
## Building from source
This module will be compiled from source when:
```sh frame="none"
npm install sharp
npm explore sharp -- npm run build
```
* a globally-installed libvips is detected, or
* using `npm explore sharp -- npm run build`, or
* using the deprecated `npm run --build-from-source` at `npm install` time.
The logic to detect a globally-installed libvips can be skipped by setting the
The build process will search for a globally-installed libvips.
This detection logic can be skipped by setting the
`SHARP_IGNORE_GLOBAL_LIBVIPS` (never try to use it) or
`SHARP_FORCE_GLOBAL_LIBVIPS` (always try to use it, even when missing or outdated)
environment variables.
@@ -129,21 +125,12 @@ Building from source requires:
* [node-addon-api](https://www.npmjs.com/package/node-addon-api) version 7+
* [node-gyp](https://github.com/nodejs/node-gyp#installation) version 9+ and its dependencies
There is an install-time check for these dependencies.
If `node-addon-api` or `node-gyp` cannot be found, try adding them via:
```sh frame="none"
npm install --save node-addon-api node-gyp
```
When using `pnpm`, you may need to add `sharp` to
[onlyBuiltDependencies](https://pnpm.io/settings#onlybuiltdependencies)
to ensure the installation script can be run.
For cross-compiling, the `--platform`, `--arch` and `--libc` npm flags
(or the `npm_config_platform`, `npm_config_arch` and `npm_config_libc` environment variables)
can be used to configure the target environment.
## WebAssembly
Experimental support is provided for runtime environments that provide
@@ -166,10 +153,8 @@ as well as the additional [building from source](#building-from-source) dependen
```sh frame="none"
pkg install -y pkgconf vips
```
```sh frame="none"
cd /usr/ports/graphics/vips/ && make install clean
npm install sharp
npm explore sharp -- npm run build
```
## Linux memory allocator