arcadible 0.1.24 → 0.1.26

package/bin/arc-init.js

@@ -16,12 +16,12 @@ const yargs = require("yargs/yargs");
 
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
+const cfgtemplate = require("../src/config/template");
 const init = require("../src/cli/init");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const rc = require("../src/util/rc");
 const spinner = require("../src/util/spinner");
-const template = require("../src/prompt/template");
 
 // [use]
 
@@ -126,11 +126,11 @@ const prompt = async function ({ yes, ...argv }) {
   const opts = { ...argv };
   opts.patch = await patch(opts.cwd, opts.project);
   if (opts.patch || yes) {
-    opts.template ??= template.select.default;
+    opts.template ??= cfgtemplate.default;
     return opts;
   }
   if (!opts.template) {
-    opts.template = await select(template.select);
+    opts.template = await select(cfgtemplate);
   }
   return opts;
 };

package/package.json

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

package/src/action/predeploy/git.js

@@ -107,8 +107,8 @@ const createTag = function (root, version, cb) {
       `${PREFIX}${version}`,
       "-m",
       prereleaseSemver(version) === null
-        ? `Release v${version}`
-        : `Prerelease v${version}`,
+        ? phrase.versionRelease(version)
+        : phrase.versionPrerelease(version),
     ],
     (err) => {
       if (err) {

package/src/action/predeploy/pm.js

@@ -5,15 +5,15 @@
 const fs = require("node:fs");
 const path = require("node:path");
 
+// [import]
+
+const phrase = require("../../phrase");
+
 // [use]
 
 const existsSync = fs.existsSync; // eslint-disable-line no-sync
 const join = path.join;
 
-// [import]
-
-const phrase = require("../../phrase");
-
 // [function]
 
 const ensureLockFile = function (root, cb) {

package/src/action/predeploy/tool-git.js

@@ -3,6 +3,7 @@
 // [import]
 
 const git = require("./git");
+const phrase = require("../../phrase");
 const pm = require("./pm");
 const project = require("../../parser/project");
 
@@ -42,7 +43,7 @@ const deployEnsureGit = function ({ root }, { onLogInfo }, cb) {
       if (diff.cached && onLogInfo) {
         onLogInfo({
           level: "warn",
-          message: "Staged but uncommitted changes will not be included.",
+          message: phrase.gitStagedUnincluded(),
         });
       }
       ensureRemote(root, cb);

package/src/config/template.js

@@ -0,0 +1,45 @@
+"use strict";
+
+// [import]
+
+const cfgproduct = require("./product");
+const phrase = require("../phrase");
+
+// [declare]
+
+const HANDLE = cfgproduct.handle;
+const STARTER = `${HANDLE}/starter`;
+
+// [export]
+
+module.exports = {
+  choices: [
+    {
+      description: phrase.starterBlank(),
+      name: "Blank",
+      value: STARTER,
+    },
+    {
+      description: phrase.starterThreeJs(),
+      name: "Three.js",
+      value: `${STARTER}-threejs`,
+    },
+    {
+      description: phrase.starterPhaser(),
+      name: "Phaser",
+      value: `${STARTER}-phaser`,
+    },
+    {
+      description: phrase.starterPixiJs(),
+      name: "PixiJS",
+      value: `${STARTER}-pixijs`,
+    },
+    {
+      description: phrase.starterBabylonJs(),
+      name: "Babylon.js",
+      value: `${STARTER}-babylonjs`,
+    },
+  ],
+  default: STARTER,
+  message: "Template",
+};

package/src/phrase.js

@@ -73,6 +73,12 @@ const gitRepoMissing = function () {
 
 // [function]
 
+const gitStagedUnincluded = function () {
+  return ["Staged but uncommitted changes will not be included."].join("\n");
+};
+
+// [function]
+
 const gitTagCreateFailed = function () {
   return [
     "Unable to create Git tag.",
@@ -100,6 +106,42 @@ const gitVersionExists = function () {
 
 // [function]
 
+const httpError = function (name, status) {
+  return `HttpError: ${name} (${status})`;
+};
+
+// [function]
+
+const imageAspect = function (aspect) {
+  return `Image aspect ratio must be: ${aspect}`;
+};
+
+// [function]
+
+const imageHeightMin = function (height) {
+  return `Image height must be at least: ${height}px`;
+};
+
+// [function]
+
+const imageSizeMax = function (size) {
+  return `Image size must not exceed: ${size}`;
+};
+
+// [function]
+
+const imageUnsupported = function () {
+  return "Image has an unsupported file type.";
+};
+
+// [function]
+
+const imageWidthMin = function (width) {
+  return `Image width must be at least: ${width}px`;
+};
+
+// [function]
+
 const issuesFound = function (count) {
   return `${count} ${count === 1 ? "issue" : "issues"} found. Run ${cmdValidate()} for details.`;
 };
@@ -172,6 +214,60 @@ const packageTooLarge = function (size, assets) {
 
 // [function]
 
+const sizeB = function (size) {
+  return `${size} B`;
+};
+
+// [function]
+
+const sizeGb = function (size) {
+  return `${size} GB`;
+};
+
+// [function]
+
+const sizeKb = function (size) {
+  return `${size} KB`;
+};
+
+// [function]
+
+const sizeMb = function (size) {
+  return `${size} MB`;
+};
+
+// [function]
+
+const starterBabylonJs = function () {
+  return "Babylon.js starter.";
+};
+
+// [function]
+
+const starterBlank = function () {
+  return "Blank JavaScript starter.";
+};
+
+// [function]
+
+const starterPhaser = function () {
+  return "Phaser starter.";
+};
+
+// [function]
+
+const starterPixiJs = function () {
+  return "PixiJS starter.";
+};
+
+// [function]
+
+const starterThreeJs = function () {
+  return "Three.js starter.";
+};
+
+// [function]
+
 const timedOut = function () {
   return "Timed out.";
 };
@@ -194,6 +290,66 @@ const uploadFailed = function (status) {
   return `Upload failed with status ${status}.`;
 };
 
+// [function]
+
+const versionPrerelease = function (version) {
+  return `Prerelease v${version}`;
+};
+
+// [function]
+
+const versionRelease = function (version) {
+  return `Release v${version}`;
+};
+
+// [function]
+
+const videoAspect = function (aspect) {
+  return `Video aspect ratio must be: ${aspect}`;
+};
+
+// [function]
+
+const videoDurationMax = function (maxDuration) {
+  return `Video duration must not exceed: ${maxDuration}s`;
+};
+
+// [function]
+
+const videoDurationMin = function (duration) {
+  return `Video duration must be at least: ${duration}s`;
+};
+
+// [function]
+
+const videoHeightMin = function (height) {
+  return `Video height must be at least: ${height}px`;
+};
+
+// [function]
+
+const videoInvalid = function () {
+  return "Video is an invalid file.";
+};
+
+// [function]
+
+const videoSizeMax = function (size) {
+  return `Video size must not exceed: ${size}`;
+};
+
+// [function]
+
+const videoUnsupported = function () {
+  return "Video has an unsupported file type.";
+};
+
+// [function]
+
+const videoWidthMin = function (width) {
+  return `Video width must be at least: ${width}px`;
+};
+
 // [export]
 
 module.exports = {
@@ -206,9 +362,16 @@ module.exports = {
   gitChangesPresent,
   gitRemoteMissing,
   gitRepoMissing,
+  gitStagedUnincluded,
   gitTagCreateFailed,
   gitTagPushFailed,
   gitVersionExists,
+  httpError,
+  imageAspect,
+  imageHeightMin,
+  imageSizeMax,
+  imageUnsupported,
+  imageWidthMin,
   issuesFound,
   loginExpired,
   loginFailed,
@@ -221,8 +384,27 @@ module.exports = {
   overwriteWithForce,
   packageFileMissing,
   packageTooLarge,
+  sizeB,
+  sizeGb,
+  sizeKb,
+  sizeMb,
+  starterBabylonJs,
+  starterBlank,
+  starterPhaser,
+  starterPixiJs,
+  starterThreeJs,
   timedOut,
   unableToFind,
   unableToParse,
   uploadFailed,
+  versionPrerelease,
+  versionRelease,
+  videoAspect,
+  videoDurationMax,
+  videoDurationMin,
+  videoHeightMin,
+  videoInvalid,
+  videoSizeMax,
+  videoUnsupported,
+  videoWidthMin,
 };

package/src/schema/game.js

@@ -64,8 +64,8 @@ const message = function (field, lines) {
 const zText = function (field, { max, min }) {
   return z
     .string()
-    .min(min)
-    .max(max)
+    .min(min, message(field, [`Must be at least: ${min} character`]))
+    .max(max, message(field, [`Must not exceed: ${max} characters`]))
     .regex(
       /^[\p{L}0-9 .,!?'"():;-]+$/u,
       message(field, ["Contains invalid characters."]),
@@ -77,7 +77,7 @@ const zText = function (field, { max, min }) {
 const zMedia = function (field, root) {
   return z
     .string()
-    .min(1)
+    .min(1, message(field, ["Must be defined."]))
     .refine(
       (file) => isRelativeCheck(root, file),
       message(field, ["Must be a relative path."]),
@@ -199,7 +199,7 @@ const zBannerVideo = function (root) {
 
 const zBio = function () {
   const field = "bio";
-  return z.optional(zText(field, { max: 192, min: 1 }));
+  return z.optional(zText(field, { max: 30 * 5, min: 1 }));
 };
 
 // [function]
@@ -237,8 +237,8 @@ const zDescription = function () {
   return z.optional(
     z
       .string()
-      .min(1)
-      .max(4000)
+      .min(1, message(field, ["Must be at least: 1 character"]))
+      .max(3000, message(field, ["Must not exceed: 3000 characters"]))
       .refine(
         (str) =>
           str ===
@@ -297,16 +297,19 @@ const zGallery = function (root) {
           }
         }),
       )
-      .min(1)
-      .max(12),
+      .max(12, message(field, ["Must not exceed: 12 elements"])),
   );
 };
 
 // [function]
 
 const zGenres = function () {
-  // const field = "genres";
-  return z.optional(z.array(z.enum(cfggenre)).max(3));
+  const field = "genres";
+  return z.optional(
+    z
+      .array(z.enum(cfggenre))
+      .max(3, message(field, ["Must not exceed: 3 elements"])),
+  );
 };
 
 // [function]
@@ -372,8 +375,12 @@ const zId = function () {
 // [function]
 
 const zInputs = function () {
-  // const field = "inputs";
-  return z.optional(z.array(z.enum(cfginput)).max(3));
+  const field = "inputs";
+  return z.optional(
+    z
+      .array(z.enum(cfginput))
+      .max(3, message(field, ["Must not exceed: 3 elements"])),
+  );
 };
 
 // [function]
@@ -414,29 +421,34 @@ const zPosterVideo = function (root) {
 // [function]
 
 const zPrice = function () {
-  // const field = "price";
-  return z.optional(z.int().min(0).max(25));
+  const field = "price";
+  return z.optional(
+    z
+      .int()
+      .min(0, message(field, ["Must not be below: 0"]))
+      .max(25, message(field, ["Must not be above: 25"])),
+  );
 };
 
 // [function]
 
 const zShortTitle = function () {
   const field = "short_title";
-  return z.optional(zText(field, { max: 16, min: 1 }));
+  return z.optional(zText(field, { max: 30 / 2, min: 1 }));
 };
 
 // [function]
 
 const zTagline = function () {
   const field = "tagline";
-  return z.optional(zText(field, { max: 96, min: 1 }));
+  return z.optional(zText(field, { max: 30 * 1, min: 1 }));
 };
 
 // [function]
 
 const zTitle = function () {
   const field = "title";
-  return z.optional(zText(field, { max: 64, min: 1 }));
+  return z.optional(zText(field, { max: 30 * 1, min: 1 }));
 };
 
 // [function]
@@ -445,7 +457,7 @@ const zTrailer = function () {
   const field = "trailer";
   return z
     .string()
-    .max(255)
+    .max(255, message(field, ["Must not exceed: 255 characters"]))
     .refine(
       (url) =>
         zVimeo().safeParse(url).success || zYouTube().safeParse(url).success,

package/src/util/bytes.js

@@ -1,17 +1,22 @@
 "use strict";
 
+// [import]
+
+const phrase = require("../phrase");
+const size = require("./size");
+
 // [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`;
+    case bytes >= size.gb(1):
+      return phrase.sizeGb(size.toGb(bytes).toFixed(1));
+    case bytes >= size.mb(1):
+      return phrase.sizeMb(size.toMb(bytes).toFixed(1));
+    case bytes >= size.kb(1):
+      return phrase.sizeKb(size.toKb(bytes).toFixed(1));
     default:
-      return `${(bytes / 1024 / 1024 / 1024).toFixed(1)} GB`;
+      return phrase.sizeB(size.toB(bytes));
   }
 };
 

package/src/util/http.js

@@ -1,5 +1,9 @@
 "use strict";
 
+// [import]
+
+const phrase = require("../phrase");
+
 // [class]
 
 const HttpError = class extends Error {
@@ -10,7 +14,7 @@ const HttpError = class extends Error {
     super(message);
     this.status = status;
     this.name = title;
-    this.message = `HttpError: ${this.name} (${this.status})`;
+    this.message = phrase.httpError(this.name, this.status);
   }
 };
 

package/src/util/image.js

@@ -13,6 +13,7 @@ const imageSize = require("image-size").imageSize;
 
 const bytes = require("./bytes");
 const cfgimage = require("../config/image");
+const phrase = require("../phrase");
 
 // [use]
 
@@ -52,18 +53,18 @@ const checkSize = function (file, maxSize) {
 
 const checkPng = function (file, { aspect, maxSize, minHeight, minWidth }) {
   if (!checkSize(file, maxSize)) {
-    return [`Image size must not exceed: ${formatBytes(maxSize)}`];
+    return [phrase.imageSizeMax(formatBytes(maxSize))];
   }
   const buffer = readFileSync(file);
   const { height, width } = imageSize(buffer);
   if (minWidth && width < minWidth) {
-    return [`Image width must be at least: ${minWidth}px`];
+    return [phrase.imageWidthMin(minWidth)];
   }
   if (minHeight && height < minHeight) {
-    return [`Image height must be at least: ${minHeight}px`];
+    return [phrase.imageHeightMin(minHeight)];
   }
   if (!checkAspect(width, height, aspect)) {
-    return [`Image aspect ratio must be: ${aspect}`];
+    return [phrase.imageAspect(aspect)];
   }
   return [];
 };
@@ -72,7 +73,7 @@ const checkPng = function (file, { aspect, maxSize, minHeight, minWidth }) {
 
 const checkSvg = function (file, { maxSize }) {
   if (!checkSize(file, maxSize)) {
-    return [`Image size must not exceed: ${formatBytes(maxSize)}`];
+    return [phrase.imageSizeMax(formatBytes(maxSize))];
   }
   return [];
 };
@@ -87,7 +88,7 @@ const check = function (file, { type, ...opts }) {
   const checkImage = checks[type];
   return checkImage && cfgimage[extname(file)] === type
     ? checkImage(file, opts)
-    : ["Image has an unsupported file type."];
+    : [phrase.imageUnsupported()];
 };
 
 // [export]

package/src/util/size.js

@@ -2,28 +2,52 @@
 
 // [function]
 
-const b = function (value) {
-  return value;
+const b = function (bytes) {
+  return bytes;
 };
 
 // [function]
 
-const kb = function (value) {
-  return b(value * 1024);
+const kb = function (bytes) {
+  return b(bytes * 1024);
 };
 
 // [function]
 
-const mb = function (value) {
-  return kb(value * 1024);
+const mb = function (bytes) {
+  return kb(bytes * 1024);
 };
 
 // [function]
 
-const gb = function (value) {
-  return mb(value * 1024);
+const gb = function (bytes) {
+  return mb(bytes * 1024);
+};
+
+// [function]
+
+const toB = function (bytes) {
+  return bytes;
+};
+
+// [function]
+
+const toKb = function (bytes) {
+  return toB(bytes / 1024);
+};
+
+// [function]
+
+const toMb = function (bytes) {
+  return toKb(bytes / 1024);
+};
+
+// [function]
+
+const toGb = function (bytes) {
+  return toMb(bytes / 1024);
 };
 
 // [export]
 
-module.exports = { b, gb, kb, mb };
+module.exports = { b, gb, kb, mb, toB, toGb, toKb, toMb };

package/src/util/video.js

@@ -94,29 +94,29 @@ const checkMp4 = function (
   { aspect, maxDuration, maxSize, minDuration, minHeight, minWidth },
 ) {
   if (!checkSize(file, maxSize)) {
-    return [`Video size must not exceed: ${formatBytes(maxSize)}`];
+    return [phrase.videoSizeMax(formatBytes(maxSize))];
   }
   let video = null;
   try {
     video = readMp4(file);
   } catch {
-    return ["Video is an invalid file."];
+    return [phrase.videoInvalid()];
   }
   const { duration, height, width } = video;
   if (minWidth && width < minWidth) {
-    return [`Video width must be at least: ${minWidth}px`];
+    return [phrase.videoWidthMin(minWidth)];
   }
   if (minHeight && height < minHeight) {
-    return [`Video height must be at least: ${minHeight}px`];
+    return [phrase.videoHeightMin(minHeight)];
   }
   if (minDuration && duration < minDuration) {
-    return [`Video duration must be at least: ${minDuration}s`];
+    return [phrase.videoDurationMin(minDuration)];
   }
   if (maxDuration && duration > maxDuration) {
-    return [`Video duration must not exceed: ${maxDuration}s`];
+    return [phrase.videoDurationMax(maxDuration)];
   }
   if (!checkAspect(width, height, aspect)) {
-    return [`Video aspect ratio must be: ${aspect}`];
+    return [phrase.videoAspect(aspect)];
   }
   return [];
 };
@@ -130,7 +130,7 @@ const check = function (file, { type, ...opts }) {
   const checkVideo = checks[type];
   return checkVideo && cfgvideo[extname(file)] === type
     ? checkVideo(file, opts)
-    : ["Video has an unsupported file type."];
+    : [phrase.videoUnsupported()];
 };
 
 // [export]

package/src/prompt/template.js

@@ -1,46 +0,0 @@
-"use strict";
-
-// [import]
-
-const cfgproduct = require("../config/product");
-
-// [declare]
-
-const HANDLE = cfgproduct.handle;
-const STARTER = `${HANDLE}/starter`;
-
-// [export]
-
-module.exports = {
-  select: {
-    choices: [
-      {
-        description: "Blank JavaScript starter.",
-        name: "Blank",
-        value: STARTER,
-      },
-      {
-        description: "Three.js starter.",
-        name: "Three.js",
-        value: `${STARTER}-threejs`,
-      },
-      {
-        description: "Phaser starter.",
-        name: "Phaser",
-        value: `${STARTER}-phaser`,
-      },
-      {
-        description: "PixiJS starter.",
-        name: "PixiJS",
-        value: `${STARTER}-pixijs`,
-      },
-      {
-        description: "Babylon.js starter.",
-        name: "Babylon.js",
-        value: `${STARTER}-babylonjs`,
-      },
-    ],
-    default: STARTER,
-    message: "Template",
-  },
-};