@depup/sharp-cli 5.2.0-depup.0 → 6.0.0-depup.0

package/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint and test
+        run: npm test

package/.prettierignore

@@ -0,0 +1,2 @@
+# Ignore artifacts.
+coverage

package/.prettierrc

@@ -0,0 +1 @@
+{}

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 6.0.0 (August 21, 2026)
+
+- Added [`--limitInputChannels`](https://sharp.pixelplumbing.com/api-constructor/) input option.
+- Added `--dry` option to process images without writing output files.
+- Added [`--exact`](https://sharp.pixelplumbing.com/api-output#webp) output option.
+- Added [`--keepGainMap`](https://sharp.pixelplumbing.com/api-output#keepgainmap) and [`--withGainMap`](https://sharp.pixelplumbing.com/api-output#withgainmap) output options.
+- Added `--print` option to print input and output metadata as JSON ([#48](https://github.com/vseventer/sharp-cli/issues/48)).
+- Added [`--tune`](https://sharp.pixelplumbing.com/api-output#avif) output option.
+- Added [`--withDensity`](https://sharp.pixelplumbing.com/api-output#withdensity) output option.
+- Added [`--margin`](https://sharp.pixelplumbing.com/api-resize#trim) option to the `trim` command.
+- Removed `jpg` output format alias; use `jpeg` instead.
+- Added graceful handling of partial failures during batch image processing ([#98](https://github.com/vseventer/sharp-cli/issues/98)).
+- Fixes bug where format options could cause errors. Consequently, removed `jpg` output format alias; use `jpeg` instead ([#92](https://github.com/vseventer/sharp-cli/issues/92)).
+- Drop `must` dependency in favor of Node.js native `assert`.
+- Internal refactor from CommonJS to ESM.
+- Tightened `yargs` option configuration to require values.
+- Updated `sharp` dependency to 0.35.3.
+- Updated dependencies.
+- Requires Node.js 20.10.
+
+## 5.3.0 (August 13, 2026)
+
+> Last release compatible with Node.js 18.
+
+- Added [`dilate`](https://sharp.pixelplumbing.com/api-operation#dilate) and [`erode`](https://sharp.pixelplumbing.com/api-operation#erode) operations.
+- Added [`--bigtiff`](https://sharp.pixelplumbing.com/api-output#tiff) output option.
+- Added [`--keepDuplicateFrames`](https://sharp.pixelplumbing.com/api-output#gif) output option.
+- Fixes bug where zero (`0`) number option values would be silently ignored (e.g. `--compressionLevel`, `--dither`, `--delay`, or `--effort`).
+- Drop `bubble-stream-error` dependency in favor of Node.js native `stream.pipeline`.
+- Updated `sharp` dependency to 0.34.5.
+- Updated dependencies, including replacing `standard` and `snazzy` with `prettier`.
+
 ## 5.2.0 (June 24, 2025)
 
 - Added [`--autoOrient`, `pdfBackground`](https://sharp.pixelplumbing.com/api-constructor/) input option.
@@ -156,16 +188,16 @@
 
 ## 1.8.0 (January 5, 2019)
 
-- Added `--background` option to [`resize`](https://sharp.dimens.io/api-resize#resize) and [`rotate`](https://sharp.dimens.io/api-operation#rotate) commands.
-- Added [`--fit` and `--position`](https://sharp.dimens.io/api-resize#resize) options.
-- Added [`--factorOut`](https://sharp.dimens.io/api-operation#gamma) option.
-- Added [`--pyramid`, `--tileWidth`, and `--tileHeight`](https://sharp.dimens.io/api-output#tiff) options.
-- Added [`extend`](https://sharp.dimens.io/api-resize#extend) command.
-- Added [`flatten`](https://sharp.dimens.io/api-operation#flatten) command.
-- Added [`recomb`](https://sharp.dimens.io/api-operation#recomb) command.
+- Added `--background` option to [`resize`](https://sharp.pixelplumbing.com/api-resize#resize) and [`rotate`](https://sharp.pixelplumbing.com/api-operation#rotate) commands.
+- Added [`--fit` and `--position`](https://sharp.pixelplumbing.com/api-resize#resize) options.
+- Added [`--factorOut`](https://sharp.pixelplumbing.com/api-operation#gamma) option.
+- Added [`--pyramid`, `--tileWidth`, and `--tileHeight`](https://sharp.pixelplumbing.com/api-output#tiff) options.
+- Added [`extend`](https://sharp.pixelplumbing.com/api-resize#extend) command.
+- Added [`flatten`](https://sharp.pixelplumbing.com/api-operation#flatten) command.
+- Added [`recomb`](https://sharp.pixelplumbing.com/api-operation#recomb) command.
 - Removed `--crop`, `--ignoreAspectRatio`, `--min`, and `--max` options.
 - Removed `background` command.
-- Renamed `--tolerance` option to [`--threshold`](https://sharp.dimens.io/api-resize#trim).
+- Renamed `--tolerance` option to [`--threshold`](https://sharp.pixelplumbing.com/api-resize#trim).
 - Updated `sharp` and `sinon` dependencies.
 
 ## 1.7.2 (December 4, 2018)

package/README.md

@@ -13,20 +13,17 @@ npm install @depup/sharp-cli
 
 | Field | Value |
 |-------|-------|
-| Original | [sharp-cli](https://www.npmjs.com/package/sharp-cli) @ 5.2.0 |
-| Processed | 2026-03-19 |
-| Smoke test | failed |
-| Deps updated | 5 |
+| Original | [sharp-cli](https://www.npmjs.com/package/sharp-cli) @ 6.0.0 |
+| Processed | 2026-08-23 |
+| Smoke test | passed |
+| Deps updated | 2 |
 
 ## Dependency Changes
 
 | Dependency | From | To |
 |------------|------|-----|
-| glob | 11.0.x | ^13.0.6 |
-| is-directory | 0.3.x | ^0.3.1 |
-| lodash.pick | 3.1.0 | ^4.4.0 |
-| sharp | 0.34.2 | ^0.34.5 |
-| yargs | ^17.6.2 | ^18.0.0 |
+| glob | 13.0.x | ^13.0.6 |
+| yargs | 17.7.x | ^18.1.0 |
 
 ---
 

package/bin/cli.js

@@ -22,11 +22,11 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-// Strict mode.
-'use strict'
-
 // Package modules.
-const { hideBin } = require('yargs/helpers')
+import { hideBin } from "yargs/helpers";
+
+// Local modules.
+import sharp from "../lib/index.js";
 
 // Run.
-require('../lib')(hideBin(process.argv))
+sharp(hideBin(process.argv));

package/changes.json

@@ -1,26 +1,14 @@
 {
   "bumped": {
     "glob": {
-      "from": "11.0.x",
+      "from": "13.0.x",
       "to": "^13.0.6"
     },
-    "is-directory": {
-      "from": "0.3.x",
-      "to": "^0.3.1"
-    },
-    "lodash.pick": {
-      "from": "3.1.0",
-      "to": "^4.4.0"
-    },
-    "sharp": {
-      "from": "0.34.2",
-      "to": "^0.34.5"
-    },
     "yargs": {
-      "from": "^17.6.2",
-      "to": "^18.0.0"
+      "from": "17.7.x",
+      "to": "^18.1.0"
     }
   },
-  "timestamp": "2026-03-19T03:28:37.858Z",
-  "totalUpdated": 5
+  "timestamp": "2026-08-23T00:28:58.451Z",
+  "totalUpdated": 2
 }

package/cmd/channel-manipulation/bandbool.js

@@ -23,39 +23,44 @@
 
 // @see https://sharp.pixelplumbing.com/api-channel#bandbool
 
-// Strict mode.
-'use strict'
-
 // Local modules.
-const constants = require('../../lib/constants')
-const queue = require('../../lib/queue')
+import constants from "../../lib/constants.js";
 
 // Configure.
 const positionals = {
   operator: {
     choices: constants.BOOL,
-    desc: 'Operator to perform that bitwise operation'
-  }
-}
+    desc: "Operator to perform that bitwise operation",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 bandbool and', 'The output will be a single channel image where each pixel `P = R & G & B`')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#bandbool')
-    .positional('operator', positionals.operator)
-}
+    .example(
+      "$0 bandbool and",
+      "The output will be a single channel image where each pixel `P = R & G & B`",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#bandbool",
+    )
+    .positional("operator", positionals.operator);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['bandbool', (sharp) => sharp.bandbool(args.operator)])
-}
+  return args["#queue"].push([
+    "bandbool",
+    (sharp) => sharp.bandbool(args.operator),
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'bandbool <operator>',
-  describe: 'Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image',
+export default {
+  command: "bandbool <operator>",
+  describe:
+    "Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/channel-manipulation/ensure-alpha.js

@@ -23,40 +23,45 @@
 
 // @see https://sharp.pixelplumbing.com/api-channel#ensurealpha
 
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
-
 // Configure.
 const positionals = {
   alpha: {
     default: 1,
-    desc: 'Alpha transparency level',
-    type: 'number'
-  }
-}
+    desc: "Alpha transparency level",
+    type: "number",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 ensureAlpha', 'The output will be a 4 channel image with a fully-opaque alpha channel')
-    .example('$0 ensureAlpha 0', 'The output will be a 4 channel image with a fully-transparent alpha channel')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#removealpha')
-    .positional('alpha', positionals.alpha)
-}
+    .example(
+      "$0 ensureAlpha",
+      "The output will be a 4 channel image with a fully-opaque alpha channel",
+    )
+    .example(
+      "$0 ensureAlpha 0",
+      "The output will be a 4 channel image with a fully-transparent alpha channel",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#removealpha",
+    )
+    .positional("alpha", positionals.alpha);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['ensureAlpha', (sharp) => sharp.ensureAlpha(args.alpha)])
-}
+  return args["#queue"].push([
+    "ensureAlpha",
+    (sharp) => sharp.ensureAlpha(args.alpha),
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'ensureAlpha [alpha]',
-  describe: 'Ensure the output image has an alpha transparency channel',
+export default {
+  command: "ensureAlpha [alpha]",
+  describe: "Ensure the output image has an alpha transparency channel",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/channel-manipulation/extract-channel.js

@@ -23,39 +23,43 @@
 
 // @see https://sharp.pixelplumbing.com/api-channel#extractchannel
 
-// Strict mode.
-'use strict'
-
 // Local modules.
-const constants = require('../../lib/constants')
-const queue = require('../../lib/queue')
+import constants from "../../lib/constants.js";
 
 // Configure.
 const positionals = {
   channel: {
     choices: constants.CHANNEL,
-    desc: 'The channel/band number to extract'
-  }
-}
+    desc: "The channel/band number to extract",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 extractChannel green', 'The output will contain the green channel of the input image')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#extractchannel')
-    .positional('channel', positionals.channel)
-}
+    .example(
+      "$0 extractChannel green",
+      "The output will contain the green channel of the input image",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#extractchannel",
+    )
+    .positional("channel", positionals.channel);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['extractChannel', (sharp) => sharp.extractChannel(args.channel)])
-}
+  return args["#queue"].push([
+    "extractChannel",
+    (sharp) => sharp.extractChannel(args.channel),
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'extractChannel <channel>',
-  describe: 'Extract a single channel from a multi-channel image',
+export default {
+  command: "extractChannel <channel>",
+  describe: "Extract a single channel from a multi-channel image",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/channel-manipulation/join-channel.js

@@ -23,38 +23,37 @@
 
 // @see https://sharp.pixelplumbing.com/api-channel#joinchannel
 
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
-
 // Configure.
 const positionals = {
   images: {
-    desc: 'One or more images',
+    desc: "One or more images",
     normalize: true,
-    type: 'array'
-  }
-}
+    type: "array",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#joinchannel')
-    .positional('images', positionals.images)
-}
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#joinchannel",
+    )
+    .positional("images", positionals.images);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['joinChannel', (sharp) => sharp.joinChannel(args.images)])
-}
+  return args["#queue"].push([
+    "joinChannel",
+    (sharp) => sharp.joinChannel(args.images),
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'joinChannel <images..>',
-  describe: 'Join one or more channels to the image',
+export default {
+  command: "joinChannel <images..>",
+  describe: "Join one or more channels to the image",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/channel-manipulation/remove-alpha.js

@@ -23,27 +23,24 @@
 
 // @see https://sharp.pixelplumbing.com/api-channel#removealpha
 
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
-
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 removeAlpha', 'The output will be without an alpha channel')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#removealpha')
-}
+    .example("$0 removeAlpha", "The output will be without an alpha channel")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-channel#removealpha",
+    );
+};
 
 // Command handler.
-const handler = (args) => queue.push(['removeAlpha', (sharp) => sharp.removeAlpha()])
+const handler = (args) =>
+  args["#queue"].push(["removeAlpha", (sharp) => sharp.removeAlpha()]);
 
 // Exports.
-module.exports = {
-  command: 'removeAlpha',
-  describe: 'Remove alpha channel, if any',
+export default {
+  command: "removeAlpha",
+  describe: "Remove alpha channel, if any",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/colour-manipulation/greyscale.js

@@ -23,28 +23,28 @@
 
 // @see https://sharp.pixelplumbing.com/api-colour#greyscale
 
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
-
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 greyscale', 'The output will contain three identical color channels')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#greyscale')
-}
+    .example(
+      "$0 greyscale",
+      "The output will contain three identical color channels",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#greyscale",
+    );
+};
 
 // Command handler.
-const handler = (args) => queue.push(['greyscale', (sharp) => sharp.greyscale()])
+const handler = (args) =>
+  args["#queue"].push(["greyscale", (sharp) => sharp.greyscale()]);
 
 // Exports.
-module.exports = {
-  command: 'greyscale',
-  aliases: 'grayscale',
-  describe: 'Convert to 8-bit greyscale; 256 shades of grey',
+export default {
+  command: "greyscale",
+  aliases: "grayscale",
+  describe: "Convert to 8-bit greyscale; 256 shades of grey",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/colour-manipulation/pipeline-colourspace.js

@@ -1,7 +1,7 @@
 /*!
  * The MIT License (MIT)
  *
- * Copyright (c) 2022 Mark van Seventer
+ * Copyright (c) 2019 Mark van Seventer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
  * this software and associated documentation files (the "Software"), to deal in
@@ -23,41 +23,45 @@
 
 // @see https://sharp.pixelplumbing.com/api-colour#tocolourspace
 
-// Strict mode.
-'use strict'
-
 // Local modules.
-const constants = require('../../lib/constants')
-const queue = require('../../lib/queue')
+import constants from "../../lib/constants.js";
 
 // Configure.
 const positionals = {
   colourspace: {
-    alias: 'colorspace',
+    alias: "colorspace",
     choices: constants.COLOURSPACE,
-    desc: 'Pipeline colourspace'
-  }
-}
+    desc: "Pipeline colourspace",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 pipelineColourspace rgb16', 'Run the pipeline in 16 bits per channel RGB')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#tocolourspace')
-    .positional('colourspacae', positionals.colourspace)
-}
+    .example(
+      "$0 pipelineColourspace rgb16",
+      "Run the pipeline in 16 bits per channel RGB",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#tocolourspace",
+    )
+    .positional("colourspacae", positionals.colourspace);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['pipelineColourspace', (sharp) => sharp.pipelineColourspace(args.colourspace)])
-}
+  return args["#queue"].push([
+    "pipelineColourspace",
+    (sharp) => sharp.pipelineColourspace(args.colourspace),
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'pipelineColourspace <colourspace>',
-  aliases: 'pipelineColorspace',
-  describe: 'Set the pipeline colourspace',
+export default {
+  command: "pipelineColourspace <colourspace>",
+  aliases: "pipelineColorspace",
+  describe: "Set the pipeline colourspace",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/colour-manipulation/tint.js

@@ -23,36 +23,34 @@
 
 // @see https://sharp.pixelplumbing.com/api-colour#tint
 
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
-
 // Configure.
 const positionals = {
   rgb: {
-    desc: 'Parsed by the color module to extract chroma values',
-    type: 'string'
-  }
-}
+    desc: "Parsed by the color module to extract chroma values",
+    type: "string",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
     .example('$0 tint "rgb(255, 240, 16)"')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#tint')
-    .positional('rgb', positionals.rgb)
-}
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#tint",
+    )
+    .positional("rgb", positionals.rgb);
+};
 
 // Command handler.
-const handler = (args) => queue.push(['tint', (sharp) => sharp.tint(args.rgb)])
+const handler = (args) =>
+  args["#queue"].push(["tint", (sharp) => sharp.tint(args.rgb)]);
 
 // Exports.
-module.exports = {
-  command: 'tint <rgb>',
-  describe: 'Tint the image using the provided chroma while preserving the image luminance',
+export default {
+  command: "tint <rgb>",
+  describe:
+    "Tint the image using the provided chroma while preserving the image luminance",
   builder,
-  handler
-}
+  handler,
+};