arcadible 1.0.1 → 1.0.4

package/src/schema/workflow.js

@@ -68,7 +68,7 @@ const zDeployDir = function (root, { build }) {
   return z
     .string()
     .min(1, {
-      ...message(field, ["Must not be empty. Leave the field out instead."]),
+      ...message(field, ["Must not be empty.", "Leave the field out instead."]),
       abort: true,
     })
     .refine((file) => isRelativeCheck(root, file), {
@@ -82,24 +82,20 @@ const zDeployDir = function (root, { build }) {
     .refine((file) => !isRootCheck(root, file), {
       ...message(
         field,
-        ["Must be a directory inside the project, not the project root."],
+        ["Must be a folder in the project, not its root."],
         ISSUE.PATH_INVALID,
       ),
       abort: true,
     })
     .refine((file) => avoidsCheck(root, file, MEDIA), {
-      ...message(
-        field,
-        [`Must not contain ${MEDIA} in path.`],
-        ISSUE.PATH_INVALID,
-      ),
+      ...message(field, [`Must not be in ${MEDIA}.`], ISSUE.PATH_INVALID),
       abort: true,
     })
     .refine((file) => hasBuild(build) || existsCheck(root, file), {
       ...message(
         field,
         [
-          "Must exist when no build step is defined.",
+          "Must exist, since there's no build.",
           `Run ${phrase.cmdInspect()} for details.`,
         ],
         ISSUE.PATH_INVALID,
@@ -118,7 +114,8 @@ const zDeployDir = function (root, { build }) {
       ...message(
         field,
         [
-          `Must not have ${RESERVED.join(" or ")} at its root. They're reserved for the files ${cfgproduct.title} adds.`,
+          `Must not have ${RESERVED.join(" or ")} at its root.`,
+          `They're reserved for the files ${cfgproduct.title} adds.`,
         ],
         ISSUE.PATH_INVALID,
       ),
@@ -128,7 +125,8 @@ const zDeployDir = function (root, { build }) {
       ...message(
         field,
         [
-          `Must not have an ${RESERVED_FOLDER} folder at its root, in any letter case. It's reserved for ${cfgproduct.title}'s own files.`,
+          `Must not have an ${RESERVED_FOLDER} folder at its root, in any letter case.`,
+          `It's reserved for ${cfgproduct.title}'s own files.`,
         ],
         ISSUE.PATH_INVALID,
       ),

package/src/serve/game.js

@@ -98,7 +98,13 @@ const sendFile = function (req, res, file, headers) {
     res.end();
     return;
   }
-  file.open(range).pipe(res);
+  // the file can go between finding and reading it, as a rebuild empties
+  // deploy_dir: the headers are sent, so the response just ends
+  const stream = file.open(range);
+  stream.on("error", () => {
+    res.destroy();
+  });
+  stream.pipe(res);
 };
 
 // [function]

package/src/serve/page.js

@@ -24,6 +24,17 @@ const SANDBOX =
 const HOST = "/_arcadible/host.js";
 const RELOAD = "/_arcadible/reload";
 
+// [declare]
+
+// the headers of the page's responses, as the play page's: it's
+// cross-origin isolated, and nothing frames it.
+const HEADERS = {
+  "cache-control": "no-store",
+  "content-security-policy": "frame-ancestors 'none';",
+  "cross-origin-embedder-policy": "require-corp",
+  "cross-origin-opener-policy": "same-origin",
+};
+
 // [function]
 
 // `value` as JSON that's safe inside a <script>.
@@ -105,17 +116,6 @@ const html = function (game) {
 
 // [function]
 
-// the headers of the page's responses, as the play page's: it's
-// cross-origin isolated, and nothing frames it.
-const HEADERS = {
-  "cache-control": "no-store",
-  "content-security-policy": "frame-ancestors 'none';",
-  "cross-origin-embedder-policy": "require-corp",
-  "cross-origin-opener-policy": "same-origin",
-};
-
-// [function]
-
 // the request handler for the page's origin. `reloads` keeps the pages
 // listening for a reload; `remote` has the host.
 const pageHandler = function ({

package/src/serve/reload.js

@@ -52,6 +52,11 @@ const watchDir = function (dir, onChange) {
     clearTimeout(timer);
     timer = setTimeout(onChange, SETTLE);
   });
+  // deploy_dir removed while it's watched (EPERM on Windows): stop watching
+  // rather than crash the server
+  watcher.on("error", () => {
+    watcher.close();
+  });
   return () => {
     clearTimeout(timer);
     watcher.close();

package/src/util/log.js

@@ -30,6 +30,13 @@ const log = function (out, message, { bold = false, color, nl = false } = {}) {
 
 // [function]
 
+// a warning, marked with ⚠ (OUTPUT.md), on its first line.
+const warned = function (message) {
+  return `⚠ ${[message].flat().join("\n").trim()}`;
+};
+
+// [function]
+
 const h = function (message) {
   log(console.log, message, { bold: true });
 };
@@ -91,13 +98,13 @@ const hwo = function (message) {
 // [function]
 
 const pw = function (message) {
-  log(console.warn, message, { color: "yellow" });
+  log(console.warn, warned(message), { color: "yellow" });
 };
 
 // [function]
 
 const nlpw = function (message) {
-  log(console.warn, message, { color: "yellow", nl: true });
+  log(console.warn, warned(message), { color: "yellow", nl: true });
 };
 
 // [function]

package/src/util/md.js

@@ -32,7 +32,7 @@ const escape = function (str) {
     .replace(/>/gu, ">");
 };
 
-// [declare]
+// [define]
 
 // there is no video syntax in Markdown, so an image of a video renders as the
 // video the developer would have written: its src and title, and no alt.

package/src/util/output.js

@@ -59,6 +59,20 @@ const print = function (data, { key, nl, toml } = {}) {
 
 // [function]
 
+// exits with `code` once stdout has written what it holds. A pipe on macOS
+// writes later, so exiting at once would cut a large --json document short;
+// with nothing held, it exits at once, as a caller that goes on expects.
+const exit = function (code) {
+  if (!process.stdout.writableLength) {
+    process.exit(code);
+  }
+  process.exitCode = code;
+  process.stdout.write("", () => process.exit(code));
+  return new Promise(() => {});
+};
+
+// [function]
+
 // a command's error path: the error as JSON, or its heading ("Deploy
 // aborted.") and the reason on stderr, then its code and the link to it on
 // the Errors page, once the spinner and progress bar are cleared. Then exits
@@ -102,7 +116,7 @@ const abort = function (
     log.pd(message);
     log.nlpd([phrase.errorCode(shown), chalk.cyan.underline(link)]);
   }
-  process.exit(1);
+  return exit(1);
 };
 
 // [function]
@@ -128,7 +142,7 @@ const warn = function (warnings, { json, quiet } = {}) {
   if (json || quiet) {
     return;
   }
-  warnings.forEach((each) => log.pw(`⚠ ${schema.print(each)}`));
+  warnings.forEach((each) => log.pw(schema.print(each)));
 };
 
 // [function]
@@ -150,6 +164,7 @@ const warning = function (code, message, path = null) {
 
 module.exports = {
   abort,
+  exit,
   launched,
   print,
   printJson,

package/src/util/schema.js

@@ -17,6 +17,14 @@ const ISSUE = cfgcode.ISSUE;
 
 // [declare]
 
+// how a value's kind is named, as TOML writes it.
+const KINDS = {
+  array: "a list",
+  boolean: "true or false",
+  number: "a number",
+  object: "a table",
+  string: "a string",
+};
 const NUMBERS = new Set(["bigint", "int", "number"]);
 
 // [function]
@@ -65,11 +73,54 @@ const issueCodeOf = function (issue) {
 
 // [function]
 
+// a value's kind, as TOML writes it: "a string", "a list", "a table".
+const kindOf = function (type) {
+  return KINDS[type] ?? `a ${type}`;
+};
+
+// [function]
+
+// what zod reports itself (a value of the wrong type, or not one of the
+// options), in arc's words, as `{ message, details }`: "Must be a string, not
+// a number." Null for a message of our own.
+const zodMessage = function (issue) {
+  if (issue.code === "invalid_value" && issue.values) {
+    return { details: [issue.values.join(", ")], message: "Must be one of:" };
+  }
+  const given = Array.isArray(issue.input) ? "array" : typeof issue.input;
+  if (issue.code === "invalid_type" && typeof issue.input !== "undefined") {
+    return {
+      details: [],
+      message: `Must be ${kindOf(issue.expected)}, not ${kindOf(given)}.`,
+    };
+  }
+  if (
+    issue.code === "invalid_union" &&
+    issue.errors.every((branch) =>
+      branch.every((each) => each.code === "invalid_type"),
+    )
+  ) {
+    const expected = [
+      ...new Set(issue.errors.map((branch) => kindOf(branch[0].expected))),
+    ];
+    return {
+      details: [],
+      message: `Must be ${expected.join(" or ")}, not ${kindOf(given)}.`,
+    };
+  }
+  return null;
+};
+
+// [function]
+
 // a zod issue as arc validate reports it: the field's path, the rule's code,
 // the message's first line and its details, and the link to the field's
 // rules, or null for a field the docs leave out.
 const toIssue = function (name, issue) {
-  const { details, message } = schemaMessage.parse(issue.message);
+  const parsed = schemaMessage.parse(issue.message);
+  const { details, message } =
+    (/^Invalid (input|option)\b/u.test(parsed.message) && zodMessage(issue)) ||
+    parsed;
   return {
     code: issueCodeOf(issue),
     details,
@@ -133,5 +184,6 @@ module.exports = {
   dereference,
   issueCodeOf,
   print,
+  toIssue,
   validator,
 };