arcadible 0.1.32 → 0.1.33

package/README.md

@@ -12,7 +12,7 @@
 
 <p align="center">
   <a href="https://developer.arcadible.com/references/arcadible-cli">Docs</a> ·
-  <a href="https://developer.arcadible.com/guides/games/getting-started">Getting Started</a> ·
+  <a href="https://developer.arcadible.com/getting-started">Getting Started</a> ·
   <a href="https://arcadible.com">Arcadible</a> ·
   <a href="https://studio.arcadible.com">Studio</a>
 </p>
@@ -57,10 +57,10 @@ Run `arc <command> --help` for its options, or see the [CLI reference](https://d
 
 ## Learn more
 
-- [Getting Started](https://developer.arcadible.com/guides/games/getting-started): from an empty directory to a public game.
+- [Getting Started](https://developer.arcadible.com/getting-started): from an empty directory to a public game.
 - [The manifest](https://developer.arcadible.com/references/arcadible-manifest): every field in `arcadible.toml`.
-- [Deploying from GitHub](https://developer.arcadible.com/guides/publishing/deploying-from-github): release with a tag, built by GitHub Actions.
-- [Releases](https://developer.arcadible.com/guides/publishing/releases): where a release's result shows, and how to fix a failed one.
+- [Deploying from GitHub](https://developer.arcadible.com/publish/deploying-from-github): release with a tag, built by GitHub Actions.
+- [Releases](https://developer.arcadible.com/publish/releases): where a release's result shows, and how to fix a failed one.
 
 ## License
 

package/bin/arc-build.js

@@ -14,11 +14,14 @@ const yargs = require("yargs/yargs");
 
 const args = require("../src/util/argv");
 const build = require("../src/cli/build");
+const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
+const error = require("../src/util/error");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const phrase = require("../src/phrase");
+const project = require("../src/parser/project");
 const rc = require("../src/util/rc");
 const spinner = require("../src/util/spinner");
 const validate = require("../src/cli/validate");
@@ -26,6 +29,7 @@ const validate = require("../src/cli/validate");
 // [use]
 
 const abort = output.abort;
+const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const print = output.print;
 const relative = path.relative;
@@ -52,18 +56,28 @@ const start = function (argv) {
   const json = argv.json;
   const quiet = argv.quiet;
   const root = resolve(process.cwd(), argv.cwd);
+  // the project, parsed once for both steps.
+  let parsed = null;
   let sw = new SpinnerWheel("Validating... %s");
   sw.start(json || quiet);
-  return validate({ root })
+  return project(root)
+    .then((proj) => {
+      parsed = proj;
+      return validate({ project: parsed, root });
+    })
     .then((issues) => {
       const count = issues.length;
       if (count) {
-        throw new Error(phrase.issuesFound(count));
+        throw new ArcError(
+          cfgcode.VALIDATION_FAILED,
+          phrase.issuesFound(count),
+          { data: { issues } },
+        );
       }
       sw.stop(true);
       sw = new SpinnerWheel("Building... %s");
       sw.start(json || quiet);
-      return build({ root });
+      return build({ project: parsed, root });
     })
     .then((artifact) => {
       if (json) {
@@ -72,16 +86,19 @@ const start = function (argv) {
       }
       if (!quiet) {
         sw.stop(true);
-        log.hs("Built.");
+        // the heading says what happened: built, built without deploy_dir
+        // (a caveat, so yellow), or no build to run.
         if (artifact?.path) {
+          log.hs("Built.");
           print(artifact, { nl: true, toml: true });
           return;
         }
         if (artifact?.missing) {
+          log.result("Built.", [], { color: "yellow" });
           log.nlpw(phrase.buildOutputMissing(relative(root, artifact.missing)));
           return;
         }
-        log.nlp("Nothing to do.");
+        log.hs("Nothing to do.");
       }
     })
     .catch((ex) => abort("Build aborted.", ex, { json, sw }));
@@ -111,6 +128,7 @@ const main = function (argv) {
       .alias("help", "h")
       .version(VERSION)
       .alias("version", "v")
+      .fail(args.fail(argv))
       .strict()
       .parse(),
   );

package/bin/arc-deploy.js

@@ -14,15 +14,18 @@ const yargs = require("yargs/yargs");
 
 const args = require("../src/util/argv");
 const build = require("../src/cli/build");
+const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
 const deploy = require("../src/cli/deploy");
+const error = require("../src/util/error");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const pack = require("../src/cli/pack");
 const phrase = require("../src/phrase");
 const predeploy = require("../src/cli/predeploy");
 const progress = require("../src/util/progress");
+const project = require("../src/parser/project");
 const rc = require("../src/util/rc");
 const spinner = require("../src/util/spinner");
 const validate = require("../src/cli/validate");
@@ -32,6 +35,7 @@ const whoami = require("../src/cli/whoami");
 // [use]
 
 const abort = output.abort;
+const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const print = output.print;
 const ProgressBar = progress.ProgressBar;
@@ -138,6 +142,18 @@ const whoamiIfAny = function (opts) {
 
 // [function]
 
+// whether `current` can wait for a git release: only the game's owner can see
+// its releases. A token's account isn't known, so it waits, and so does any
+// account when the owner couldn't be looked up.
+const canWait = function (current, owner) {
+  if (!current) {
+    return false;
+  }
+  return Boolean(current.token) || owner === null || owner === current.user?.id;
+};
+
+// [function]
+
 // the release, as `--json` prints it.
 const releaseJson = function (row) {
   if (!row) {
@@ -199,12 +215,21 @@ const waitAndReport = async function (
       git,
       studio,
     });
-    abort("Wait timed out.", new Error(reason), { data, json, sw });
+    abort("Wait timed out.", new ArcError(cfgcode.WAIT_TIMED_OUT, reason), {
+      data,
+      json,
+      sw,
+    });
     return;
   }
   if (release.status === "failed") {
     const reason = phrase.releaseFailed(release, studio);
-    abort("Release failed.", new Error(reason), { data, json, sw });
+    abort("Release failed.", new Error(reason), {
+      code: release.reason ?? cfgcode.INTERNAL,
+      data,
+      json,
+      sw,
+    });
     return;
   }
   sw.stop(true);
@@ -217,20 +242,48 @@ const waitAndReport = async function (
 
 // [function]
 
+// fails unless the timeout is a number of seconds above 0: otherwise the
+// wait would never end.
+const checkTimeout = function (timeout) {
+  if (Number.isFinite(timeout) && timeout > 0) {
+    return Promise.resolve();
+  }
+  return Promise.reject(
+    new ArcError(cfgcode.ARGUMENT_INVALID, phrase.timeoutInvalid()),
+  );
+};
+
+// [function]
+
 const start = function (argv) {
   const git = argv.method === "git";
   const json = argv.json;
   const quiet = argv.quiet;
-  const timeout = argv.timeout ?? TIMEOUT[git ? "git" : "direct"];
+  // `.arcrc` values are strings, and a flag that isn't a number is NaN.
+  const timeout = Number(argv.timeout ?? TIMEOUT[git ? "git" : "direct"]);
   const root = resolve(process.cwd(), argv.cwd);
   let pb = null;
+  // the note when a git deploy doesn't wait: who can wait for it.
+  let notWaited = phrase.releaseNotWaited();
+  // the project, parsed once and given to each step. A build can write files
+  // the manifest reads, such as art, so it's parsed again after one runs.
+  let parsed = null;
   let sw = new SpinnerWheel("Validating... %s");
   sw.start(json || quiet);
-  return validate({ root })
+  return checkTimeout(timeout)
+    .then(() => project(root))
+    .then((proj) => {
+      parsed = proj;
+      return validate({ project: parsed, root });
+    })
     .then((issues) => {
       const count = issues.length;
       if (count) {
-        throw new Error(phrase.issuesFound(count));
+        throw new ArcError(
+          cfgcode.VALIDATION_FAILED,
+          phrase.issuesFound(count),
+          { data: { issues } },
+        );
       }
       sw.stop(true);
       sw = new SpinnerWheel("Checking... %s");
@@ -247,7 +300,7 @@ const start = function (argv) {
     })
     .then((current) => {
       if (!current && !git) {
-        throw new Error(phrase.notLoggedIn());
+        throw new ArcError(cfgcode.NOT_LOGGED_IN, phrase.notLoggedIn());
       }
       sw.stop(true);
       sw = new SpinnerWheel("Preparing... %s");
@@ -259,22 +312,31 @@ const start = function (argv) {
           current,
           git,
           handler: handler({ json, pb, quiet, sw }),
+          project: parsed,
           root,
         }),
       ]);
     })
-    .then(([current]) => {
+    .then(([current, predeployed]) => {
       sw.stop(true);
+      const waits = !git || canWait(current, predeployed.owner ?? null);
+      if (current && !waits) {
+        notWaited = phrase.releaseNotWaitedOwner();
+      }
       sw = new SpinnerWheel("Building... %s");
       sw.start(git || json || quiet);
       return Promise.all([
-        // whoami
-        current,
+        // whoami, kept only to wait with
+        waits ? current : null,
         // build
-        git ? null : build({ root }),
+        git ? null : build({ project: parsed, root }),
       ]);
     })
-    .then(([current, artifact]) => {
+    .then(([current, artifact]) =>
+      Promise.all([current, artifact, artifact ? project(root) : parsed]),
+    )
+    .then(([current, artifact, proj]) => {
+      parsed = proj;
       sw.stop(true);
       sw = new SpinnerWheel("Packing... %s");
       sw.start(git || json || quiet);
@@ -282,7 +344,7 @@ const start = function (argv) {
         // whoami
         current,
         // pack
-        git ? null : pack({ input: artifact?.path, root }),
+        git ? null : pack({ input: artifact?.path, project: parsed, root }),
         // build: whether workflow.build ran
         Boolean(artifact),
       ]);
@@ -301,6 +363,7 @@ const start = function (argv) {
           current,
           git,
           handler: handler({ json, pb, quiet, sw }),
+          project: parsed,
           root,
         }),
         built,
@@ -333,7 +396,7 @@ const start = function (argv) {
       } else if (!quiet) {
         report(result, {
           git,
-          note: argv.wait ? phrase.releaseNotWaited() : null,
+          note: argv.wait ? notWaited : null,
         });
       }
       return null;
@@ -375,6 +438,7 @@ const main = function (argv) {
         type: "boolean",
       })
       .option("timeout", {
+        default: conf.timeout,
         describe: "Seconds to wait [default: 300, or 900 for git]",
         type: "number",
       })
@@ -383,6 +447,7 @@ const main = function (argv) {
       .alias("help", "h")
       .version(VERSION)
       .alias("version", "v")
+      .fail(args.fail(argv))
       .strict()
       .parse(),
   );

package/bin/arc-init.js

@@ -15,9 +15,11 @@ const yargs = require("yargs/yargs");
 // [import]
 
 const args = require("../src/util/argv");
+const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
 const cfgtemplate = require("../src/config/template");
+const error = require("../src/util/error");
 const init = require("../src/cli/init");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
@@ -28,6 +30,7 @@ const spinner = require("../src/util/spinner");
 // [use]
 
 const abort = output.abort;
+const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const join = path.join;
 const pathExists = fs.pathExists;
@@ -107,7 +110,7 @@ const prompt = async function ({ yes, ...argv }) {
   if (!opts.template) {
     // without a terminal, the prompt would read end-of-input and exit.
     if (!process.stdin.isTTY) {
-      throw new Error(phrase.noTemplate());
+      throw new ArcError(cfgcode.TEMPLATE_MISSING, phrase.noTemplate());
     }
     opts.template = await select(cfgtemplate);
   }
@@ -143,6 +146,7 @@ const main = function (argv) {
       )
       .option("template", {
         alias: "t",
+        default: conf.template,
         describe: [
           "Project template",
           "Public GitHub repository (format: user/repo).",
@@ -172,6 +176,7 @@ const main = function (argv) {
       .alias("help", "h")
       .version(VERSION)
       .alias("version", "v")
+      .fail(args.fail(argv))
       .strict()
       .parse(),
   );

package/bin/arc-inspect.js

@@ -84,6 +84,7 @@ const main = function (argv) {
       .alias("help", "h")
       .version(VERSION)
       .alias("version", "v")
+      .fail(args.fail(argv))
       .strict()
       .parse(),
   );

package/bin/arc-login.js

@@ -10,8 +10,10 @@ const yargs = require("yargs/yargs");
 // [import]
 
 const args = require("../src/util/argv");
+const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
+const error = require("../src/util/error");
 const log = require("../src/util/log");
 const login = require("../src/cli/login");
 const phrase = require("../src/phrase");
@@ -21,6 +23,7 @@ const spinner = require("../src/util/spinner");
 
 // [use]
 
+const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const launch = shell.launch;
 const SpinnerWheel = spinner.SpinnerWheel;
@@ -101,7 +104,7 @@ const start = function (argv) {
     .then((current) => {
       const user = current?.user;
       if (!user) {
-        throw new Error(phrase.notLoggedIn());
+        throw new ArcError(cfgcode.NOT_LOGGED_IN, phrase.notLoggedIn());
       }
       sw.stop(true);
       process.stdin.pause();

package/bin/arc-open.js

@@ -13,9 +13,11 @@ const yargs = require("yargs/yargs");
 // [import]
 
 const args = require("../src/util/argv");
+const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
 const cfguri = require("../src/config/uri");
+const error = require("../src/util/error");
 const log = require("../src/util/log");
 const open = require("../src/cli/open");
 const output = require("../src/util/output");
@@ -26,6 +28,7 @@ const shell = require("../src/util/shell");
 // [use]
 
 const abort = output.abort;
+const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const launch = shell.launch;
 const resolve = path.resolve;
@@ -54,7 +57,7 @@ const start = function (argv) {
     .then((data) => {
       const page = data?.page;
       if (!page) {
-        throw new Error(phrase.noGameId());
+        throw new ArcError(cfgcode.GAME_ID_MISSING, phrase.noGameId());
       }
       const url = `${cfguri.HOST_HTTP_WWW}${page}`;
       const opening = argv.browser

package/bin/arc-pack.js

@@ -13,12 +13,15 @@ const yargs = require("yargs/yargs");
 // [import]
 
 const args = require("../src/util/argv");
+const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
+const error = require("../src/util/error");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const pack = require("../src/cli/pack");
 const phrase = require("../src/phrase");
+const project = require("../src/parser/project");
 const rc = require("../src/util/rc");
 const spinner = require("../src/util/spinner");
 const validate = require("../src/cli/validate");
@@ -26,6 +29,7 @@ const validate = require("../src/cli/validate");
 // [use]
 
 const abort = output.abort;
+const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const print = output.print;
 const resolve = path.resolve;
@@ -53,18 +57,33 @@ const start = function (argv) {
   const json = argv.json;
   const quiet = argv.quiet;
   const root = resolve(process.cwd(), argv.cwd);
+  // the project, parsed once for both steps.
+  let parsed = null;
   let sw = new SpinnerWheel("Validating... %s");
   sw.start(json || quiet);
-  return validate({ root })
+  return project(root)
+    .then((proj) => {
+      parsed = proj;
+      return validate({ project: parsed, root });
+    })
     .then((issues) => {
       const count = issues.length;
       if (count) {
-        throw new Error(phrase.issuesFound(count));
+        throw new ArcError(
+          cfgcode.VALIDATION_FAILED,
+          phrase.issuesFound(count),
+          { data: { issues } },
+        );
       }
       sw.stop(true);
       sw = new SpinnerWheel("Packing... %s");
       sw.start(json || quiet);
-      return pack({ input: argv.input, output: argv.output, root });
+      return pack({
+        input: argv.input,
+        output: argv.output,
+        project: parsed,
+        root,
+      });
     })
     .then((artifact) => {
       if (json) {
@@ -116,6 +135,7 @@ const main = function (argv) {
       .alias("help", "h")
       .version(VERSION)
       .alias("version", "v")
+      .fail(args.fail(argv))
       .strict()
       .parse(),
   );

package/bin/arc-play.js

@@ -13,9 +13,11 @@ const yargs = require("yargs/yargs");
 // [import]
 
 const args = require("../src/util/argv");
+const cfgcode = require("../src/config/code");
 const cfgpackage = require("../src/config/package");
 const cfgproduct = require("../src/config/product");
 const cfguri = require("../src/config/uri");
+const error = require("../src/util/error");
 const log = require("../src/util/log");
 const output = require("../src/util/output");
 const phrase = require("../src/phrase");
@@ -27,6 +29,7 @@ const spinner = require("../src/util/spinner");
 // [use]
 
 const abort = output.abort;
+const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const launch = shell.launch;
 const resolve = path.resolve;
@@ -71,7 +74,7 @@ const start = function (argv) {
       const orientation = data?.orientation;
       const url = data?.url;
       if (!orientation || !url) {
-        throw new Error(phrase.noGameId());
+        throw new ArcError(cfgcode.GAME_ID_MISSING, phrase.noGameId());
       }
       sw.stop(true);
       if (data.fallback && !argv.quiet) {

package/bin/arc-validate.js

@@ -96,6 +96,7 @@ const main = function (argv) {
       .alias("help", "h")
       .version(VERSION)
       .alias("version", "v")
+      .fail(args.fail(argv))
       .strict()
       .parse(),
   );

package/bin/arc-whoami.js

@@ -106,6 +106,7 @@ const main = function (argv) {
       .alias("help", "h")
       .version(VERSION)
       .alias("version", "v")
+      .fail(args.fail(argv))
       .strict()
       .parse(),
   );

package/package.json

@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "@inquirer/prompts": "^8.5.2",
-    "adm-zip": "^0.5.16",
+    "adm-zip": "^0.6.1",
     "chalk": "^4.1.2",
     "cli-progress": "^3.12.0",
     "cli-spinner": "^0.2.10",
@@ -24,7 +24,7 @@
     "dot-prop": "^6.0.1",
     "fast-json-stable-stringify": "^2.1.0",
     "fs-extra": "^11.3.2",
-    "image-size": "^2.0.2",
+    "image-size": "^2.0.4",
     "ini": "^6.0.0",
     "jsdom": "^27.3.0",
     "marked": "^17.0.1",
@@ -75,5 +75,5 @@
   "scripts": {
     "test": "node --test \"test/**/*.test.js\""
   },
-  "version": "0.1.32"
+  "version": "0.1.33"
 }

package/src/account.js

@@ -11,17 +11,20 @@ const fs = require("fs-extra");
 // [import]
 
 const api = require("./api");
+const cfgcode = require("./config/code");
 const cfgproduct = require("./config/product");
+const error = require("./util/error");
 const objs = require("./util/objs");
 const os = require("./util/os");
 const phrase = require("./phrase");
 
 // [use]
 
+const ArcError = error.ArcError;
+const chmod = fs.promises.chmod;
 const configDir = os.configDir;
 const deepSort = objs.deepSort;
 const join = path.join;
-const chmod = fs.promises.chmod;
 const mkdir = fs.promises.mkdir;
 const readFile = fs.promises.readFile;
 const unlink = fs.promises.unlink;
@@ -37,7 +40,7 @@ const FILE_MODE = 0o600;
 
 // the statuses that mean the refresh token itself was refused.
 const REJECTED = [400, 401, 403];
-const SESSION_EXPIRED = "session-expired";
+const SESSION_EXPIRED = cfgcode.SESSION_EXPIRED;
 
 // [declare]
 
@@ -85,8 +88,8 @@ const refresh = function ({ session, ...current }) {
     (data) => save({ ...current, session: data }),
     (ex) => {
       if (REJECTED.includes(ex.status)) {
-        throw Object.assign(new Error(phrase.sessionExpired(), { cause: ex }), {
-          code: SESSION_EXPIRED,
+        throw new ArcError(cfgcode.SESSION_EXPIRED, phrase.sessionExpired(), {
+          cause: ex,
         });
       }
       throw ex;

package/src/action/build/tool.js

@@ -11,11 +11,14 @@ const fs = require("fs-extra");
 
 // [import]
 
+const cfgcode = require("../../config/code");
+const error = require("../../util/error");
+const given = require("../../parser/given");
 const phrase = require("../../phrase");
-const project = require("../../parser/project");
 
 // [use]
 
+const ArcError = error.ArcError;
 const exec = cp.exec;
 const pathExists = fs.pathExists;
 const resolvePath = path.resolve;
@@ -28,7 +31,7 @@ const execBuild = function (command, { cwdPath }) {
       if (err) {
         const { code, signal } = err;
         reject(
-          new Error(phrase.buildFailed({ code, signal, stderr }), {
+          new ArcError(cfgcode.BUILD_FAILED, phrase.buildFailed({ code, signal, stderr }), {
             cause: err,
           }),
         );
@@ -54,8 +57,9 @@ const build = function (command, { cwdPath, outputPath }) {
 
 // [function]
 
-const main = function ({ root }) {
-  return project(root).then(({ workflow }) => {
+const main = function (conf) {
+  const root = conf.root;
+  return given(conf).then(({ workflow }) => {
     const command = workflow.build;
     return build(
       Array.isArray(command)