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

package/cmd/operations/clahe.js

@@ -24,59 +24,64 @@
 // @see https://sharp.pixelplumbing.com/api-operation#clahe
 
 // Strict mode.
-'use strict'
+"use strict";
 
 // Local modules.
-const queue = require('../../lib/queue')
+const queue = require("../../lib/queue");
 
 // Configure.
 const positionals = {
   height: {
-    desc: 'Height of the region',
-    type: 'number'
+    desc: "Height of the region",
+    type: "number",
   },
   width: {
-    desc: 'Width of the region',
-    type: 'number'
-  }
-}
+    desc: "Width of the region",
+    type: "number",
+  },
+};
 
 const options = {
   maxSlope: {
     defaultDescription: 3,
-    desc: 'Maximum value for the slope of the cumulative histogram',
-    type: 'number'
-  }
-}
+    desc: "Maximum value for the slope of the cumulative histogram",
+    type: "number",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
-  const optionNames = Object.keys(options)
+  const optionNames = Object.keys(options);
   return yargs
     .strict()
-    .example('$0 clahe 3 3')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#clahe')
-    .positional('height', positionals.height)
-    .positional('width', positionals.width)
+    .example("$0 clahe 3 3")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#clahe",
+    )
+    .positional("height", positionals.height)
+    .positional("width", positionals.width)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['clahe', (sharp) => {
-    return sharp.clahe({
-      width: args.width,
-      height: args.height,
-      maxSlope: args.maxSlope
-    })
-  }])
-}
+  return queue.push([
+    "clahe",
+    (sharp) => {
+      return sharp.clahe({
+        width: args.width,
+        height: args.height,
+        maxSlope: args.maxSlope,
+      });
+    },
+  ]);
+};
 
 // Exports.
 module.exports = {
-  command: 'clahe <width> <height>',
-  describe: 'Perform contrast limiting adaptive histogram equalization CLAHE',
+  command: "clahe <width> <height>",
+  describe: "Perform contrast limiting adaptive histogram equalization CLAHE",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/convolve.js

@@ -24,80 +24,88 @@
 // @see https://sharp.pixelplumbing.com/api-operation#convolve
 
 // Strict mode.
-'use strict'
+"use strict";
 
 // Package modules.
-const pick = require('lodash.pick')
+const pick = require("lodash.pick");
 
 // Local modules.
-const queue = require('../../lib/queue')
+const queue = require("../../lib/queue");
 
 // Configure.
 const positionals = {
   height: {
-    desc: 'Height of the kernel in pixels',
-    type: 'number'
+    desc: "Height of the kernel in pixels",
+    type: "number",
   },
   kernel: {
-    desc: 'Array of length width × height containing the kernel values',
+    desc: "Array of length width × height containing the kernel values",
     defaultDescription: '"-1 0 1 -2 0 2 -1 0 1"',
-    type: 'number'
+    type: "number",
   },
   width: {
-    desc: 'Width of the kernel in pixels',
-    type: 'number'
-  }
-}
-const positionalNames = Object.keys(positionals)
+    desc: "Width of the kernel in pixels",
+    type: "number",
+  },
+};
+const positionalNames = Object.keys(positionals);
 
 const options = {
   scale: {
-    desc: 'The scale of the kernel in pixels',
-    defaultDescription: 'sum',
-    type: 'number'
+    desc: "The scale of the kernel in pixels",
+    defaultDescription: "sum",
+    type: "number",
   },
   offset: {
-    desc: 'The offset of the kernel in pixels',
-    defaultDescription: '0',
-    type: 'number'
-  }
-}
-const optionNames = Object.keys(options)
+    desc: "The offset of the kernel in pixels",
+    defaultDescription: "0",
+    type: "number",
+  },
+};
+const optionNames = Object.keys(options);
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 convolve 3 3 "-1 0 1 -2 0 2 -1 0 1"', 'The output will be the convolution of the input image with the horizontal Sobel operator')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#convolve')
-    .check(argv => {
-      const length = argv.width * argv.height
+    .example(
+      '$0 convolve 3 3 "-1 0 1 -2 0 2 -1 0 1"',
+      "The output will be the convolution of the input image with the horizontal Sobel operator",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#convolve",
+    )
+    .check((argv) => {
+      const length = argv.width * argv.height;
       if (!(Array.isArray(argv.kernel) && argv.kernel.length === length)) {
-        throw new Error(`Expected kernel positional to have ${length} values`)
+        throw new Error(`Expected kernel positional to have ${length} values`);
       }
-      return true
+      return true;
     })
     .options(options)
-    .positional('kernel', positionals.kernel)
-    .positional('height', positionals.height)
-    .positional('width', positionals.width)
-    .group(optionNames, 'Command Options')
-}
+    .positional("kernel", positionals.kernel)
+    .positional("height", positionals.height)
+    .positional("width", positionals.width)
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['convolve', (sharp) => {
-    return sharp.convolve({
-      ...pick(args, positionalNames),
-      ...pick(args, optionNames)
-    })
-  }])
-}
+  return queue.push([
+    "convolve",
+    (sharp) => {
+      return sharp.convolve({
+        ...pick(args, positionalNames),
+        ...pick(args, optionNames),
+      });
+    },
+  ]);
+};
 
 // Exports.
 module.exports = {
-  command: 'convolve <width> <height> <kernel..>',
-  describe: 'Convolve the image with the specified kernel',
+  command: "convolve <width> <height> <kernel..>",
+  describe: "Convolve the image with the specified kernel",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/dilate.js

@@ -0,0 +1,64 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * 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
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+// @see https://sharp.pixelplumbing.com/api-operation#dilate
+
+// Strict mode.
+"use strict";
+
+// Local modules.
+const queue = require("../../lib/queue");
+
+// Configure.
+const positionals = {
+  width: {
+    desc: "Dilation width in pixels",
+    defaultDescription: 1,
+    type: "number",
+  },
+};
+
+// Command builder.
+const builder = (yargs) => {
+  return yargs
+    .strict()
+    .example("$0 dilate")
+    .example("$0 dilate 3")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#dilate",
+    )
+    .positional("width", positionals.width);
+};
+
+// Command handler.
+const handler = (args) => {
+  return queue.push(["dilate", (sharp) => sharp.dilate(args.width)]);
+};
+
+// Exports.
+module.exports = {
+  command: "dilate [width]",
+  describe: "Expand foreground objects using the dilate morphological operator",
+  builder,
+  handler,
+};

