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

package/cmd/operations/sharpen.js

@@ -23,87 +23,91 @@
 
 // @see https://sharp.pixelplumbing.com/api-operation#sharpen
 
-// Strict mode.
-'use strict'
-
-// Package modules.
-const pick = require('lodash.pick')
-
 // Local modules.
-const queue = require('../../lib/queue')
+import { pick } from "../../lib/utils.js";
 
 // 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 = {
   m1: {
-    alias: 'flat',
+    alias: "flat",
     desc: 'The level of sharpening to apply to "flat" areas',
     defaultDescription: 1.0,
-    type: 'number'
+    nargs: 1,
+    type: "number",
   },
   m2: {
-    alias: 'jagged',
+    alias: "jagged",
     desc: 'The level of sharpening to apply to "jagged" areas',
     defaultDescription: 2.0,
-    type: 'number'
+    nargs: 1,
+    type: "number",
   },
   x1: {
     desc: 'The threshold between "flat" and "jagged" areas',
     defaultDescription: 2.0,
-    type: 'number'
+    nargs: 1,
+    type: "number",
   },
   y2: {
-    desc: 'The maximum amount of brightening',
+    desc: "The maximum amount of brightening",
     defaultDescription: 10.0,
-    type: 'number'
+    nargs: 1,
+    type: "number",
   },
   y3: {
-    desc: 'The maximum amount of darkening',
+    desc: "The maximum amount of darkening",
     defaultDescription: 20.0,
-    type: 'number'
-  }
-}
-const optionNames = Object.keys(options)
+    nargs: 1,
+    type: "number",
+  },
+};
+const optionNames = Object.keys(options);
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 sharpen')
-    .example('$0 sharpen 2')
-    .example('$0 sharpen 2 --m1 0 --m2 3 --x1 3 --y2 15 --y3 15')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#sharpen')
-    .positional('sigma', positionals.sigma)
+    .example("$0 sharpen")
+    .example("$0 sharpen 2")
+    .example("$0 sharpen 2 --m1 0 --m2 3 --x1 3 --y2 15 --y3 15")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#sharpen",
+    )
+    .positional("sigma", positionals.sigma)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
   const options = {
     ...pick(args, Object.keys(positionals)),
-    ...pick(args, optionNames)
-  }
+    ...pick(args, optionNames),
+  };
 
