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

package/cmd/resizing/extract.js

@@ -23,14 +23,8 @@
 
 // @see https://sharp.pixelplumbing.com/api-resize#extract
 
-// 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 = {
@@ -67,7 +61,7 @@ const builder = (yargs) => {
 
 // Command handler.
 const handler = (args) => {
-  return queue.push([
+  return args["#queue"].push([
     "extract",
     (sharp) => {
       return sharp.extract(pick(args, Object.keys(positionals)));
@@ -76,7 +70,7 @@ const handler = (args) => {
 };
 
 // Exports.
-module.exports = {
+export default {
   command: "extract <top> <left> <width> <height>",
   describe: "Extract a region of the image",
   builder,

package/cmd/resizing/resize.js

@@ -23,27 +23,35 @@
 
 // @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";
+
+// Helpers.
+const resolveDimension = (dimension, metadataDimension) => {
+  if (dimension == null) return null;
+  if (typeof dimension === "string" && dimension.endsWith("%")) {
+    if (metadataDimension == null) {
+      throw new Error("Input metadata is required to resolve percentage");
+    }
+    return Math.round(
+      (metadataDimension * Number(dimension.slice(0, -1))) / 100,
+    );
+  }
+  return Number(dimension);
+};
 
 // Configure.
 const positionals = {
   width: {
     default: null,
-    desc: "Pixels wide the resultant image should be",
-    type: "number",
+    desc: "Pixels or percentage wide the resultant image should be",
+    type: "string",
   },
   height: {
     default: null,
-    desc: "Pixels high the resultant image should be",
-    type: "number",
+    desc: "Pixels or percentage high the resultant image should be",
+    type: "string",
   },
 };
 
@@ -100,6 +108,10 @@ const builder = (yargs) => {
       "$0 resize --height 100",
       "The output will be 100 pixels high, auto-scaled width",
     )
+    .example(
+      "$0 resize 50%",
+      "The output will be 50% of the input width, auto-scaled height",
+    )
     .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",
@@ -136,16 +148,18 @@ const builder = (yargs) => {
 // Command handler.
 const handler = (args) => {
   // @see https://sharp.pixelplumbing.com/api-resize#resize
-  return queue.push([
+  return args["#queue"].push([
     "resize",
-    (sharp) => {
-      return sharp.resize(args.width, args.height, pick(args, optionNames));
+    (sharp, { metadata } = {}) => {
+      const width = resolveDimension(args.width, metadata?.width);
+      const height = resolveDimension(args.height, metadata?.height);
+      return sharp.resize(width, height, pick(args, optionNames));
     },
   ]);
 };
 
 // Exports.
-module.exports = {
+export default {
   command: "resize [width] [height]",
   describe: "Resize image to width, height, or width × height",
   builder,

package/cmd/resizing/trim.js

@@ -23,12 +23,6 @@
 
 // @see https://sharp.pixelplumbing.com/api-resize#trim
 
-// Strict mode.
-"use strict";
-
-// Local modules.
-const queue = require("../../lib/queue");
-
 // Configure.
 const positionals = {
   threshold: {
@@ -49,6 +43,11 @@ const options = {
     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.
@@ -69,6 +68,10 @@ const builder = (yargs) => {
       "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",
     )
@@ -79,12 +82,13 @@ const builder = (yargs) => {
 
 // Command handler.
 const handler = (args) => {
-  return queue.push([
+  return args["#queue"].push([
     "trim",
     (sharp) => {
       return sharp.trim({
         background: args.background,
         lineArt: args.lineArt,
+        margin: args.margin,
         threshold: args.threshold,
       });
     },
@@ -92,7 +96,7 @@ const handler = (args) => {
 };
 
 // Exports.
-module.exports = {
+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",

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

@@ -21,25 +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),
+  {
+    files: ["test/**/*.js"],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.mocha,
+      },
+    },
   },
-});
-
-// Exports.
-module.exports = queue;
+]);