package/cmd/operations/erode.js

@@ -0,0 +1,64 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * 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
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+// @see https://sharp.pixelplumbing.com/api-operation#erode
+
+// Strict mode.
+"use strict";
+
+// Local modules.
+const queue = require("../../lib/queue");
+
+// Configure.
+const positionals = {
+  width: {
+    desc: "Erosion width in pixels",
+    defaultDescription: 1,
+    type: "number",
+  },
+};
+
+// Command builder.
+const builder = (yargs) => {
+  return yargs
+    .strict()
+    .example("$0 erode")
+    .example("$0 erode 3")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#erode",
+    )
+    .positional("width", positionals.width);
+};
+
+// Command handler.
+const handler = (args) => {
+  return queue.push(["erode", (sharp) => sharp.erode(args.width)]);
+};
+
+// Exports.
+module.exports = {
+  command: "erode [width]",
+  describe: "Shrink foreground objects using the erode morphological operator",
+  builder,
+  handler,
+};

package/cmd/operations/flatten.js

@@ -21,43 +21,48 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-// @see https://sharp.dimens.io/api-operation#flatten
+// @see https://sharp.pixelplumbing.com/api-operation#flatten
 
 // Strict mode.
-'use strict'
+"use strict";
 
 // Local modules.
-const queue = require('../../lib/queue')
+const queue = require("../../lib/queue");
 
 // Configure.
 const positionals = {
   background: {
-    defaultDescription: 'rgb(0, 0, 0)',
-    desc: 'Background colour, parsed by the color module',
-    type: 'string'
-  }
-}
+    defaultDescription: "rgb(0, 0, 0)",
+    desc: "Background colour, parsed by the color module",
+    type: "string",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
     .example('$0 flatten "#F0A703"')
-    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-operation#flatten')
-    .positional('background', positionals.background)
-}
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#flatten",
+    )
+    .positional("background", positionals.background);
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['flatten', (sharp) => {
-    return sharp.flatten({ background: args.background })
-  }])
-}
+  return queue.push([
+    "flatten",
+    (sharp) => {
+      return sharp.flatten({ background: args.background });
+    },
+  ]);
+};
 
 // Exports.
 module.exports = {
-  command: 'flatten [background]',
-  describe: 'Merge alpha transparency channel, if any, with a background',
+  command: "flatten [background]",
+  describe: "Merge alpha transparency channel, if any, with a background",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/flip.js

@@ -24,26 +24,28 @@
 // @see https://sharp.pixelplumbing.com/api-operation#flip
 
 // Strict mode.
-'use strict'
+"use strict";
 
 // Local modules.
-const queue = require('../../lib/queue')
+const queue = require("../../lib/queue");
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#flip')
-    .example('$0 flip')
-}
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#flip",
+    )
+    .example("$0 flip");
+};
 
 // Command handler.
