arcadible 0.1.44 → 0.1.46

package/src/util/argv.js

@@ -19,6 +19,11 @@ const parse = helpers.Parser;
 
 // [declare]
 
+// the --browser option of arc open and arc play.
+const BROWSER = {
+  describe: "Open in a web browser",
+  type: "boolean",
+};
 // the -C, --cwd option of every project command.
 const CWD = {
   alias: "C",
@@ -26,6 +31,18 @@ const CWD = {
   describe: "Set the working directory",
   type: "string",
 };
+// the -j, --json option, which prints one JSON document (OUTPUT.md).
+const JSON_OUTPUT = {
+  alias: "j",
+  describe: "Format output as JSON",
+  type: "boolean",
+};
+// the -q, --quiet option, which prints only errors.
+const QUIET = {
+  alias: "q",
+  describe: "Output only errors",
+  type: "boolean",
+};
 
 // [function]
 
@@ -87,4 +104,13 @@ const fail = function (argv) {
 
 // [export]
 
-module.exports = { CWD, cwd, fail, json, normalize };
+module.exports = {
+  BROWSER,
+  CWD,
+  JSON_OUTPUT,
+  QUIET,
+  cwd,
+  fail,
+  json,
+  normalize,
+};

package/src/util/command.js

@@ -0,0 +1,18 @@
+"use strict";
+
+// [function]
+
+// workflow.build as the shell runs it: each command trimmed, blank ones
+// dropped, and a list joined with `&&`. Blank when there's nothing to run.
+const buildCommand = function (build) {
+  return [build]
+    .flat()
+    .filter((cmd) => typeof cmd === "string")
+    .map((cmd) => cmd.trim())
+    .filter(Boolean)
+    .join(" && ");
+};
+
+// [export]
+
+module.exports = { buildCommand };

package/src/util/delay.js

@@ -1,21 +1,5 @@
 "use strict";
 
-// [import]
-
-const phrase = require("../phrase");
-const time = require("./time");
-
-// [declare]
-
-const POLL = {
-  delay: time.s(1),
-  factor: 1,
-  interval: time.m(1),
-  maxDelay: time.s(1),
-  timeout: Infinity,
-  timeoutError: phrase.timedOut(),
-};
-
 // [function]
 
 const backoff = function (elapsed, delay, factor, interval, maxDelay) {
@@ -39,10 +23,13 @@ const wait = function (delay, next) {
 
 // [function]
 
+// calls fn(value) until it resolves to something other than null, backing
+// off by `factor` every `interval`, up to `maxDelay`. After `timeout`, it
+// throws timeoutError(), the caller's own error, with its code.
 const poll = function (
   fn,
   value,
-  { delay, factor, interval, maxDelay, timeout, timeoutError } = POLL,
+  { delay, factor, interval, maxDelay, timeout, timeoutError },
 ) {
   const started = Date.now();
   const next = function () {
@@ -52,10 +39,7 @@ const poll = function (
       }
       const elapsed = Date.now() - started;
       if (elapsed >= timeout) {
-        // a function makes the caller's own error, with its code.
-        throw typeof timeoutError === "function"
-          ? timeoutError()
-          : new Error(timeoutError);
+        throw timeoutError();
       }
       return wait(backoff(elapsed, delay, factor, interval, maxDelay), next);
     });

package/src/util/doc.js

@@ -6,7 +6,6 @@ const jsdom = require("jsdom");
 
 // [import]
 
-const cfgdoc = require("../config/doc");
 const phrase = require("../phrase");
 
 // [use]
@@ -59,23 +58,15 @@ const checkNode = function (node, opts, issues) {
 
 // [function]
 
-// checks HTML as written, before anything sanitizes it: every element must be
-// allowed, with only its allowed attributes, each passing its hook. Each
-// problem is reported once.
-const checkHtml = function (str, { allowed, hooks = {} }) {
+// checks the description's HTML as written, before anything sanitizes it:
+// every element must be allowed, with only its allowed attributes, each
+// passing its hook. Each problem is reported once.
+const check = function (str, { allowed, hooks = {} }) {
   const issues = new Set();
   checkNode(JSDOM.fragment(str), { allowed, hooks }, issues);
   return [...issues];
 };
 
-// [function]
-
-const check = function (str, { type, ...opts }) {
-  const checks = { [cfgdoc[".html"]]: checkHtml };
-  const checkDoc = checks[type];
-  return checkDoc ? checkDoc(str, opts) : [phrase.docUnsupported()];
-};
-
 // [export]
 
 module.exports = { check };

package/src/util/links.js

@@ -41,13 +41,26 @@ const storePage = function (game) {
 
 // [function]
 
+// a game's store page on the web.
+const storeUrl = function (game) {
+  return `${cfguri.HOST_HTTP_WWW}${storePage(game)}`;
+};
+
+// [function]
+
+// a game's page in Studio, on one of its tabs, such as `builds`.
+const studioUrl = function (game, tab) {
+  return `${cfguri.HOST_HTTP_STUDIO}/games/${game}/${tab}`;
+};
+
+// [function]
+
 // where a deployed version will be, once it's published: its channel, that
 // channel's play link, and for production, its store page.
 const published = function ({ handle, id, version }) {
   const game = handle ?? id;
   const release = channel(version);
-  const store =
-    release === PRODUCTION ? `${cfguri.HOST_HTTP_WWW}${storePage(game)}` : null;
+  const store = release === PRODUCTION ? storeUrl(game) : null;
   return { channel: release, store, url: playUrl(game, release) };
 };
 
@@ -60,4 +73,6 @@ module.exports = {
   playUrl,
   published,
   storePage,
+  storeUrl,
+  studioUrl,
 };

package/src/util/media.js

@@ -2,12 +2,12 @@
 
 // [import]
 
-const limits = require("../action/pack/limits");
+const cfglimit = require("../config/limit");
 
 // [declare]
 
 // a file too large to pack isn't read.
-const MAX_READ = limits.MAX_FILE_SIZE;
+const MAX_READ = cfglimit.FILE_SIZE;
 
 // [function]
 

package/src/util/objs.js

@@ -29,10 +29,17 @@ const deepCompact = function (obj) {
 
 // [function]
 
+// a TOML table: an object, not an array.
+const isTable = function (value) {
+  return value !== null && typeof value === "object" && !Array.isArray(value);
+};
+
+// [function]
+
 const deepSort = function (obj) {
   return JSON.parse(stringify(obj));
 };
 
 // [export]
 
-module.exports = { deepCompact, deepSort };
+module.exports = { deepCompact, deepSort, isTable };

package/src/util/output.js

@@ -41,7 +41,7 @@ const printToml = function (data, key, nl = false) {
   }
   try {
     write(TOML.stringify(deepSort(data)), nl);
-  } catch (ex) {
+  } catch {
     write(TOML.stringify(deepSort({ [field]: data })), nl);
   }
 };
@@ -107,6 +107,20 @@ const abort = function (
 
 // [function]
 
+// where arc open or arc play opened the page, with its URL, or that it
+// couldn't, with the URL to open by hand.
+const launched = function (where, url) {
+  if (where) {
+    log.result(phrase.opened(where), [url]);
+    return;
+  }
+  log.result(phrase.unableToOpen(), [url, phrase.openToContinue()], {
+    color: "yellow",
+  });
+};
+
+// [function]
+
 // arc validate's warnings, such as an unknown field, on stderr in yellow,
 // before a command that validates goes on. Left out with `--json` and
 // `--quiet`; arc validate --json lists them.
@@ -134,4 +148,12 @@ const warning = function (code, message, path = null) {
 
 // [export]
 
-module.exports = { abort, print, printJson, printToml, warn, warning };
+module.exports = {
+  abort,
+  launched,
+  print,
+  printJson,
+  printToml,
+  warn,
+  warning,
+};

package/src/util/rc.js

@@ -81,7 +81,7 @@ const read = function (file) {
   let str = null;
   try {
     str = readFileSync(file, "utf8");
-  } catch (ex) {
+  } catch {
     return {};
   }
   if (!/^\s*\{/u.test(str)) {
@@ -111,7 +111,7 @@ const findRc = function (cmd, subcmd, argv) {
       {},
     );
   } catch (ex) {
-    return abort(`${subcmd[0].toUpperCase()}${subcmd.slice(1)} aborted.`, ex, {
+    return abort(phrase.aborted(subcmd), ex, {
       json: args.json(argv),
     });
   }

package/src/util/request.js

@@ -27,7 +27,7 @@ const json = function (resp) {
   return resp.text().then((text) => {
     try {
       return JSON.parse(text);
-    } catch (ex) {
+    } catch {
       return null;
     }
   });

package/src/util/s3.js

@@ -8,7 +8,7 @@ const https = require("node:https");
 // [import]
 
 const cfgcode = require("../config/code");
-const error = require("../util/error");
+const error = require("./error");
 const phrase = require("../phrase");
 
 // [use]

package/src/util/schema.js

@@ -24,7 +24,7 @@ const NUMBERS = new Set(["bigint", "int", "number"]);
 // a zod issue's code (config/code.js, ISSUE). Our own checks name theirs in
 // params; zod's built-in ones, which drop params, are named from what zod
 // reports. Anything else is `invalid`, so every issue has a code.
-const codeOf = function (issue) {
+const issueCodeOf = function (issue) {
   switch (issue.code) {
     case "custom":
       return issue.params?.code ?? ISSUE.INVALID;
@@ -71,7 +71,7 @@ const codeOf = function (issue) {
 const toIssue = function (name, issue) {
   const { details, message } = schemaMessage.parse(issue.message);
   return {
-    code: codeOf(issue),
+    code: issueCodeOf(issue),
     details,
     link: issue.path.length
       ? schemaMessage.link(name, String(issue.path[0]))
@@ -128,4 +128,10 @@ const validator = function (name, schema) {
 
 // [export]
 
-module.exports = { codeOf, compare, dereference, print, validator };
+module.exports = {
+  compare,
+  dereference,
+  issueCodeOf,
+  print,
+  validator,
+};

package/src/util/uris.js

@@ -8,7 +8,7 @@
 const isSafeUri = function (uri) {
   try {
     return new URL(uri).protocol === "https:";
-  } catch (ex) {
+  } catch {
     return false;
   }
 };

package/src/util/zip.js

@@ -21,7 +21,7 @@ const join = path.posix.join;
 
 // [class]
 
-const Main = class {
+const Zip = class {
 
   // [constructor]
 
@@ -85,4 +85,4 @@ const Main = class {
 
 // [export]
 
-module.exports = Main;
+module.exports = Zip;

package/src/config/doc.js

@@ -1,7 +0,0 @@
-"use strict";
-
-// [export]
-
-module.exports = {
-  ".html": "text/html",
-};