arcadible 0.1.34 → 0.1.36

package/bin/arc-login.js

@@ -16,6 +16,7 @@ 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 output = require("../src/util/output");
 const phrase = require("../src/phrase");
 const rc = require("../src/util/rc");
 const shell = require("../src/util/shell");
@@ -23,6 +24,7 @@ const spinner = require("../src/util/spinner");
 
 // [use]
 
+const abort = output.abort;
 const ArcError = error.ArcError;
 const findRc = rc.findRc;
 const launch = shell.launch;
@@ -70,10 +72,13 @@ const onLoginEnter = function (fn) {
 
 // [function]
 
-const handler = function ({ browser, qrcode: qr, sw }) {
+// `shown` is set once the link is printed, so a failure after it starts
+// after a blank line.
+const handler = function ({ browser, qrcode: qr, shown, sw }) {
   return {
     onLoginCreated({ code: dac, secret, url }) {
       sw.stop(true);
+      shown.link = true;
       const link = `${url}/${secret}`;
       log.p("Logging in...");
       qrcode.generate(link, { small: true }, (code) => {
@@ -82,7 +87,8 @@ const handler = function ({ browser, qrcode: qr, sw }) {
         }
         log.nlp(url);
         log.h(dac.toUpperCase());
-        if (browser) {
+        // a key press can only be read from a terminal.
+        if (browser && process.stdin.isTTY) {
           log.nlp("Press Enter to open the URL.");
           onLoginEnter(() => {
             launch(link);
@@ -96,10 +102,16 @@ const handler = function ({ browser, qrcode: qr, sw }) {
 // [function]
 
 const start = function (argv) {
+  const shown = { link: false };
   const sw = new SpinnerWheel("Logging in... %s");
   sw.start();
   return login({
-    handler: handler({ browser: argv.browser, qrcode: argv.qrcode, sw }),
+    handler: handler({
+      browser: argv.browser,
+      qrcode: argv.qrcode,
+      shown,
+      sw,
+    }),
   })
     .then((current) => {
       const user = current?.user;
@@ -111,11 +123,8 @@ const start = function (argv) {
       log.result("Logged in.", [user.display_name], { nl: true });
     })
     .catch((ex) => {
-      sw.stop(true);
       process.stdin.pause();
-      log.nlhd("Login aborted.");
-      log.pd(ex.message);
-      process.exit(1);
+      abort("Login aborted.", ex, { nl: shown.link, sw });
     });
 };
 

package/bin/arc-whoami.js

@@ -8,8 +8,8 @@ const yargs = require("yargs/yargs");
 
 // [import]
 
-const account = require("../src/account");
 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 log = require("../src/util/log");
@@ -76,7 +76,7 @@ const start = function (argv) {
     .catch((ex) => {
       const message = ex.message;
       // a session that can't be refreshed is no session: say so, and why.
-      if (ex.code === account.SESSION_EXPIRED) {
+      if (ex.code === cfgcode.SESSION_EXPIRED) {
         if (json) {
           print({ user: null });
         } else {

package/package.json

@@ -75,5 +75,5 @@
   "scripts": {
     "test": "node --test \"test/**/*.test.js\""
   },
-  "version": "0.1.34"
+  "version": "0.1.36"
 }

package/src/account.js

@@ -40,7 +40,6 @@ const FILE_MODE = 0o600;
 
 // the statuses that mean the refresh token itself was refused.
 const REJECTED = [400, 401, 403];
-const SESSION_EXPIRED = cfgcode.SESSION_EXPIRED;
 
 // [declare]
 
@@ -154,4 +153,4 @@ const remove = function () {
 
 // [export]
 
-module.exports = { SESSION_EXPIRED, get, remove, save };
+module.exports = { get, remove, save };

package/src/schema/game.js

@@ -130,6 +130,19 @@ const atLeast = function (field, min, unit) {
 
 // [function]
 
+// a required string's error: "Must be defined." and `lines` when it's missing,
+// and zod's own type message (null) when it's there but isn't a string.
+const required = function (field, lines) {
+  const missing = message(field, ["Must be defined.", ...lines]).message;
+  return {
+    error(issue) {
+      return typeof issue.input === "undefined" ? missing : null;
+    },
+  };
+};
+
+// [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
@@ -422,6 +435,7 @@ const zHandle = function () {
   return z.optional(
     z
       .string()
+      .min(1, { ...atLeast(field, 1), abort: true })
       .regex(
         /^[a-z0-9](?:(?![-]{2})[a-z0-9-]){1,22}[a-z0-9]$/u,
         message(field, ["Contains invalid characters."]),
@@ -435,10 +449,7 @@ const zId = function () {
   const field = "id";
   return z
     .string(
-      message(field, [
-        "Must be defined.",
-        `Run ${phrase.cmdInit()} to generate a new game ID.`,
-      ]),
+      required(field, [`Run ${phrase.cmdInit()} to generate a new game ID.`]),
     )
     .uuid(message(field, ["Must be a valid UUID."]))
     .refine(
@@ -499,6 +510,7 @@ const zTrailer = function () {
   const field = "trailer";
   return z
     .string()
+    .min(1, { ...atLeast(field, 1), abort: true })
     .max(255, message(field, ["Must not exceed: 255 characters"]))
     .refine(
       (url) =>
@@ -514,10 +526,7 @@ const zVersion = function () {
   const field = "version";
   return z
     .string(
-      message(field, [
-        "Must be defined.",
-        "A version is required unless one can be derived.",
-      ]),
+      required(field, ["A version is required unless one can be derived."]),
     )
     .refine(
       (value) => validSemver(value) !== null,

package/src/schema/workflow.js

@@ -33,6 +33,16 @@ const RESERVED = [`${HANDLE}.json`, MEDIA];
 
 // [function]
 
+// whether `build` runs anything: a command that isn't blank, as `arc build`
+// trims and drops blank ones (action/build/tool.js).
+const hasBuild = function (build) {
+  return [build]
+    .flat()
+    .some((cmd) => typeof cmd === "string" && cmd.trim() !== "");
+};
+
+// [function]
+
 const zBuild = function () {
   // const field = "build";
   return z.union([z.string(), z.array(z.string())]);
@@ -70,7 +80,7 @@ const zDeployDir = function (root, { build }) {
       ),
     )
     .refine(
-      (file) => build || existsCheck(root, file),
+      (file) => hasBuild(build) || existsCheck(root, file),
       message(
         field,
         [

package/src/util/argv.js

@@ -55,20 +55,29 @@ const cwd = function (args) {
 
 // [function]
 
+// whether `argv` passes --json, before the command parses its options.
+const json = function (argv) {
+  return parse(normalize(hideBin(argv)), {
+    alias: { json: ["j"] },
+    boolean: ["json"],
+  }).json;
+};
+
+// [function]
+
 // yargs' failure handler for a command with --json: an argument error is
 // one JSON document when --json was passed (OUTPUT.md), and yargs' own help
 // and message otherwise.
 const fail = function (argv) {
-  const json = parse(normalize(hideBin(argv)), {
-    alias: { json: ["j"] },
-    boolean: ["json"],
-  }).json;
+  const asJson = json(argv);
   return (message, ex, cli) => {
     if (ex) {
       throw ex;
     }
-    if (json) {
-      abort("", new ArcError(cfgcode.ARGUMENT_INVALID, message), { json });
+    if (asJson) {
+      abort("", new ArcError(cfgcode.ARGUMENT_INVALID, message), {
+        json: asJson,
+      });
     }
     cli.showHelp("error");
     console.error(`\n${message}`);
@@ -78,4 +87,4 @@ const fail = function (argv) {
 
 // [export]
 
-module.exports = { CWD, cwd, fail, normalize };
+module.exports = { CWD, cwd, fail, json, normalize };

package/src/util/output.js

@@ -62,13 +62,14 @@ const print = function (data, { key, nl, toml } = {}) {
 // 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
 // 1. `data`, and the error's own, go beside the error in JSON, such as the
-// release that failed.
+// release that failed. `nl` puts a blank line before the heading, after
+// output the command has already printed, such as arc login's link.
 // `code` is a failed release's reason, which the API may add to, so it isn't
 // checked, and its message already says it.
 const abort = function (
   heading,
   ex,
-  { code, data, json = false, pb, sw } = {},
+  { code, data, json = false, nl = false, pb, sw } = {},
 ) {
   const message = ex.message;
   const status = ex.status;
@@ -89,7 +90,11 @@ const abort = function (
     if (sw) {
       sw.stop(true);
     }
-    log.hd(heading);
+    if (nl) {
+      log.nlhd(heading);
+    } else {
+      log.hd(heading);
+    }
     log.pd(message);
     if (!code) {
       log.nlpd([

package/src/util/rc.js

@@ -13,9 +13,15 @@ const ini = require("ini");
 // [import]
 
 const args = require("./argv");
+const cfgcode = require("../config/code");
+const error = require("./error");
+const output = require("./output");
+const phrase = require("../phrase");
 
 // [use]
 
+const abort = output.abort;
+const ArcError = error.ArcError;
 const cwd = args.cwd;
 const dirname = path.dirname;
 const existsSync = fs.existsSync; // eslint-disable-line no-sync
@@ -60,7 +66,6 @@ const files = function (cmd, argv) {
       ? []
       : [join("/etc", cmd, "config"), join("/etc", `${cmd}rc`)]),
     join(home, ".config", cmd, "config"),
-    join(home, ".config", cmd),
     join(home, `.${cmd}`, "config"),
     join(home, `.${cmd}rc`),
     nearest(cmd),
@@ -70,7 +75,8 @@ const files = function (cmd, argv) {
 
 // [function]
 
-// a file's sections, INI or JSON, or nothing when it can't be read.
+// a file's sections, INI or JSON, or nothing when it can't be read. JSON
+// that doesn't parse is `parse_failed`, naming the file.
 const read = function (file) {
   let str = null;
   try {
@@ -78,18 +84,37 @@ const read = function (file) {
   } catch (ex) {
     return {};
   }
-  return /^\s*\{/u.test(str) ? JSON.parse(str) : ini.parse(str);
+  if (!/^\s*\{/u.test(str)) {
+    return ini.parse(str);
+  }
+  try {
+    return JSON.parse(str);
+  } catch (ex) {
+    throw new ArcError(
+      cfgcode.PARSE_FAILED,
+      phrase.unableToParse(file, ex.message),
+      { cause: ex },
+    );
+  }
 };
 
 // [function]
 
 // a command's section of .<cmd>rc, merged from the files `rc` reads. Unlike
-// `rc`, environment variables and `--config` aren't read.
+// `rc`, environment variables and `--config` aren't read. Options are read as
+// the command loads, so a file that doesn't parse aborts the command here,
+// as `<Command> aborted.`.
 const findRc = function (cmd, subcmd, argv) {
-  return [...new Set(files(cmd, argv))].reduce(
-    (found, file) => ({ ...found, ...read(file)[subcmd] }),
-    {},
-  );
+  try {
+    return [...new Set(files(cmd, argv))].reduce(
+      (found, file) => ({ ...found, ...read(file)[subcmd] }),
+      {},
+    );
+  } catch (ex) {
+    return abort(`${subcmd[0].toUpperCase()}${subcmd.slice(1)} aborted.`, ex, {
+      json: args.json(argv),
+    });
+  }
 };
 
 // [export]