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

package/cmd/colour-manipulation/tocolourspace.js

@@ -23,41 +23,42 @@
 
 // @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: {
     choices: constants.COLOURSPACE,
-    default: 'srgb',
-    desc: 'The output colourspace'
-  }
-}
+    default: "srgb",
+    desc: "The output colourspace",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 toColourspace rgb16', 'Output 16 bits per pixel RGB')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#tocolourspace')
-    .positional('colourspace', positionals.colourspace)
-}
+    .example("$0 toColourspace rgb16", "Output 16 bits per pixel RGB")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-colour#tocolourspace",
+    )
+    .positional("colourspace", positionals.colourspace);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['toColourspace', (sharp) => sharp.toColourspace(args.colourspace)])
-}
+  return args["#queue"].push([
+    "toColourspace",
+    (sharp) => sharp.toColourspace(args.colourspace),
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'toColourspace <colourspace>',
-  aliases: 'toColorspace',
-  describe: 'Set the output colourspace',
+export default {
+  command: "toColourspace <colourspace>",
+  aliases: "toColorspace",
+  describe: "Set the output colourspace",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/compositing/composite.js

@@ -23,165 +23,196 @@
 
 // @see http://sharp.pixelplumbing.com/api-composite#composite
 
-// Strict mode.
-'use strict'
-
 // Local modules.
-const constants = require('../../lib/constants')
-const queue = require('../../lib/queue')
+import constants from "../../lib/constants.js";
 
 // Helpers.
-function getValueAt (arrayLike, index) {
+function getValueAt(arrayLike, index) {
   if (Array.isArray(arrayLike)) {
-    return arrayLike[Math.min(index, arrayLike.length - 1)]
+    return arrayLike[Math.min(index, arrayLike.length - 1)];
   }
-  return arrayLike
+  return arrayLike;
 }
 
-function hasOwnProperty (obj, prop) {
-  return obj != null && Object.prototype.hasOwnProperty.call(obj, prop)
+function hasOwnProperty(obj, prop) {
+  return obj != null && Object.prototype.hasOwnProperty.call(obj, prop);
 }
 
 // Configure.
 const positionals = {
   images: {
-    desc: 'Path to an image file',
+    desc: "Path to an image file",
     normalize: true,
-    type: 'string'
-  }
-}
+    type: "string",
+  },
+};
 
 const options = {
   blend: {
     choices: constants.BLEND,
-    defaultDescription: 'over',
-    desc: 'How to blend this image with the image below'
+    defaultDescription: "over",
+    desc: "How to blend this image with the image below",
   },
   create: {
-    desc: 'Describes a blank overlay to be created',
+    desc: "Describes a blank overlay to be created",
     hidden: true,
-    type: 'boolean'
+    type: "boolean",
   },
-  'create.background': {
-    desc: 'Background of the blank overlay to be created, parsed by the color module',
-    type: 'string'
+  "create.background": {
+    desc: "Background of the blank overlay to be created, parsed by the color module",
+    type: "string",
   },
-  'create.channels': {
+  "create.channels": {
     choices: [3, 4],
     default: 3,
-    desc: 'Number of channels of the blank overlay to be created'
+    desc: "Number of channels of the blank overlay to be created",
+    nargs: 1,
   },
-  'create.height': {
-    desc: 'Height of the blank overlay to be created',
-    type: 'number'
+  "create.height": {
+    desc: "Height of the blank overlay to be created",
+    nargs: 1,
+    type: "number",
   },
-  'create.width': {
-    desc: 'Width of the blank overlay to be created',
-    type: 'number'
+  "create.width": {
+    desc: "Width of the blank overlay to be created",
+    nargs: 1,
+    type: "number",
   },
   density: {
-    desc: 'Number representing the DPI for vector images',
+    desc: "Number representing the DPI for vector images",
     defaultDescription: 72,
-    type: 'number'
+    nargs: 1,
+    type: "number",
   },
   gravity: {
     choices: constants.GRAVITY,
-    defaultDescription: 'centre',
-    desc: 'Gravity at which to place the overlay'
+    defaultDescription: "centre",
+    desc: "Gravity at which to place the overlay",
   },
   left: {
-    desc: 'The pixel offset from the left edge',
-    implies: 'top',
-    type: 'number'
+    desc: "The pixel offset from the left edge",
+    implies: "top",
+    nargs: 1,
+    type: "number",
   },
   premultiplied: {
-    desc: 'Avoid premultiplying the image',
-    type: 'boolean'
+    desc: "Avoid premultiplying the image",
+    type: "boolean",
   },
   tile: {
-    desc: 'Repeat the overlay image across the entire image with the given gravity',
-    type: 'boolean'
+    desc: "Repeat the overlay image across the entire image with the given gravity",
+    type: "boolean",
   },
   top: {
-    desc: 'The pixel offset from the top edge',
-    implies: 'left',
-    type: 'number'
-  }
-}
+    desc: "The pixel offset from the top edge",
+    implies: "left",
+    nargs: 1,
+    type: "number",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
-  const optionNames = Object.keys(options)
+  const optionNames = Object.keys(options);
   return yargs
     .strict()
-    .example('$0 composite ./input.png --gravity southeast', 'The output will be the input composited with ./input.png with SE gravity')
-    .example('$0 composite ./layer1.png --gravity northwest ./layer2.png --gravity southeast', 'The output will be the input composited with ./layer1.png with NW gravity and ./layer2.png with SE gravity')
-    .example('$0 composite ./overlay.png --tile --blend saturate', 'The output will be the input composited with ./overlay.png saturated over the entire image')
-    .epilog('For more information on available options, please visit http://sharp.pixelplumbing.com/api-composite#composite')
-    .positional('images', positionals.images)
-    .check(argv => {
-      if ((!argv.images || argv.images.length === 0) && !hasOwnProperty(argv.create, 'width')) {
-        throw new Error('Expected at least one of images positional or create option')
+    .example(
+      "$0 composite ./input.png --gravity southeast",
+      "The output will be the input composited with ./input.png with SE gravity",
+    )
+    .example(
+      "$0 composite ./layer1.png --gravity northwest ./layer2.png --gravity southeast",
+      "The output will be the input composited with ./layer1.png with NW gravity and ./layer2.png with SE gravity",
+    )
+    .example(
+      "$0 composite ./overlay.png --tile --blend saturate",
+      "The output will be the input composited with ./overlay.png saturated over the entire image",
+    )
+    .epilog(
+      "For more information on available options, please visit http://sharp.pixelplumbing.com/api-composite#composite",
+    )
+    .positional("images", positionals.images)
+    .check((argv) => {
+      if (
+        (!argv.images || argv.images.length === 0) &&
+        !hasOwnProperty(argv.create, "width")
+      ) {
+        throw new Error(
+          "Expected at least one of images positional or create option",
+        );
       }
-      return true
+      return true;
     })
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  if ((hasOwnProperty(args.create, 'width') && !hasOwnProperty(args.create, 'height')) ||
-   (hasOwnProperty(args.create, 'height') && !hasOwnProperty(args.create, 'width'))) {
-    throw new Error('Expected both of create.width and create.height options')
+  if (
+    (hasOwnProperty(args.create, "width") &&
+      !hasOwnProperty(args.create, "height")) ||
+    (hasOwnProperty(args.create, "height") &&
+      !hasOwnProperty(args.create, "width"))
+  ) {
+    throw new Error("Expected both of create.width and create.height options");
   }
 
-  const inputs = []
-  if (hasOwnProperty(args.create, 'width')) {
-    const { channels, background, width, height } = args.create
-    const length = Math.max(width.length ?? 0, height.length ?? 0)
-    if (length > 0) { // Width or height (or both) is an array.
-      inputs.push(...Array.from({ length }, (_, idx) => idx).map(idx => ({
-        create: {
-          width: getValueAt(width, idx),
-          height: getValueAt(height, idx),
-          channels: getValueAt(channels, idx),
-          background: getValueAt(background, idx)
-        }
-      })))
-    } else { // Both width and height are numbers.
-      inputs.push({ create: args.create })
+  const inputs = [];
+  if (hasOwnProperty(args.create, "width")) {
+    const { channels, background, width, height } = args.create;
+    const length = Math.max(width.length ?? 0, height.length ?? 0);
+    if (length > 0) {
+      // Width or height (or both) is an array.
+      inputs.push(
+        ...Array.from({ length }, (_, idx) => idx).map((idx) => ({
+          create: {
+            width: getValueAt(width, idx),
+            height: getValueAt(height, idx),
+            channels: getValueAt(channels, idx),
+            background: getValueAt(background, idx),
+          },
+        })),
+      );
+    } else {
+      // Both width and height are numbers.
+      inputs.push({ create: args.create });
     }
   }
-  if (args.images) inputs.push(...args.images)
+  if (args.images) inputs.push(...args.images);
 
   // @see http://sharp.pixelplumbing.com/api-composite#composite
-  return queue.push(['composite', (sharp) => {
-    return sharp.composite(
-      inputs.map((input, idx) => ({
-        animated: args.animated,
-        autoOrient: args.autoOrient,
-        blend: getValueAt(args.blend, idx),
-        density: getValueAt(args.density, idx),
-        failOn: args.failOn,
-        gravity: getValueAt(args.gravity, idx),
-        ignoreIcc: getValueAt(args.ignoreIcc),
-        input,
-        left: getValueAt(args.left, idx),
-        limitInputPixels: args.limitInputPixels,
-        pdfBackground: args.pdfBackground,
-        premultiplied: getValueAt(args.premultiplied, idx),
-        tile: getValueAt(args.tile, idx),
-        top: getValueAt(args.top, idx)
-      }))
-    )
-  }])
-}
+  return args["#queue"].push([
+    "composite",
+    (sharp) => {
+      return sharp.composite(
+        inputs.map((input, idx) => ({
+          animated: args.animated,
+          autoOrient: args.autoOrient,
+          blend: getValueAt(args.blend, idx),
+          density: getValueAt(args.density, idx),
+          failOn: args.failOn,
+          gravity: getValueAt(args.gravity, idx),
+          ignoreIcc: getValueAt(args.ignoreIcc),
+          input,
+          left: getValueAt(args.left, idx),
+          limitInputChannels: args.limitInputChannels,
+          limitInputPixels: args.limitInputPixels,
+          pdfBackground: args.pdfBackground,
+          premultiplied: getValueAt(args.premultiplied, idx),
+          tile: getValueAt(args.tile, idx),
+          top: getValueAt(args.top, idx),
+        })),
+      );
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'composite [images..]',
-  describe: 'Composite image(s) over the processed (resized, extracted etc.) image',
+export default {
+  command: "composite [images..]",
+  describe:
+    "Composite image(s) over the processed (resized, extracted etc.) image",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/affine.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,88 +23,94 @@
 
 // @see https://sharp.pixelplumbing.com/api-operation#affine
 
-// Strict mode.
-'use strict'
-
-// Package modules.
-const pick = require('lodash.pick')
-
 // Local modules.
-const constants = require('../../lib/constants')
-const queue = require('../../lib/queue')
+import constants from "../../lib/constants.js";
+import { pick } from "../../lib/utils.js";
 
 // Configure.
 const placeholders = {
   matrix: {
-    desc: 'Affine transformation matrix',
+    desc: "Affine transformation matrix",
     nargs: 2 * 2,
-    type: 'number'
-  }
-}
+    type: "number",
+  },
+};
 
 const options = {
   background: {
-    defaultDescription: '#000000',
-    desc: 'String parsed by the color module to extract values for red, green, blue and alpha',
-    type: 'string'
+    defaultDescription: "#000000",
+    desc: "String parsed by the color module to extract values for red, green, blue and alpha",
+    type: "string",
   },
   idx: {
-    defaultDescription: '0',
-    desc: 'The input horizontal offset',
-    type: 'number'
+    defaultDescription: "0",
+    desc: "The input horizontal offset",
+    nargs: 1,
+    type: "number",
   },
   idy: {
-    defaultDescription: '0',
-    desc: 'The input vertical offset',
-    type: 'number'
+    defaultDescription: "0",
+    desc: "The input vertical offset",
+    nargs: 1,
+    type: "number",
   },
   odx: {
-    defaultDescription: '0',
-    desc: 'The output horizontal offset',
-    type: 'number'
+    defaultDescription: "0",
+    desc: "The output horizontal offset",
+    nargs: 1,
+    type: "number",
   },
   ody: {
-    defaultDescription: '0',
-    desc: 'The output vertical offset',
-    type: 'number'
+    defaultDescription: "0",
+    desc: "The output vertical offset",
+    nargs: 1,
+    type: "number",
   },
   interpolate: {
     choices: constants.INTERPOLATORS,
-    defaultDescription: 'bicubic',
-    desc: 'The input horizontal offset'
-  }
-}
-const optionNames = Object.keys(options)
+    defaultDescription: "bicubic",
+    desc: "The input horizontal offset",
+  },
+};
+const optionNames = Object.keys(options);
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 affine 1 0.3 0.1 0.7 --background white --interpolate nohalo')
-    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-operation#affine')
-    .check(argv => {
+    .example("$0 affine 1 0.3 0.1 0.7 --background white --interpolate nohalo")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#affine",
+    )
+    .check((argv) => {
       if (!(Array.isArray(argv.matrix) && argv.matrix.length === 4)) {
-        throw new Error('Expected matrix positional to have 4 values')
+        throw new Error("Expected matrix positional to have 4 values");
       }
-      return true
+      return true;
     })
-    .positional('matrix', placeholders.matrix)
+    .positional("matrix", placeholders.matrix)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['affine', (sharp) => {
-    const { matrix } = args
-    return sharp.affine([matrix.slice(0, 2), matrix.slice(2, 4)], pick(args, optionNames))
-  }])
-}
+  return args["#queue"].push([
+    "affine",
+    (sharp) => {
+      const { matrix } = args;
+      return sharp.affine(
+        [matrix.slice(0, 2), matrix.slice(2, 4)],
+        pick(args, optionNames),
+      );
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'affine <matrix..>',
-  describe: 'Perform an affine transform on an image',
+export default {
+  command: "affine <matrix..>",
+  describe: "Perform an affine transform on an image",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/blur.js

@@ -23,65 +23,68 @@
 
 // @see https://sharp.pixelplumbing.com/api-operation#blur
 
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
-
 // Configure.
 const positionals = {
   sigma: {
-    desc: 'The sigma of the Gaussian mask',
-    defaultDescription: '1 + radius / 2',
-    type: 'number'
-  }
-}
+    desc: "The sigma of the Gaussian mask",
+    defaultDescription: "1 + radius / 2",
+    type: "number",
+  },
+};
 
 const options = {
   minAmplitude: {
     defaultDescription: 0.2,
-    desc: 'A smaller value will generate a larger, more accurate mask',
-    type: 'number'
+    desc: "A smaller value will generate a larger, more accurate mask",
+    nargs: 1,
+    type: "number",
   },
   precision: {
-    choices: ['approximate', 'float', 'integer'],
-    defaultDescription: 'integer',
-    desc: 'How accurate the operation should be'
-  }
-}
+    choices: ["approximate", "float", "integer"],
+    defaultDescription: "integer",
+    desc: "How accurate the operation should be",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
-  const optionNames = Object.keys(options)
+  const optionNames = Object.keys(options);
   return yargs
     .strict()
-    .example('$0 blur', 'The output will be a fast 3x3 box blurred image')
-    .example('$0 blur 5', 'The output will be a slower but more accurate Gaussian blurred image')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#blur')
-    .positional('sigma', positionals.sigma)
+    .example("$0 blur", "The output will be a fast 3x3 box blurred image")
+    .example(
+      "$0 blur 5",
+      "The output will be a slower but more accurate Gaussian blurred image",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#blur",
+    )
+    .positional("sigma", positionals.sigma)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['blur', (sharp) => {
-    if (args.minAmplitude || args.precision) {
-      return sharp.blur({
-        minAmplitude: args.minAmplitude,
-        precision: args.precision,
-        sigma: args.sigma
-      })
-    }
-    return sharp.blur(args.sigma)
-  }])
-}
+  return args["#queue"].push([
+    "blur",
+    (sharp) => {
+      if (args.minAmplitude || args.precision) {
+        return sharp.blur({
+          minAmplitude: args.minAmplitude,
+          precision: args.precision,
+          sigma: args.sigma,
+        });
+      }
+      return sharp.blur(args.sigma);
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'blur [sigma]',
-  describe: 'Blur the image',
+export default {
+  command: "blur [sigma]",
+  describe: "Blur the image",
   builder,
-  handler
-}
+  handler,
+};