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

package/cmd/resizing/resize.js

@@ -23,102 +23,125 @@
 
 // @see https://sharp.pixelplumbing.com/api-resize/
 
-// 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 = {
   width: {
     default: null,
-    desc: 'Pixels wide the resultant image should be',
-    type: 'number'
+    desc: "Pixels wide the resultant image should be",
+    type: "number",
   },
   height: {
     default: null,
-    desc: 'Pixels high the resultant image should be',
-    type: 'number'
-  }
-}
+    desc: "Pixels high the resultant image should be",
+    type: "number",
+  },
+};
 
 const options = {
   background: {
-    defaultDescription: 'rgba(0, 0, 0, 1)',
-    desc: 'Background colour when fit is contain, parsed by the color module.',
-    type: 'string'
+    defaultDescription: "rgba(0, 0, 0, 1)",
+    desc: "Background colour when fit is contain, parsed by the color module.",
+    type: "string",
   },
   fastShrinkOnLoad: {
     defaultDescription: true,
-    desc: 'Take greater advantage of the JPEG and WebP shrink-on-load feature',
-    type: 'boolean'
+    desc: "Take greater advantage of the JPEG and WebP shrink-on-load feature",
+    type: "boolean",
   },
   fit: {
     choices: constants.FIT,
-    defaultDescription: 'cover',
-    desc: 'How the image should be resized to fit both provided dimensions'
+    defaultDescription: "cover",
+    desc: "How the image should be resized to fit both provided dimensions",
   },
   kernel: {
     choices: constants.KERNEL,
-    defaultDescription: 'lanczos3',
-    desc: 'The kernel to use for image reduction and the inferred interpolator to use for upsampling'
+    defaultDescription: "lanczos3",
+    desc: "The kernel to use for image reduction and the inferred interpolator to use for upsampling",
   },
   position: {
-    choices: [...constants.GRAVITY, ...constants.POSITION, ...constants.STRATEGY],
-    defaultDescription: 'centre',
-    desc: 'Position, gravity, or strategy to use when fit is cover or contain'
+    choices: [
+      ...constants.GRAVITY,
+      ...constants.POSITION,
+      ...constants.STRATEGY,
+    ],
+    defaultDescription: "centre",
+    desc: "Position, gravity, or strategy to use when fit is cover or contain",
   },
   withoutEnlargement: {
-    desc: 'Do not enlarge if the width or height are already less than the specified dimensions',
-    type: 'boolean'
+    desc: "Do not enlarge if the width or height are already less than the specified dimensions",
+    type: "boolean",
   },
   withoutReduction: {
-    desc: 'Do not reduce if the width or height are already greater than the specified dimensions',
-    type: 'boolean'
-  }
-}
-const optionNames = Object.keys(options)
+    desc: "Do not reduce if the width or height are already greater than the specified dimensions",
+    type: "boolean",
+  },
+};
+const optionNames = Object.keys(options);
 
 // Command builder.
 const builder = (yargs) => {
   return yargs
     .strict()
-    .example('$0 resize 100', 'The output will be 100 pixels wide, auto-scaled height')
-    .example('$0 resize --height 100', 'The output will be 100 pixels high, auto-scaled width')
-    .example('$0 resize 200 300 --background rgba(255,255,255,0.5) --fit contain --kernel nearest --position "right top"', 'The output will be 200 pixels wide and 300 pixels high containing a nearest-neighbour scaled version contained within the north-east corner of a semi-transparent white canvas')
-    .example('$0 resize 200 200 --fit cover --position entropy', 'The output will be a 200px square auto-cropped image')
-    .example('$0 resize 200 200 --withoutEnlargement', 'The output will be no wider and no higher than 200 pixels, and no larger than the input image')
-    .example('$0 resize 200 200 --withoutReduction', 'The output will be at least 200 pixels wide and 200 pixels high while maintaining aspect ratio, and no smaller than the input image')
-    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-resize/')
-    .positional('width', positionals.width)
-    .positional('height', positionals.height)
-    .check(argv => {
+    .example(
+      "$0 resize 100",
+      "The output will be 100 pixels wide, auto-scaled height",
+    )
+    .example(
+      "$0 resize --height 100",
+      "The output will be 100 pixels high, auto-scaled width",
+    )
+    .example(
+      '$0 resize 200 300 --background rgba(255,255,255,0.5) --fit contain --kernel nearest --position "right top"',
+      "The output will be 200 pixels wide and 300 pixels high containing a nearest-neighbour scaled version contained within the north-east corner of a semi-transparent white canvas",
+    )
+    .example(
+      "$0 resize 200 200 --fit cover --position entropy",
+      "The output will be a 200px square auto-cropped image",
+    )
+    .example(
+      "$0 resize 200 200 --withoutEnlargement",
+      "The output will be no wider and no higher than 200 pixels, and no larger than the input image",
+    )
+    .example(
+      "$0 resize 200 200 --withoutReduction",
+      "The output will be at least 200 pixels wide and 200 pixels high while maintaining aspect ratio, and no smaller than the input image",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-resize/",
+    )
+    .positional("width", positionals.width)
+    .positional("height", positionals.height)
+    .check((argv) => {
       if (argv.width === null && argv.height === null) {
-        throw new Error('Expected at least one of width and height positionals')
+        throw new Error(
+          "Expected at least one of width and height positionals",
+        );
       }
-      return true
+      return true;
     })
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
   // @see https://sharp.pixelplumbing.com/api-resize#resize
-  return queue.push(['resize', (sharp) => {
-    return sharp.resize(args.width, args.height, pick(args, optionNames))
-  }])
-}
+  return args["#queue"].push([
+    "resize",
+    (sharp) => {
+      return sharp.resize(args.width, args.height, pick(args, optionNames));
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'resize [width] [height]',
-  describe: 'Resize image to width, height, or width × height',
+export default {
+  command: "resize [width] [height]",
+  describe: "Resize image to width, height, or width × height",
   builder,
-  handler
-}
+  handler,
+};

package/cmd/resizing/trim.js

@@ -21,62 +21,85 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-// @see https://sharp.dimens.io/api-resize#trim
-
-// Strict mode.
-'use strict'
-
-// Local modules.
-const queue = require('../../lib/queue')
+// @see https://sharp.pixelplumbing.com/api-resize#trim
 
 // Configure.
 const positionals = {
   threshold: {
-    desc: 'The allowed difference from the top-left pixel',
+    desc: "The allowed difference from the top-left pixel",
     defaultDescription: 10,
-    type: 'number'
-  }
-}
+    type: "number",
+  },
+};
 
 const options = {
   background: {
-    defaultDescription: 'top-left pixel',
-    desc: 'Background colour, parsed by the color module',
-    type: 'string'
+    defaultDescription: "top-left pixel",
+    desc: "Background colour, parsed by the color module",
+    type: "string",
   },
   lineArt: {
     default: false,
-    desc: 'Does the input more closely resemble line art rather than being photographic',
-    type: 'boolean'
-  }
-}
+    desc: "Does the input more closely resemble line art rather than being photographic",
+    type: "boolean",
+  },
+  margin: {
+    desc: "Leave a margin around trimmed content",
+    nargs: 1,
+    type: "number",
+  },
+};
 
 // Command builder.
 const builder = (yargs) => {
-  const optionNames = Object.keys(options)
+  const optionNames = Object.keys(options);
   return yargs
     .strict()
-    .example('$0 trim', 'Trim pixels with a colour similar to that of the top-left pixel')
-    .example('$0 trim 0', 'Trim pixels with the exact same colour as that of the top-left pixel')
-    .example('$0 trim --background "#FF0000"', 'Trim pixels with a similar colour to red')
-    .example('$0 trim 42 --background yellow', 'Trim all "yellow-ish" pixels')
-    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-resize#trim')
-    .positional('threshold', positionals.threshold)
+    .example(
+      "$0 trim",
+      "Trim pixels with a colour similar to that of the top-left pixel",
+    )
+    .example(
+      "$0 trim 0",
+      "Trim pixels with the exact same colour as that of the top-left pixel",
+    )
+    .example(
+      '$0 trim --background "#FF0000"',
+      "Trim pixels with a similar colour to red",
+    )
+    .example("$0 trim 42 --background yellow", 'Trim all "yellow-ish" pixels')
+    .example(
+      "$0 trim --margin 10",
+      "Trim image leaving (up to) 10 pixel margin around the trimmed content",
+    )
+    .epilog(
+      "For more information on available options, please visit https://sharp.pixelplumbing.com/api-resize#trim",
+    )
+    .positional("threshold", positionals.threshold)
     .options(options)
-    .group(optionNames, 'Command Options')
-}
+    .group(optionNames, "Command Options");
+};
 
 // Command handler.
 const handler = (args) => {
-  return queue.push(['trim', (sharp) => {
-    return sharp.trim({ background: args.background, lineArt: args.lineArt, threshold: args.threshold })
-  }])
-}
+  return args["#queue"].push([
+    "trim",
+    (sharp) => {
+      return sharp.trim({
+        background: args.background,
+        lineArt: args.lineArt,
+        margin: args.margin,
+        threshold: args.threshold,
+      });
+    },
+  ]);
+};
 
 // Exports.
