arcadible 0.1.23 → 0.1.24

package/bin/arc-validate.js

@@ -17,10 +17,12 @@ const cfgproduct = require("../src/config/product");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const rc = require("../src/util/rc");
+const schema = require("../src/util/schema");
 const validate = require("../src/cli/validate");
 
 // [use]
 
+const dereference = schema.dereference;
 const findRc = rc.findRc;
 const print = output.print;
 const resolve = path.resolve;
@@ -49,8 +51,17 @@ const start = function (argv) {
       if (json) {
         print({ issues });
       } else if (count) {
-        log.hd(`${count} ${count === 1 ? "issue" : "issues"} found.`);
-        log.p(issues.map((issue) => `✗ ${issue}`));
+        const [probs, refs] = dereference(issues);
+        const probcount = probs.length;
+        if (probcount) {
+          log.hd(`${probcount} ${probcount === 1 ? "issue" : "issues"}:`);
+          log.p(probs.map((prob) => `✗ ${prob}`));
+        }
+        const refcount = refs.length;
+        if (refcount) {
+          log.h(`${refcount} ${refcount === 1 ? "reference" : "references"}:`);
+          log.p(refs);
+        }
       } else if (!argv.quiet) {
         log.hs("No issues found.");
       }

package/package.json

@@ -61,5 +61,5 @@
   "license": "Apache-2.0",
   "main": "./src/cli/index.js",
   "name": "arcadible",
-  "version": "0.1.23"
+  "version": "0.1.24"
 }

package/src/schema/game.js