-  return queue.push(['sharpen', (sharp) => {
-    if (Object.keys(options).length === 0) {
-      return sharp.sharpen()
-    }
-    return sharp.sharpen(options)
-  }])
-}
+  return args["#queue"].push([
+    "sharpen",
+    (sharp) => {
+      if (Object.keys(options).length === 0) {
+        return sharp.sharpen();
+      }
+      return sharp.sharpen(options);
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'sharpen [sigma]',
-  describe: 'Sharpen the image',
+export default {
+  command: "sharpen [sigma]",
+  describe: "Sharpen the image",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/threshold.js

@@ -23,51 +23,51 @@
 
 // @see https://sharp.pixelplumbing.com/api-operation#threshold
 
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
-
 // Configure.
 const positionals = {
   value: {
-    desc: 'A value in the range 0-255 representing the level at which the threshold will be applied',
+    desc: "A value in the range 0-255 representing the level at which the threshold will be applied",
     defaultDescription: 128,
-    type: 'number'
-  }
-}
+    type: "number",
+  },
+};
 
 const options = {
   greyscale: {
-    alias: 'grayscale',
-    desc: 'Convert to single channel greyscale',
-    type: 'boolean'
-  }
-}
+    alias: "grayscale",
+    desc: "Convert to single channel greyscale",
+    type: "boolean",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
-  const optionNames = Object.keys(options)
+  const optionNames = Object.keys(options);
   return yargs
     .strict()
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#threshold')
-    .positional('value', positionals.value)
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#threshold",
+    )
+    .positional("value", positionals.value)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['threshold', (sharp) => {
-    return sharp.threshold(args.value, { greyscale: args.greyscale })
-  }])
-}
+  return args["#queue"].push([
+    "threshold",
+    (sharp) => {
+      return sharp.threshold(args.value, { greyscale: args.greyscale });
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'threshold [value]',
-  describe: 'Any pixel value greather than or equal to the threshold value will be set to 255, otherwise it will be set to 0',
+export default {
+  command: "threshold [value]",
+  describe:
+    "Any pixel value greater than or equal to the threshold value will be set to 255, otherwise it will be set to 0",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/unflatten.js

@@ -21,29 +21,27 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-// @see https://sharp.dimens.io/api-operation#unflatten
-
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
+// @see https://sharp.pixelplumbing.com/api-operation#unflatten
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 unflatten')
-    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-operation#unflatten')
-}
+    .example("$0 unflatten")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#unflatten",
+    );
+};
 
 // Command handler.
-const handler = (args) => queue.push(['unflatten', (sharp) => sharp.unflatten()])
+const handler = (args) =>
+  args["#queue"].push(["unflatten", (sharp) => sharp.unflatten()]);
 
 // Exports.
-module.exports = {
-  command: 'unflatten',
-  describe: 'Ensure the image has an alpha channel with all white pixel values made fully transparent',
+export default {
+  command: "unflatten",
+  describe:
+    "Ensure the image has an alpha channel with all white pixel values made fully transparent",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/output.js

@@ -23,103 +23,108 @@
 
 // @see https://sharp.pixelplumbing.com/api-output#tile
 
-// 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 positionals = {
   size: {
-    desc: 'Tile size in pixels',
+    desc: "Tile size in pixels",
     defaultDescription: 256,
-    type: 'number'
-  }
-}
+    type: "number",
+  },
+};
 
 const options = {
   angle: {
     choices: [0, 90, 180, 270],
-    defaultDescription: '0',
-    desc: 'Tile angle of rotation'
+    defaultDescription: "0",
+    desc: "Tile angle of rotation",
+    nargs: 1,
   },
   background: {
-    defaultDescription: 'rgb(255, 255, 255, 1)',
-    desc: 'Background colour, parsed by the color module',
-    type: 'string'
+    defaultDescription: "rgb(255, 255, 255, 1)",
+    desc: "Background colour, parsed by the color module",
+    type: "string",
   },
   basename: {
-    desc: 'The name of the directory within the zip file',
-    type: 'string'
+    desc: "The name of the directory within the zip file",
+    type: "string",
   },
   center: {
-    alias: 'centre',
-    desc: 'Center images in tile',
-    type: 'boolean'
+    alias: "centre",
+    desc: "Center images in tile",
+    type: "boolean",
   },
   container: {
     choices: constants.CONTAINER,
-    defaultDescription: 'fs',
-    desc: 'Tile container'
+    defaultDescription: "fs",
+    desc: "Tile container",
   },
   depth: {
     choices: constants.DEPTH,
-    defaultDescription: 'auto',
-    desc: 'Pyramid depth'
+    defaultDescription: "auto",
+    desc: "Pyramid depth",
   },
   id: {
-    defaultDescription: 'https://example.com/iiif',
-    desc: 'Set the @id/id attribute of info.json',
-    type: 'string'
+    defaultDescription: "https://example.com/iiif",
+    desc: "Set the @id/id attribute of info.json",
+    type: "string",
   },
   layout: {
     choices: constants.LAYOUT,
-    defaultDescription: 'dz',
-    desc: 'Filesystem layout'
+    defaultDescription: "dz",
+    desc: "Filesystem layout",
   },
   overlap: {
-    desc: 'Tile overlap in pixels',
-    defaultDescription: '0',
-    type: 'number'
+    desc: "Tile overlap in pixels",
+    defaultDescription: "0",
+    nargs: 1,
+    type: "number",
   },
   skipBlanks: {
     defaultDescription: -1,
-    desc: 'Threshold to skip tile generation',
-    type: 'number'
-  }
-}
-const optionNames = Object.keys(options)
+    desc: "Threshold to skip tile generation",
+    nargs: 1,
+    type: "number",
+  },
+};
+const optionNames = Object.keys(options);
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 tile 512', 'output.dz is the Deep Zoom XML definition, output_files contains 512×512 tiles grouped by zoom level')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-output#tile')
-    .positional('size', positionals.size)
+    .example(
+      "$0 tile 512",
+      "output.dz is the Deep Zoom XML definition, output_files contains 512×512 tiles grouped by zoom level",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-output#tile",
+    )
+    .positional("size", positionals.size)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['tile', (sharp) => {
-    return sharp.tile({
-      size: args.size,
-      ...pick(args, optionNames)
-    })
-  }])
-}
+  return args["#queue"].push([
+    "tile",
+    (sharp) => {
+      return sharp.tile({
+        size: args.size,
+        ...pick(args, optionNames),
+      });
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'tile [size]',
-  describe: 'Use tile-based deep zoom (image pyramid) output',
+export default {
+  command: "tile [size]",
+  describe: "Use tile-based deep zoom (image pyramid) output",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/resizing/extend.js

@@ -21,82 +21,88 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-// @see https://sharp.dimens.io/api-resize#extend
-
-// Strict mode.
-'use strict'
-
-// Package modules.
-const pick = require('lodash.pick')
+// @see https://sharp.pixelplumbing.com/api-resize#extend
 
 // 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 positionals = {
   bottom: {
-    desc: 'Pixel count to add to the bottom edge',
-    type: 'number'
+    desc: "Pixel count to add to the bottom edge",
+    type: "number",
   },
   left: {
-    desc: 'Pixel count to add to the left edge',
-    type: 'number'
+    desc: "Pixel count to add to the left edge",
+    type: "number",
   },
   right: {
-    desc: 'Pixel count to add to the right edge',
-    type: 'number'
+    desc: "Pixel count to add to the right edge",
+    type: "number",
   },
   top: {
-    desc: 'Pixel count to add to the top edge',
-    type: 'number'
-  }
-}
+    desc: "Pixel count to add to the top edge",
+    type: "number",
+  },
+};
 
 const options = {
   background: {
-    defaultDescription: 'rgba(0, 0, 0, 1)',
-    desc: 'Background colour, parsed by the color module',
-    type: 'string'
+    defaultDescription: "rgba(0, 0, 0, 1)",
+    desc: "Background colour, parsed by the color module",
+    type: "string",
   },
   extendWith: {
     choices: constants.EXTEND_WITH,
-    default: 'background',
-    desc: 'Populate new pixels using this method'
-  }
-}
+    default: "background",
+    desc: "Populate new pixels using this method",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
-  const optionNames = Object.keys(options)
+  const optionNames = Object.keys(options);
   return yargs
     .strict()
-    .example('$0 extend 10 20 10 10 --background rgba(0,0,0,0)', 'Add 10 transparent pixels to the top, left, and right edges, and 20 to the bottom edge')
-    .example('$0 extend 0 10 0 0 --background red', 'Add 10 red pixels to the bottom edge.')
-    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-resize#extend')
-    .positional('top', positionals.top)
-    .positional('bottom', positionals.bottom)
-    .positional('left', positionals.left)
-    .positional('right', positionals.right)
+    .example(
+      "$0 extend 10 20 10 10 --background rgba(0,0,0,0)",
+      "Add 10 transparent pixels to the top, left, and right edges, and 20 to the bottom edge",
+    )
+    .example(
+      "$0 extend 0 10 0 0 --background red",
+      "Add 10 red pixels to the bottom edge.",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-resize#extend",
+    )
+    .positional("top", positionals.top)
+    .positional("bottom", positionals.bottom)
+    .positional("left", positionals.left)
+    .positional("right", positionals.right)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['extend', (sharp) => {
-    return sharp.extend({
-      background: args.background,
-      extendWith: args.extendWith,
-      ...pick(args, Object.keys(positionals))
-    })
-  }])
-}
+  return args["#queue"].push([
+    "extend",
+    (sharp) => {
+      return sharp.extend({
+        background: args.background,
+        extendWith: args.extendWith,
+        ...pick(args, Object.keys(positionals)),
+      });
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'extend <top> <bottom> <left> <right>',
-  describe: 'Extends/pads the edges of the image with the provided background colour',
+export default {
+  command: "extend <top> <bottom> <left> <right>",
+  describe:
+    "Extends/pads the edges of the image with the provided background colour",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/resizing/extract.js

@@ -21,59 +21,58 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-// @see https://sharp.dimens.io/api-resize#extract
-
-// Strict mode.
-'use strict'
-
-// Package modules.
-const pick = require('lodash.pick')
+// @see https://sharp.pixelplumbing.com/api-resize#extract
 
 // Local modules.
-const queue = require('../../lib/queue')
+import { pick } from "../../lib/utils.js";
 
 // Configure.
 const positionals = {
   height: {
-    desc: 'Height of region to extract',
-    type: 'number'
+    desc: "Height of region to extract",
+    type: "number",
   },
   left: {
-    desc: 'Zero-indexed offset from left edge',
-    type: 'number'
+    desc: "Zero-indexed offset from left edge",
+    type: "number",
   },
   top: {
-    desc: 'Zero-indexed offset from top edge',
-    type: 'number'
+    desc: "Zero-indexed offset from top edge",
+    type: "number",
   },
   width: {
-    desc: 'Width of region to extract',
-    type: 'number'
-  }
-}
+    desc: "Width of region to extract",
+    type: "number",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-resize#extract')
-    .positional('top', positionals.top)
-    .positional('left', positionals.left)
-    .positional('width', positionals.width)
-    .positional('height', positionals.height)
-}
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-resize#extract",
+    )
+    .positional("top", positionals.top)
+    .positional("left", positionals.left)
+    .positional("width", positionals.width)
+    .positional("height", positionals.height);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['extract', (sharp) => {
-    return sharp.extract(pick(args, Object.keys(positionals)))
-  }])
-}
+  return args["#queue"].push([
+    "extract",
+    (sharp) => {
+      return sharp.extract(pick(args, Object.keys(positionals)));
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'extract <top> <left> <width> <height>',
-  describe: 'Extract a region of the image',
+export default {
+  command: "extract <top> <left> <width> <height>",
+  describe: "Extract a region of the image",
   builder,
-  handler
-}
+  handler,
+};