-module.exports = {
-  command: 'trim [threshold]',
-  describe: 'Trim pixels from all edges that contain values similar to the given background color, which defaults to that of the top-left pixel',
+export default {
+  command: "trim [threshold]",
+  describe:
+    "Trim pixels from all edges that contain values similar to the given background color, which defaults to that of the top-left pixel",
   builder,
-  handler
-}
+  handler,
+};

package/{lib/queue.js → eslint.config.mjs}

@@ -21,24 +21,28 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-// Strict mode.
-'use strict'
+// Package modules.
+import js from "@eslint/js";
+import globals from "globals";
+import { defineConfig, globalIgnores } from "eslint/config";
 
-// Configure.
-const queue = []
+// Exports.
+export default defineConfig([
+  globalIgnores(["coverage/**", ".nyc_output/**"]),
+  js.configs.recommended,
 
-// Extend object.
-Object.defineProperties(queue, {
-  // Add drain handler.
-  drain: {
-    value: (initialValue) => queue.reduce((acc, [, cb]) => cb(acc), initialValue)
+  {
+    files: ["**/*.{js,mjs,cjs}"],
+    languageOptions: { globals: globals.node },
   },
 
-  // Add pipeline getter.
-  pipeline: {
-    get: () => queue.map(([value]) => value)
-  }
-})
-
-// Exports.
-module.exports = queue
+  {
+    files: ["test/**/*.js"],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.mocha,
+      },
+    },
+  },
+]);