-const handler = (args) => queue.push(['flip', (sharp) => sharp.flip()])
+const handler = (args) => queue.push(["flip", (sharp) => sharp.flip()]);
 
 // Exports.
 module.exports = {
-  command: 'flip',
-  describe: 'Flip the image about the vertical Y axis',
+  command: "flip",
+  describe: "Flip the image about the vertical Y axis",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/flop.js

@@ -24,26 +24,28 @@
 // @see https://sharp.pixelplumbing.com/api-operation#flop
 
 // Strict mode.
-'use strict'
+"use strict";
 
 // Local modules.
-const queue = require('../../lib/queue')
+const queue = require("../../lib/queue");
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#flop')
-    .example('$0 flop')
-}
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#flop",
+    )
+    .example("$0 flop");
+};
 
 // Command handler.
-const handler = (args) => queue.push(['flop', (sharp) => sharp.flop()])
+const handler = (args) => queue.push(["flop", (sharp) => sharp.flop()]);
 
 // Exports.
 module.exports = {
-  command: 'flop',
-  describe: 'Flop the image about the horizontal X axis',
+  command: "flop",
+  describe: "Flop the image about the horizontal X axis",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/gamma.js

@@ -24,43 +24,50 @@
 // @see https://sharp.pixelplumbing.com/api-operation#gamma
 
 // Strict mode.
-'use strict'
+"use strict";
 
 // Local modules.
-const queue = require('../../lib/queue')
+const queue = require("../../lib/queue");
 
 // Configure.
 const positionals = {
   gamma: {
-    desc: 'The gamma factor',
+    desc: "The gamma factor",
     defaultDescription: 2.2,
-    type: 'number'
+    type: "number",
   },
   gammaOut: {
-    desc: 'The gamma factor used for scaling',
-    defaultDescription: '<gamma>',
-    type: 'number'
-  }
-}
+    desc: "The gamma factor used for scaling",
+    defaultDescription: "<gamma>",
+    type: "number",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#gamma')
-    .positional('gamma', positionals.gamma)
-    .positional('gammaOut', positionals.gammaOut)
-}
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#gamma",
+    )
+    .positional("gamma", positionals.gamma)
+    .positional("gammaOut", positionals.gammaOut);
+};
 
 // Command handler.
-const handler = (args) => queue.push(['gamma', (sharp) => {
-  return sharp.gamma(args.gamma, args.gammaOut)
-}])
+const handler = (args) =>
+  queue.push([
+    "gamma",
+    (sharp) => {
+      return sharp.gamma(args.gamma, args.gammaOut);
+    },
+  ]);
 
 // Exports.
 module.exports = {
-  command: 'gamma [gamma] [gammaOut]',
-  describe: 'Apply a gamma correction by reducing the encoding (darken) pre-resize then increasing the encoding (brighten) post-resize',
+  command: "gamma [gamma] [gammaOut]",
+  describe:
+    "Apply a gamma correction by reducing the encoding (darken) pre-resize then increasing the encoding (brighten) post-resize",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/operations/linear.js

@@ -24,50 +24,57 @@
 // @see https://sharp.pixelplumbing.com/api-operation#linear
 
 // Strict mode.
-'use strict'
+"use strict";
 
 // Local modules.
-const queue = require('../../lib/queue')
+const queue = require("../../lib/queue");
 
 // Configure.
 const positionals = {
   multiplier: {
-    desc: 'Multiplier',
+    desc: "Multiplier",
     default: 1.0,
-    type: 'number'
-  }
-}
+    type: "number",
+  },
+};
 
 const options = {
   offset: {
-    desc: 'Offset',
-    type: 'array'
-  }
-}
+    desc: "Offset",
+    type: "array",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
-  const optionNames = Object.keys(options)
+  const optionNames = Object.keys(options);
   return yargs
     .strict()
-    .example('$0 linear 0.5 --offset 2')
-    .example('$0 linear 0.25 0.5 0.75 --offset 150 100 50')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#linear')
-    .positional('multiplier', positionals.multiplier)
+    .example("$0 linear 0.5 --offset 2")
+    .example("$0 linear 0.25 0.5 0.75 --offset 150 100 50")
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-operation#linear",
+    )
+    .positional("multiplier", positionals.multiplier)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  const multiplier = args.multiplier.length === 1 ? args.multiplier[0] : args.multiplier
-  return queue.push(['linear', (sharp) => sharp.linear(multiplier, args.offset)])
-}
+  const multiplier =
+    args.multiplier.length === 1 ? args.multiplier[0] : args.multiplier;
+  return queue.push([
+    "linear",
+    (sharp) => sharp.linear(multiplier, args.offset),
+  ]);
+};
 
 // Exports.
 module.exports = {
-  command: 'linear [multiplier..]',
-  describe: 'Apply the linear formula a × input + b to the image to adjust image levels',
+  command: "linear [multiplier..]",
+  describe:
+    "Apply the linear formula a × input + b to the image to adjust image levels",
   builder,
-  handler
-}
+  handler,
+};