feat: esm

.github/CONTRIBUTING.md

@@ -25,7 +25,7 @@ Please select the `main` branch as the destination for your Pull Request so your
 
 Please squash your changes into a single commit using a command like `git rebase -i upstream/main`.
 
-To test C++ changes, you can compile the module using `npm run build` and then run the tests using `npm test`.
+To test C++ changes, you can compile the module using `npm run build:dist && npm run build` and then run the tests using `npm test`.
 
 ## Submit a Pull Request with a new feature
 

.github/ISSUE_TEMPLATE/installation.md

@@ -1,6 +1,6 @@
 ---
 name: Installation
-about: Something went wrong during either 'npm install sharp' or 'require("sharp")'
+about: Something went wrong during either 'npm install sharp' or 'import "sharp"'
 labels: installation
 
 ---

.github/ISSUE_TEMPLATE/possible-bug.md

@@ -14,7 +14,7 @@ labels: triage
 <!-- Please place an [x] in the box to confirm. -->
 
 - [ ] Running `npm install sharp` completes without error.
-- [ ] Running `node -e "require('sharp')"` completes without error.
+- [ ] Running `node -e "import 'sharp'"` completes without error.
 
 If you cannot confirm both of these, please open an [installation issue](https://github.com/lovell/sharp/issues/new?labels=installation&template=installation.md) instead.
 

.github/workflows/ci.yml

@@ -170,7 +170,7 @@ jobs:
           architecture: ${{ matrix.nodejs_arch }}
       - uses: actions/checkout@v4
       - run: npm install
-      - run: npm run build
+      - run: npm run build:dist && npm run build
       - run: npm run test-unit
       - if: matrix.package
         run: npm run package-from-local-build
@@ -213,7 +213,7 @@ jobs:
         run: apk add build-base git python3 font-noto --update-cache
       - uses: actions/checkout@v4
       - run: npm install
-      - run: npm run build
+      - run: npm run build:dist && npm run build
       - run: npm run test-unit
       - if: matrix.package
         run: npm run package-from-local-build
@@ -276,6 +276,7 @@ jobs:
             curl --silent https://${{ matrix.nodejs_hostname }}/download/release/v${{ matrix.nodejs_version}}/node-v${{ matrix.nodejs_version}}-linux-${{ matrix.nodejs_arch }}.tar.xz | tar xJC /opt/nodejs --strip-components=1
             export PATH=$PATH:/opt/nodejs/bin
             npm install
+            npm run build:dist
             npm run build
             node --test test/unit/io.js
             npm run package-from-local-build
@@ -301,7 +302,7 @@ jobs:
         with:
           node-version: "20"
       - run: npm install
-      - run: emmake npm run build
+      - run: npm run build:dist && emmake npm run build
       - name: Verify emscripten versions match
         run: |
           EMSCRIPTEN_VERSION_LIBVIPS=$(node -p "require('@img/sharp-libvips-dev-wasm32/versions').emscripten")

.gitignore

@@ -17,3 +17,4 @@ package-lock.json
 .astro
 docs/dist
 release-notes.md
+dist

README.md

@@ -38,6 +38,10 @@ npm install sharp
 ```
 
 ```javascript
+// ESM
+import sharp from 'sharp';
+
+// CJS
 const sharp = require('sharp');
 ```
 

biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.3.4/schema.json",
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
   "vcs": {
     "enabled": true,
     "clientKind": "git",

docs/src/content/docs/api-constructor.md

@@ -229,8 +229,8 @@ readableStream.pipe(pipeline);
 ```js
 // Create a pipeline that will download an image, resize it and format it to different files
 // Using Promises to know when the pipeline is complete
-const fs = require("fs");
-const got = require("got");
+import fs from "node:fs";
+import got from "got";
 const sharpStream = sharp({ failOn: 'none' });
 
 const promises = [];

install/build.js

@@ -8,7 +8,7 @@ const {
   globalLibvipsVersion,
   log,
   spawnRebuild,
-} = require('../lib/libvips');
+} = require('../dist/libvips.cjs');
 
 log('Attempting to build from source via node-gyp');
 log('See https://sharp.pixelplumbing.com/install#building-from-source');

install/check.js

