arcadible 0.1.44 → 0.1.46

package/src/phrase.js

@@ -32,6 +32,13 @@ const waited = function (seconds) {
 
 // [function]
 
+// a command's heading when it fails: `Deploy aborted.`
+const aborted = function (command) {
+  return `${command[0].toUpperCase()}${command.slice(1)} aborted.`;
+};
+
+// [function]
+
 // a build that exited with `code`, or was stopped by `signal`, with what it
 // wrote to stderr.
 const buildFailed = function ({ code, signal, stderr }) {
@@ -71,12 +78,30 @@ const buildSubmitted = function (version, channel, built) {
 
 // [function]
 
+const buildSucceeded = function () {
+  return "Built.";
+};
+
+// [function]
+
+const cmdBuild = function () {
+  return `\`${TOOL} build\``;
+};
+
+// [function]
+
 const cmdDeploy = function () {
   return `\`${TOOL} deploy\``;
 };
 
 // [function]
 
+const cmdDeployGit = function () {
+  return `\`${TOOL} deploy git\``;
+};
+
+// [function]
+
 const cmdInit = function () {
   return `\`${TOOL} init\``;
 };
@@ -104,12 +129,18 @@ const cmdValidate = function () {
 const deployDirMissing = function (dir) {
   return blocks(
     `Unable to find deploy_dir: ${dir}`,
-    "Run `arc build`, or set deploy_dir to the folder your build writes.",
+    `Run ${cmdBuild()}, or set deploy_dir to the folder your build writes.`,
   );
 };
 
 // [function]
 
+const didYouMean = function (near) {
+  return `Did you mean: ${near}?`;
+};
+
+// [function]
+
 const docAttrInvalid = function (tag, attr, value) {
   return `Value '${value}' is not valid for the '${attr}' attribute on the '${tag}' tag.`;
 };
@@ -140,20 +171,22 @@ const docMediaMissing = function (src) {
 
 // [function]
 
-const docMediaType = function (src) {
-  return `Must be a PNG or MP4 file: ${src}`;
+// a description media src that isn't written as the gallery's path to it,
+// such as `./.arcadible/gallery/x.png`: Arcadible matches it as written.
+const docMediaPath = function (src, gallery) {
+  return `Must be written as ${gallery}/<file>: ${src}`;
 };
 
 // [function]
 
-const docTagUnallowed = function (tag) {
-  return `Tag '${tag}' is not permitted.`;
+const docMediaType = function (src) {
+  return `Must be a PNG or MP4 file: ${src}`;
 };
 
 // [function]
 
-const docUnsupported = function () {
-  return "Document has an unsupported file type.";
+const docTagUnallowed = function (tag) {
+  return `Tag '${tag}' is not permitted.`;
 };
 
 // [function]
@@ -165,8 +198,11 @@ const errorCode = function (code) {
 
 // [function]
 
-const gameExists = function (idOrHandle) {
-  return `Game exists: ${idOrHandle}`;
+const gameHandleTaken = function (handle) {
+  return blocks(
+    `Handle taken: ${handle}`,
+    "Choose another handle in arcadible.toml.",
+  );
 };
 
 // [function]
@@ -180,8 +216,76 @@ const gameNotDeployed = function (game) {
 
 // [function]
 
+const initialized = function () {
+  return "Initialized.";
+};
+
+// [function]
+
+// the heading of arc validate's list of issues, warnings, or references:
+// `2 issues:`
+const listed = function (count, noun) {
+  return `${count} ${noun}${count === 1 ? "" : "s"}:`;
+};
+
+// [function]
+
+const loggedIn = function () {
+  return "Logged in.";
+};
+
+// [function]
+
+const loggedOut = function () {
+  return "Logged out.";
+};
+
+// [function]
+
+const loggingIn = function () {
+  return "Logging in...";
+};
+
+// [function]
+
+const noAccount = function () {
+  return "Not logged in.";
+};
+
+// [function]
+
+const noIssuesFound = function () {
+  return "No issues found.";
+};
+
+// [function]
+
+const nothingToDo = function () {
+  return "Nothing to do.";
+};
+
+// [function]
+
+const packed = function () {
+  return "Packed.";
+};
+
+// [function]
+
+const pressEnterToOpen = function () {
+  return "Press Enter to open the URL.";
+};
+
+// [function]
+
+const releaseFailedHeading = function () {
+  return "Release failed.";
+};
+
+// [function]
+
 // origin isn't the game's connected repository: none is, or another is.
-const gameRepoMissing = function (game, repo, url) {
+const repoNotConnected = function (game, repo, url) {
   return blocks(`${repo} isn't ${game}'s repository on ${TITLE}.`, [
     `The game's owner connects it in ${TITLE} Studio, on the game's Repository tab, and connects it again if it was renamed on GitHub:`,
     url,
@@ -205,7 +309,7 @@ const gameUnavailable = function (id) {
 
 // [function]
 
-const gitChangesPresent = function () {
+const gitUncommitted = function () {
   return blocks(
     "Uncommitted changes found.",
     "Commit, stash, or discard them first.",
@@ -232,12 +336,12 @@ const gitRemoteUnreachable = function () {
 
 // [function]
 
-const noManifest = function (file, dir, found) {
+const manifestMissing = function (file, dir, found) {
   return blocks(
     dir === "." ? `No ${file} in this directory.` : `No ${file} in ${dir}.`,
     found
-      ? `The project is in \`${found}\`: run arc there, or pass \`-C ${found}\`.`
-      : "Run arc in the project's directory, or pass -C, or start a project with `arc init`.",
+      ? `The project is in \`${found}\`: run ${TOOL} there, or pass \`-C ${found}\`.`
+      : `Run ${TOOL} in the project's directory, or pass \`-C\`, or start a project with ${cmdInit()}.`,
   );
 };
 
@@ -245,8 +349,8 @@ const noManifest = function (file, dir, found) {
 
 const projectNotRepoRoot = function (prefix) {
   return blocks(
-    `arc deploy git releases the project at the repository's root, and this one is in ${prefix}`,
-    "Deploy it with `arc deploy`, or give it a repository of its own.",
+    `${cmdDeployGit()} releases the project at the repository's root, and this one is in ${prefix}.`,
+    `Deploy it with ${cmdDeploy()}, or give it a repository of its own.`,
   );
 };
 
@@ -279,7 +383,7 @@ const gitTagPushFailed = function (version) {
 
 // [function]
 
-const gitVersionExists = function (version) {
+const gitTagExists = function (version) {
   return blocks(
     `Git tag for v${version} already exists, here or on origin.`,
     "Bump the version.",
@@ -387,16 +491,16 @@ const loginFailed = function () {
 
 // [function]
 
-const noGameId = function () {
+const gameIdMissing = function () {
   return blocks(
     "No game handle or ID.",
-    `Pass one, or run ${cmdInit()} to add an ID.`,
+    `Pass one, or run it in a project after ${cmdInit()} has added an ID.`,
   );
 };
 
 // [function]
 
-const noLockFile = function () {
+const lockfileMissing = function () {
   return blocks("No lockfile found.", [
     "Install your dependencies to create one.",
     "Then commit it.",
@@ -411,7 +515,7 @@ const noProductionRelease = function () {
 
 // [function]
 
-const noTemplate = function () {
+const templateMissing = function () {
   return blocks("No template chosen.", [
     "Pass `--template <user/repo>`.",
     "Or pass `--yes` for the blank starter.",
@@ -421,7 +525,7 @@ const noTemplate = function () {
 // [function]
 
 const notLoggedIn = function () {
-  return blocks("Not logged in.", `Run ${cmdLogin()} to log in.`);
+  return blocks(noAccount(), `Run ${cmdLogin()} to log in.`);
 };
 
 // [function]
@@ -450,7 +554,7 @@ const openToContinue = function () {
 
 // [function]
 
-const packageFileMissing = function (file) {
+const packageIndexMissing = function (file) {
   return `Package is missing '${file}'.`;
 };
 
@@ -619,12 +723,6 @@ const templateUnavailable = function (template) {
 
 // [function]
 
-const timedOut = function () {
-  return "Timed out.";
-};
-
-// [function]
-
 const unableToFind = function (file) {
   return `Unable to find: ${file}`;
 };
@@ -638,7 +736,7 @@ const unableToOpen = function () {
 // [function]
 
 const unableToParse = function (file, message) {
-  return blocks(`Unable to parse ${file}.`, message);
+  return blocks(`Unable to parse ${file}.`, message.trim());
 };
 
 // [function]
@@ -652,6 +750,18 @@ const unableToReach = function () {
 
 // [function]
 
+const unknownField = function () {
+  return "Unknown field.";
+};
+
+// [function]
+
+const unknownTable = function () {
+  return "Unknown table.";
+};
+
+// [function]
+
 const uploadFailed = function (status) {
   return `Upload failed with status ${status}.`;
 };
@@ -667,6 +777,12 @@ const uploadRateLimited = function (version) {
 
 // [function]
 
+const waitTimedOut = function () {
+  return "Wait timed out.";
+};
+
+// [function]
+
 const workflowMissing = function (file) {
   return blocks(
     `No release workflow found: ${file}`,
@@ -684,7 +800,7 @@ const versionPrerelease = function (version) {
 
 // a version that's already published, with what is, so the developer knows
 // what to bump to.
-const versionPublished = function (version, { next, production, staging }) {
+const versionExists = function (version, { next, production, staging }) {
   const latest = [
     production ? `Production: ${production}` : null,
     staging ? `Staging: ${staging}` : null,
@@ -777,35 +893,38 @@ const videoWidthMin = function (width) {
 // [export]
 
 module.exports = {
+  aborted,
   buildFailed,
   buildOutputMissing,
   buildPublishing,
   buildPublishingGit,
   buildSubmitted,
+  buildSucceeded,
   cmdInit,
   cmdInspect,
   deployDirMissing,
+  didYouMean,
   docAttrInvalid,
   docAttrUnallowed,
   docCommentUnallowed,
   docMediaElement,
   docMediaMissing,
+  docMediaPath,
   docMediaType,
   docTagUnallowed,
-  docUnsupported,
   errorCode,
-  gameExists,
+  gameHandleTaken,
+  gameIdMissing,
   gameNotDeployed,
   gameNotFound,
-  gameRepoMissing,
   gameUnavailable,
-  gitChangesPresent,
   gitRemoteMissing,
   gitRemoteUnreachable,
   gitRepoMissing,
   gitTagCreateFailed,
+  gitTagExists,
   gitTagPushFailed,
-  gitVersionExists,
+  gitUncommitted,
   httpError,
   imageAspect,
   imageFound,
@@ -816,30 +935,40 @@ module.exports = {
   imageUnsupported,
   imageWidthMax,
   imageWidthMin,
+  initialized,
   issuesAfterBuild,
   issuesFound,
+  listed,
+  lockfileMissing,
+  loggedIn,
+  loggedOut,
+  loggingIn,
   loginCodeExpired,
   loginFailed,
-  noGameId,
-  noLockFile,
-  noManifest,
+  manifestMissing,
+  noAccount,
+  noIssuesFound,
   noProductionRelease,
-  noTemplate,
   noVideoMetadata,
   noVideoTrack,
   notLoggedIn,
+  nothingToDo,
   openToContinue,
   opened,
-  packageFileMissing,
   packageFileTooLarge,
+  packageIndexMissing,
   packageTooLarge,
   packageTooManyFiles,
   packageUncompressedTooLarge,
+  packed,
+  pressEnterToOpen,
   projectNotRepoRoot,
   releaseFailed,
+  releaseFailedHeading,
   releasePublished,
   releaseTimedOut,
   releaseWaiting,
+  repoNotConnected,
   sessionExpired,
   sizeB,
   sizeGb,
@@ -851,17 +980,19 @@ module.exports = {
   starterPixiJs,
   starterThreeJs,
   tagPushed,
+  templateMissing,
   templateUnavailable,
-  timedOut,
   timeoutInvalid,
   unableToFind,
   unableToOpen,
   unableToParse,
   unableToReach,
+  unknownField,
+  unknownTable,
   uploadFailed,
   uploadRateLimited,
+  versionExists,
   versionPrerelease,
-  versionPublished,
   versionRelease,
   versionUnchecked,
   videoAspect,
@@ -875,5 +1006,6 @@ module.exports = {
   videoUnsupported,
   videoWidthMax,
   videoWidthMin,
+  waitTimedOut,
   workflowMissing,
 };

package/src/schema/game.js

@@ -14,13 +14,12 @@ const z = require("zod");
 const cfgai = require("../config/ai");
 const cfgaudience = require("../config/audience");
 const cfgcode = require("../config/code");
-const cfgdoc = require("../config/doc");
+const cfgfile = require("../config/file");
 const cfggenre = require("../config/genre");
 const cfghtml = require("../config/html");
 const cfgimage = require("../config/image");
 const cfginput = require("../config/input");
 const cfgorientation = require("../config/orientation");
-const cfgproduct = require("../config/product");
 const cfgvideo = require("../config/video");
 const cfgvisibility = require("../config/visibility");
 const chars = require("../util/chars");
@@ -38,6 +37,7 @@ const cleanSemver = semver.clean;
 const docCheck = check.doc;
 const existsCheck = check.exists;
 const extname = path.extname;
+const posixDirname = path.posix.dirname;
 const ISSUE = cfgcode.ISSUE;
 const imageCheck = check.image;
 const invalidChars = chars.invalid;
@@ -51,13 +51,12 @@ const videoCheck = check.video;
 
 // [declare]
 
-const HANDLE = cfgproduct.handle;
 const message = schemaMessage.messages("game");
 
 // [declare]
 
-const GALLERY = `.${HANDLE}/gallery`;
-const MEDIA = `.${HANDLE}`;
+const GALLERY = cfgfile.GALLERY;
+const MEDIA = cfgfile.MEDIA;
 
 // [declare]
 
@@ -144,15 +143,16 @@ const required = function (field, lines) {
 // [function]
 
 // a list of distinct values. Without a max, its length is up to the values.
-const zSet = function (field, schema, { max = Infinity, min }) {
-  return z
-    .array(schema)
-    .min(min, atLeast(field, min, "element"))
-    .max(max, message(field, [`Must not exceed: ${max} elements`]))
-    .refine(
-      (items) => new Set(items).size === items.length,
-      message(field, ["Must not contain duplicate elements."], ISSUE.DUPLICATE),
-    );
+const zSet = function (field, schema, { max, min }) {
+  const list = z.array(schema).min(min, atLeast(field, min, "element"));
+  return (
+    max
+      ? list.max(max, message(field, [`Must not exceed: ${max} elements`]))
+      : list
+  ).refine(
+    (items) => new Set(items).size === items.length,
+    message(field, ["Must not contain duplicate elements."], ISSUE.DUPLICATE),
+  );
 };
 
 // [function]
@@ -174,11 +174,17 @@ const zSetBasefile = function (field, schema, { max, min }) {
 
 // [function]
 
+// a string of `min` to `max` characters, counted as Arcadible counts them: a
+// character outside the Basic Multilingual Plane, such as an emoji, is one,
+// though JavaScript's length counts it as two.
 const zString = function (field, char, { max, min }) {
   return z
     .string()
     .min(min, { ...atLeast(field, min, "character"), abort: min === 1 })
-    .max(max, message(field, [`Must not exceed: ${max} characters`]))
+    .refine(
+      (str) => [...str].length <= max,
+      message(field, [`Must not exceed: ${max} characters`], ISSUE.TOO_LONG),
+    )
     .superRefine((str, ctx) => {
       const invalid = invalidChars(str, char);
       if (invalid.length) {
@@ -197,8 +203,12 @@ const zString = function (field, char, { max, min }) {
 
 // [function]
 
+// plain text, which can't be only spaces.
 const zText = function (field, opts) {
-  return zString(field, /[\p{L}0-9 .,!?'"():;-]/u, opts);
+  return zString(field, /[\p{L}0-9 .,!?'"():;-]/u, opts).refine(
+    (str) => str.trim() !== "",
+    message(field, ["Must not be blank."], ISSUE.EMPTY),
+  );
 };
 
 // [function]
@@ -206,7 +216,7 @@ const zText = function (field, opts) {
 const zHtml = function (field, root, { max, min, ...opts }) {
   const char = /[\p{L}\p{M}\p{N}\p{P}\p{S}\p{Zs}\r\n]/u;
   return zString(field, char, { max, min }).superRefine((str, ctx) => {
-    const issues = docCheck(root, str, { ...opts, type: cfgdoc[".html"] });
+    const issues = docCheck(root, str, opts);
     if (issues.length) {
       ctx.addIssue({
         code: "custom",
@@ -284,27 +294,34 @@ const zMp4 = function (field, root, opts) {
 const zPngMp4 = function (field, root, optsPng, optsMp4) {
   const pngSchema = zPng(field, root, optsPng);
   const mp4Schema = zMp4(field, root, optsMp4);
-  return z.string().superRefine((file, ctx) => {
-    const ext = extname(file);
-    let schema = null;
-    if (Object.hasOwn(cfgimage, ext)) {
-      schema = pngSchema;
-    }
-    if (Object.hasOwn(cfgvideo, ext)) {
-      schema = mp4Schema;
-    }
-    if (!schema) {
-      ctx.addIssue({
-        code: "custom",
-        ...message(field, ["Must be a PNG or MP4 file."], ISSUE.MEDIA_INVALID),
-      });
-      return;
-    }
-    const result = schema.safeParse(file);
-    if (!result.success) {
-      result.error.issues.forEach((issue) => ctx.addIssue(issue));
-    }
-  });
+  return z
+    .string()
+    .min(1, { ...atLeast(field, 1), abort: true })
+    .superRefine((file, ctx) => {
+      const ext = extname(file);
+      let schema = null;
+      if (Object.hasOwn(cfgimage, ext)) {
+        schema = pngSchema;
+      }
+      if (Object.hasOwn(cfgvideo, ext)) {
+        schema = mp4Schema;
+      }
+      if (!schema) {
+        ctx.addIssue({
+          code: "custom",
+          ...message(
+            field,
+            ["Must be a PNG or MP4 file."],
+            ISSUE.MEDIA_INVALID,
+          ),
+        });
+        return;
+      }
+      const result = schema.safeParse(file);
+      if (!result.success) {
+        result.error.issues.forEach((issue) => ctx.addIssue(issue));
+      }
+    });
 };
 
 // [function]
@@ -383,6 +400,10 @@ const checkSrc = function (root, src, tag) {
   ) {
     return false;
   }
+  // the store page finds it by the gallery's path, exactly.
+  if (posixDirname(src) !== GALLERY) {
+    return phrase.docMediaPath(src, GALLERY);
+  }
   return existsCheck(root, src) || phrase.docMediaMissing(src);
 };
 
@@ -465,6 +486,7 @@ const zId = function () {
     .string(
       required(field, [`Run ${phrase.cmdInit()} to generate a new game ID.`]),
     )
+    .min(1, { ...atLeast(field, 1), abort: true })
     .uuid(message(field, ["Must be a valid UUID."]))
     .refine(
       (value) => value === value.toLowerCase(),
@@ -542,10 +564,11 @@ const zVersion = function () {
     .string(
       required(field, ["A version is required unless one can be derived."]),
     )
-    .refine(
-      (value) => validSemver(value) !== null,
-      message(field, ["Must be valid semver."], ISSUE.VERSION_INVALID),
-    )
+    .min(1, { ...atLeast(field, 1), abort: true })
+    .refine((value) => validSemver(value) !== null, {
+      ...message(field, ["Must be valid semver."], ISSUE.VERSION_INVALID),
+      abort: true,
+    })
     .refine(
       // lowercase too, since the database refuses an uppercase prerelease.
       (value) => cleanSemver(value) === value && value === value.toLowerCase(),

package/src/schema/workflow.js

@@ -7,14 +7,17 @@ const z = require("zod");
 // [import]
 
 const cfgcode = require("../config/code");
+const cfgfile = require("../config/file");
 const cfgproduct = require("../config/product");
 const check = require("./check/workflow");
+const commands = require("../util/command");
 const phrase = require("../phrase");
 const schemaMessage = require("./message");
 
 // [use]
 
 const avoidsCheck = check.avoids;
+const buildCommand = commands.buildCommand;
 const ISSUE = cfgcode.ISSUE;
 const existsCheck = check.exists;
 const hasFileCheck = check.hasFile;
@@ -25,20 +28,16 @@ const lacksFilesCheck = check.lacksFiles;
 
 // [declare]
 
-const HANDLE = cfgproduct.handle;
 const message = schemaMessage.messages("workflow");
-const MEDIA = `.${HANDLE}`;
+const MEDIA = cfgfile.MEDIA;
 const INDEX = "index.html";
-const RESERVED = [`${HANDLE}.json`, MEDIA];
+const RESERVED = [cfgfile.PACKAGED, MEDIA];
 
 // [function]
 
-// whether `build` runs anything: a command that isn't blank, as `arc build`
-// trims and drops blank ones (action/build/tool.js).
+// whether `build` runs anything, as `arc build` runs it.
 const hasBuild = function (build) {
-  return [build]
-    .flat()
-    .some((cmd) => typeof cmd === "string" && cmd.trim() !== "");
+  return buildCommand(build) !== "";
 };
 
 // [function]