@@ -96,33 +96,48 @@ const zMedia = function (field, root) {
 // [function]
 
 const zPng = function (field, root, opts) {
-  return zMedia(field, root).refine(
-    (file) => imageCheck(root, file, { ...opts, type: cfgimage[".png"] }),
-    message(field, ["Invalid PNG."]),
-  );
+  return zMedia(field, root).superRefine((file, ctx) => {
+    const issues = imageCheck(root, file, { ...opts, type: cfgimage[".png"] });
+    if (issues.length) {
+      ctx.addIssue({
+        code: "custom",
+        ...message(field, ["Invalid PNG.", ...issues]),
+      });
+    }
+  });
 };
 
 // [function]
 
 const zSvg = function (field, root, opts) {
-  return zMedia(field, root).refine(
-    (file) => imageCheck(root, file, { ...opts, type: cfgimage[".svg"] }),
-    message(field, ["Invalid SVG."]),
-  );
+  return zMedia(field, root).superRefine((file, ctx) => {
+    const issues = imageCheck(root, file, { ...opts, type: cfgimage[".svg"] });
+    if (issues.length) {
+      ctx.addIssue({
+        code: "custom",
+        ...message(field, ["Invalid SVG.", ...issues]),
+      });
+    }
+  });
 };
 
 // [function]
 
 const zMp4 = function (field, root, opts) {
-  return zMedia(field, root).refine(
-    (file) =>
-      videoCheck(root, file, {
-        maxDuration: 30,
-        ...opts,
-        type: cfgvideo[".mp4"],
-      }),
-    message(field, ["Invalid MP4."]),
-  );
+  return zMedia(field, root).superRefine((file, ctx) => {
+    const issues = videoCheck(root, file, {
+      maxDuration: 30,
+      minDuration: 3,
+      ...opts,
+      type: cfgvideo[".mp4"],
+    });
+    if (issues.length) {
+      ctx.addIssue({
+        code: "custom",
+        ...message(field, ["Invalid MP4.", ...issues]),
+      });
+    }
+  });
 };
 
 // [function]
@@ -243,11 +258,44 @@ const zGallery = function (root) {
   return z.optional(
     z
       .array(
-        z.union([
-          zPng(field, root, { maxSize: size.mb(2) }),
-          zSvg(field, root, { maxSize: size.mb(1) }),
-          zMp4(field, root, { maxSize: size.mb(15) }),
-        ]),
+        zMedia(field, root).superRefine((file, ctx) => {
+          if (file.endsWith(".png")) {
+            const issues = imageCheck(root, file, {
+              maxSize: size.mb(2),
+              type: cfgimage[".png"],
+            });
+            if (issues.length) {
+              ctx.addIssue({
+                code: "custom",
+                ...message(field, [`Invalid PNG: ${file}`, ...issues]),
+              });
+            }
+          } else if (file.endsWith(".svg")) {
+            const issues = imageCheck(root, file, {
+              maxSize: size.mb(1),
+              type: cfgimage[".svg"],
+            });
+            if (issues.length) {
+              ctx.addIssue({
+                code: "custom",
+                ...message(field, [`Invalid SVG: ${file}`, ...issues]),
+              });
+            }
+          } else if (file.endsWith(".mp4")) {
+            const issues = videoCheck(root, file, {
+              maxDuration: 30,
+              maxSize: size.mb(15),
+              minDuration: 3,
+              type: cfgvideo[".mp4"],
+            });
+            if (issues.length) {
+              ctx.addIssue({
+                code: "custom",
+                ...message(field, [`Invalid MP4: ${file}`, ...issues]),
+              });
+            }
+          }
+        }),
       )
       .min(1)
       .max(12),

package/src/schema/workflow.js

@@ -29,7 +29,7 @@ const MEDIA = `.${HANDLE}`;
 // [function]
 
 const reference = function (field) {
-  return chalk.cyan.underline(`${cfgurl.MANIFEST}#workflow.${field}`);
+  return chalk.cyan.underline(`${cfgurl.MANIFEST}#game.${field}`);
 };
 
 // [function]
@@ -64,11 +64,11 @@ const zDeployDir = function (root, { build }) {
     )
     .refine(
       (file) => isOutCheck(root, file),
-      message(field, ["Must be within the project directory."]),
+      message(field, ["Must be within the project."]),
     )
     .refine(
       (file) => isReservedCheck(root, file, MEDIA),
-      message(field, [`Must not contain ${MEDIA}.`]),
+      message(field, [`Must not contain ${MEDIA} in path.`]),
     )
     .refine(
       (file) => build || existsCheck(root, file),

package/src/util/bytes.js

@@ -0,0 +1,20 @@
+"use strict";
+
+// [function]
+
+const formatBytes = function (bytes) {
+  switch (true) {
+    case bytes < 1024:
+      return `${bytes} B`;
+    case bytes < 1024 ** 2:
+      return `${(bytes / 1024).toFixed(1)} KB`;
+    case bytes < 1024 ** 3:
+      return `${(bytes / 1024 / 1024).toFixed(1)} MB`;
+    default:
+      return `${(bytes / 1024 / 1024 / 1024).toFixed(1)} GB`;
+  }
+};
+
+// [export]
+
+module.exports = { formatBytes };

package/src/util/image.js

@@ -11,11 +11,13 @@ const imageSize = require("image-size").imageSize;
 
 // [import]
 
+const bytes = require("./bytes");
 const cfgimage = require("../config/image");
 
 // [use]
 
 const extname = path.extname;
+const formatBytes = bytes.formatBytes;
 const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
 const statSync = fs.statSync; // eslint-disable-line no-sync
 
@@ -50,29 +52,29 @@ const checkSize = function (file, maxSize) {
 
 const checkPng = function (file, { aspect, maxSize, minHeight, minWidth }) {
   if (!checkSize(file, maxSize)) {
-    return false;
+    return [`Image size must not exceed: ${formatBytes(maxSize)}`];
   }
   const buffer = readFileSync(file);
   const { height, width } = imageSize(buffer);
   if (minWidth && width < minWidth) {
-    return false;
+    return [`Image width must be at least: ${minWidth}px`];
   }
   if (minHeight && height < minHeight) {
-    return false;
+    return [`Image height must be at least: ${minHeight}px`];
   }
   if (!checkAspect(width, height, aspect)) {
-    return false;
+    return [`Image aspect ratio must be: ${aspect}`];
   }
-  return true;
+  return [];
 };
 
 // [function]
 
 const checkSvg = function (file, { maxSize }) {
   if (!checkSize(file, maxSize)) {
-    return false;
+    return [`Image size must not exceed: ${formatBytes(maxSize)}`];
   }
-  return true;
+  return [];
 };
 
 // [function]
@@ -85,7 +87,7 @@ const check = function (file, { type, ...opts }) {
   const checkImage = checks[type];
   return checkImage && cfgimage[extname(file)] === type
     ? checkImage(file, opts)
-    : false;
+    : ["Image has an unsupported file type."];
 };
 
 // [export]

package/src/util/progress.js

@@ -4,8 +4,13 @@
 
 const cliProgress = require("cli-progress");
 
+// [import]
+
+const bytes = require("./bytes");
+
 // [use]
 
+const formatBytes = bytes.formatBytes;
 const Presets = cliProgress.Presets;
 const SingleBar = cliProgress.SingleBar;
 
@@ -15,21 +20,6 @@ const FORMAT = "[{bar}] {percentage}% | {value}/{total}";
 
 // [function]
 
-const formatBytes = function (bytes) {
-  switch (true) {
-    case bytes < 1000:
-      return `${bytes} B`;
-    case bytes < 1000 * 1000:
-      return `${(bytes / 1000).toFixed(1)} KB`;
-    case bytes < 1000 * 1000 * 1000:
-      return `${(bytes / 1000 / 1000).toFixed(1)} MB`;
-    default:
-      return `${(bytes / 1000 / 1000 / 1000).toFixed(1)} GB`;
-  }
-};
-
-// [function]
-
 const formatValue = function (value, opts, type) {
   if (type === "percentage") {
     return value;

package/src/util/schema.js

@@ -1,10 +1,34 @@
 "use strict";
 
+// [import]
+
+const chalk = require("chalk");
+
+// [function]
+
+const dereference = function (issues) {
+  const references = new Set();
+  const output = issues.map((issue) =>
+    issue
+      .split("\n")
+      .filter((line) => {
+        if (/https?:\/\//u.test(line)) {
+          references.add(line.trim());
+          return false;
+        }
+        return true;
+      })
+      .join("\n"),
+  );
+  return [output, [...references]];
+};
+
 // [function]
 
 const format = function (name, { issues }) {
   return issues.map(
-    ({ message, path }) => `${name}.${path.join(".") || "value"}: ${message}`,
+    ({ message, path }) =>
+      `${chalk.cyan(`${name}.${path.join(".") || "value"}`)}: ${message}`,
   );
 };
 
@@ -22,4 +46,4 @@ const validator = function (name, schema) {
 
 // [export]
 
-module.exports = { validator };
+module.exports = { dereference, validator };

package/src/util/video.js

@@ -11,12 +11,14 @@ const fs = require("fs-extra");
 
 // [import]
 
+const bytes = require("./bytes");
 const cfgvideo = require("../config/video");
 const phrase = require("../phrase");
 
 // [use]
 
 const extname = path.extname;
+const formatBytes = bytes.formatBytes;
 const readFileSync = fs.readFileSync; // eslint-disable-line no-sync
 const statSync = fs.statSync; // eslint-disable-line no-sync
 
@@ -89,31 +91,34 @@ const readMp4 = function (file) {
 
 const checkMp4 = function (
   file,
-  { aspect, maxDuration, maxSize, minHeight, minWidth },
+  { aspect, maxDuration, maxSize, minDuration, minHeight, minWidth },
 ) {
   if (!checkSize(file, maxSize)) {
-    return false;
+    return [`Video size must not exceed: ${formatBytes(maxSize)}`];
   }
   let video = null;
   try {
     video = readMp4(file);
   } catch {
-    return false;
+    return ["Video is an invalid file."];
   }
   const { duration, height, width } = video;
   if (minWidth && width < minWidth) {
-    return false;
+    return [`Video width must be at least: ${minWidth}px`];
   }
   if (minHeight && height < minHeight) {
-    return false;
+    return [`Video height must be at least: ${minHeight}px`];
+  }
+  if (minDuration && duration < minDuration) {
+    return [`Video duration must be at least: ${minDuration}s`];
   }
   if (maxDuration && duration > maxDuration) {
-    return false;
+    return [`Video duration must not exceed: ${maxDuration}s`];
   }
   if (!checkAspect(width, height, aspect)) {
-    return false;
+    return [`Video aspect ratio must be: ${aspect}`];
   }
-  return true;
+  return [];
 };
 
 // [function]
@@ -125,7 +130,7 @@ const check = function (file, { type, ...opts }) {
   const checkVideo = checks[type];
   return checkVideo && cfgvideo[extname(file)] === type
     ? checkVideo(file, opts)
-    : false;
+    : ["Video has an unsupported file type."];
 };
 
 // [export]