@@ -4,7 +4,7 @@
 */
 
 try {
-  const { useGlobalLibvips } = require('../lib/libvips');
+  const { useGlobalLibvips } = require('../dist/libvips.cjs');
   if (useGlobalLibvips() || process.env.npm_config_build_from_source) {
     process.exit(1);
   }

lib/channel.js → lib/channel.mjs

@@ -3,7 +3,7 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const is = require('./is');
+import is from './is.mjs';
 
 /**
  * Boolean operations for bandbool.
@@ -163,7 +163,7 @@ function bandbool (boolOp) {
  * @module Sharp
  * @private
  */
-module.exports = (Sharp) => {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
     // Public instance functions
     removeAlpha,

lib/colour.js → lib/colour.mjs

@@ -3,8 +3,8 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const color = require('@img/colour');
-const is = require('./is');
+import color from '@img/colour';
+import is from './is.mjs';
 
 /**
  * Colourspaces.
@@ -175,7 +175,7 @@ function _setBackgroundColourOption (key, value) {
  * @module Sharp
  * @private
  */
-module.exports = (Sharp) => {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
     // Public
     tint,

lib/composite.js → lib/composite.mjs

@@ -3,7 +3,7 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const is = require('./is');
+import is from './is.mjs';
 
 /**
  * Blend modes.
@@ -206,7 +206,7 @@ function composite (images) {
  * @module Sharp
  * @private
  */
-module.exports = (Sharp) => {
+export default (Sharp) => {
   Sharp.prototype.composite = composite;
   Sharp.blend = blend;
 };

lib/constructor.js → lib/constructor.mjs

@@ -3,11 +3,11 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const util = require('node:util');
-const stream = require('node:stream');
-const is = require('./is');
+import util from 'node:util';
+import stream from 'node:stream';
+import is from './is.mjs';
 
-require('./sharp');
+import './sharp.mjs';
 
 // Use NODE_DEBUG=sharp to enable libvips warnings
 const debuglog = util.debuglog('sharp');
@@ -426,8 +426,8 @@ Object.setPrototypeOf(Sharp, stream.Duplex);
  * @example
  * // Create a pipeline that will download an image, resize it and format it to different files
  * // Using Promises to know when the pipeline is complete
- * const fs = require("fs");
- * const got = require("got");
+ * import fs from "node:fs";
+ * import got from "got";
  * const sharpStream = sharp({ failOn: 'none' });
  *
  * const promises = [];
@@ -496,4 +496,4 @@ Object.assign(Sharp.prototype, { clone });
  * @module Sharp
  * @private
  */
-module.exports = Sharp;
+export default Sharp;

lib/index.mjs

@@ -0,0 +1,25 @@
+/*!
+  Copyright 2013 Lovell Fuller and others.
+  SPDX-License-Identifier: Apache-2.0
+*/
+
+import Sharp from './constructor.mjs';
+import input from './input.mjs';
+import resize from './resize.mjs';
+import composite from './composite.mjs';
+import operation from './operation.mjs';
+import colour from './colour.mjs';
+import channel from './channel.mjs';
+import output from './output.mjs';
+import utility from './utility.mjs';
+
+input(Sharp);
+resize(Sharp);
+composite(Sharp);
+operation(Sharp);
+colour(Sharp);
+channel(Sharp);
+output(Sharp);
+utility(Sharp);
+
+export default Sharp;

lib/input.js → lib/input.mjs

@@ -3,8 +3,8 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const is = require('./is');
-const sharp = require('./sharp');
+import is from './is.mjs';
+import sharp from './sharp.mjs';
 
 /**
  * Justification alignment
@@ -792,7 +792,7 @@ function stats (callback) {
  * @module Sharp
  * @private
  */
-module.exports = (Sharp) => {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
     // Private
     _inputOptionsFromObject,

lib/is.js → lib/is.mjs

@@ -124,7 +124,7 @@ const nativeError = (native, context) => {
   return context;
 };
 
-module.exports = {
+export default {
   defined,
   object,
   plainObject,

lib/libvips.js → lib/libvips.mjs

@@ -3,14 +3,16 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const { spawnSync } = require('node:child_process');
-const { createHash } = require('node:crypto');
-const semverCoerce = require('semver/functions/coerce');
-const semverGreaterThanOrEqualTo = require('semver/functions/gte');
-const semverSatisfies = require('semver/functions/satisfies');
-const detectLibc = require('detect-libc');
+import { spawnSync } from 'node:child_process';
+import { createHash } from 'node:crypto';
+import fs from 'node:fs';
+import semverCoerce from 'semver/functions/coerce';
+import semverGreaterThanOrEqualTo from 'semver/functions/gte';
+import semverSatisfies from 'semver/functions/satisfies';
+import detectLibc from 'detect-libc';
 
-const { config, engines, optionalDependencies } = require('../package.json');
+// Cannot use an import because sometimes it can need the attr or with keyword
+const { config, engines, optionalDependencies } = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url), 'utf-8'));
 
 /* node:coverage ignore next */
 const minimumLibvipsVersionLabelled = process.env.npm_package_config_libvips || config.libvips;
@@ -189,7 +191,7 @@ const useGlobalLibvips = (logger) => {
   return !!globalVipsVersion && semverGreaterThanOrEqualTo(globalVipsVersion, minimumLibvipsVersion);
 };
 
-module.exports = {
+export default {
   minimumLibvipsVersion,
   prebuiltPlatforms,
   buildPlatformArch,

lib/operation.js → lib/operation.mjs

@@ -3,7 +3,7 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const is = require('./is');
+import is from './is.mjs';
 
 /**
  * How accurate an operation should be.
@@ -987,7 +987,7 @@ function modulate (options) {
  * @module Sharp
  * @private
  */
-module.exports = (Sharp) => {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
     autoOrient,
     rotate,

lib/output.js → lib/output.mjs

@@ -3,9 +3,9 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const path = require('node:path');
-const is = require('./is');
-const sharp = require('./sharp');
+import path from 'node:path';
+import is from './is.mjs';
+import sharp from './sharp.mjs';
 
 const formats = new Map([
   ['heic', 'heif'],
@@ -1630,7 +1630,7 @@ function _pipeline (callback, stack) {
  * @module Sharp
  * @private
  */
-module.exports = (Sharp) => {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
     // Public
     toFile,

lib/resize.js → lib/resize.mjs

@@ -3,7 +3,7 @@
   SPDX-License-Identifier: Apache-2.0
 */
 
-const is = require('./is');
+import is from './is.mjs';
 
 /**
  * Weighting to apply when using contain/cover fit.
@@ -579,7 +579,7 @@ function trim (options) {
  * @module Sharp
  * @private
  */
-module.exports = (Sharp) => {
+export default (Sharp) => {
   Object.assign(Sharp.prototype, {
     resize,
     extend,