arcadible 0.1.9 → 0.1.10

package/bin/arc-default.js

@@ -30,13 +30,13 @@ const main = function (argv) {
     yargs(hideBin(argv))
       .scriptName(CMD)
       .usage("$0 <command> [options]")
+      .command("init", "Initialize a project")
+      .command("validate", "Validate project workspace")
       .command("deploy", "Deploy to Arcadible")
-      .command("validate", "Validate workspace")
       .command("inspect", "Inspect project metadata")
-      .command("init", "Initialize a project")
-      .command("whoami", "Show current Arcadible account")
       .command("login", "Log in to Arcadible")
       .command("logout", "Log out of Arcadible")
+      .command("whoami", "Show Arcadible account")
       .help("help")
       .alias("help", "h")
       .version(pkg.version)

package/bin/arc-deploy.js

@@ -112,7 +112,7 @@ const main = function (argv) {
       .usage("$0 [options]")
       .option("git", {
         default: conf.git,
-        describe: "Deploy through Git",
+        describe: "Deploy using Git workflow",
         type: "boolean",
       })
       .option("json", {

package/bin/arc-init.js

@@ -82,14 +82,18 @@ const start = function (argv) {
       }
       if (!quiet) {
         log.hsnl("Initialized.");
+        log.h("Getting started:");
+        log.pnl(cfgurl.GETTING_STARTED);
         log.h("Next steps:");
-        log.pnl(
-          [data.path === root ? null : `cd ${dir}`, "npm install", "arc deploy"]
+        log.p(
+          [
+            data.path === root ? null : `cd ${dir}`,
+            "arc login",
+            "arc deploy (or: arc deploy --git)",
+          ]
             .filter(Boolean)
-            .join(" && "),
+            .map((step, i) => `${i + 1}. ${step}`),
         );
-        log.h("Getting started:");
-        log.p(cfgurl.GETTING_STARTED);
       }
       // degit sometimes hangs
       process.exit(0);
@@ -149,7 +153,7 @@ const main = function (argv) {
       .option("yes", {
         alias: "y",
         default: conf.yes,
-        describe: "Answer prompts using default values",
+        describe: "Accept all prompt defaults",
         type: "boolean",
       })
       .option("json", {

package/package.json

@@ -51,5 +51,5 @@
   "license": "Apache-2.0",
   "main": "./src/cli/index.js",
   "name": "arcadible",
-  "version": "0.1.9"
+  "version": "0.1.10"
 }

package/src/{user.js → account.js}

@@ -17,7 +17,7 @@ const os = require("./util/os");
 // [use]
 
 const configDir = os.configDir;
-const deepCompact = objs.deepCompact;
+const deepSort = objs.deepSort;
 const join = path.join;
 const mkdir = fs.promises.mkdir;
 const readFile = fs.promises.readFile;
@@ -27,7 +27,7 @@ const writeFile = fs.promises.writeFile;
 // [declare]
 
 const CMD = "arc";
-const FILE = "user.json";
+const FILE = "account.json";
 
 // [define]
 
@@ -42,20 +42,22 @@ const expired = function (session) {
 
 // [function]
 
-const save = function (user) {
+const save = function (account) {
   return mkdir(dir, { recursive: true })
     .then(() =>
-      writeFile(file, JSON.stringify(deepCompact(user), null, 2), "utf8"),
+      writeFile(file, JSON.stringify(deepSort(account), null, 2), "utf8"),
     )
-    .then(() => user);
+    .then(() => account);
 };
 
 // [function]
 
-const refresh = function ({ session, ...user }) {
+const refresh = function ({ session, ...account }) {
   const form = new FormData();
   form.append("refresh_token", session.refresh_token);
-  return api.authRefresh(form).then((data) => save({ ...user, session: data }));
+  return api
+    .authRefresh(form)
+    .then((data) => save({ ...account, session: data }));
 };
 
 // [function]
@@ -69,13 +71,13 @@ const get = function ({ onRefresh }) {
       }
       throw ex;
     })
-    .then((user) => {
-      if (!user || !user.session) {
+    .then((account) => {
+      if (!account || !account.session) {
         return null;
       }
-      return expired(user.session)
-        ? onRefresh((renew) => (renew ? refresh(user) : null))
-        : user;
+      return expired(account.session)
+        ? onRefresh((renew) => (renew ? refresh(account) : null))
+        : account;
     });
 };
 

package/src/action/deploy/git.js

@@ -44,7 +44,7 @@ const ensureRepo = function (root, cb) {
 const ensureRemote = function (root, cb) {
   const message = [
     "Unable to access Git remote 'origin'.",
-    "Ensure the remote exists and you have permission to access it.",
+    "Ensure the remote 'origin' exists and you have permission to access it.",
   ];
   git(root, ["ls-remote", "origin"], (err) => {
     if (err) {

package/src/action/init/manifest.js

@@ -8,7 +8,10 @@ const path = require("node:path");
 // [import]
 
 const fs = require("fs-extra");
-const TOML = require("@iarna/toml");
+
+// [import]
+
+const TOML = require("../../util/toml");
 
 // [use]
 
@@ -37,14 +40,10 @@ const parseToml = function (buf) {
 // [function]
 
 const pickVersion = function (version, envVersion) {
-  switch (true) {
-    case Boolean(version):
-      return { version };
-    case Boolean(envVersion):
-      return {};
-    default:
-      return { version: "0.1.0" };
+  if (version) {
+    return { version };
   }
+  return envVersion ? {} : { version: "0.1.0" };
 };
 
 // [function]
@@ -57,7 +56,7 @@ const readManifest = function (file) {
 
 // [function]
 
-const prepareGame = function (envVersion, game = {}) {
+const patchGame = function (envVersion, game = {}) {
   const { id, version, ...rest } = game;
   return {
     id: id ?? randomUUID(),
@@ -81,7 +80,7 @@ const prepare = function (dest, envVersion) {
   const file = join(dest, MANIFEST);
   return readManifest(file).then((manifest) => {
     const { game, ...rest } = manifest;
-    const next = { game: prepareGame(envVersion, game), ...rest };
+    const next = { game: patchGame(envVersion, game), ...rest };
     if (shouldWrite(manifest, next)) {
       return writeFile(file, TOML.stringify(next), "utf8");
     }

package/src/action/init/tool-patch.js

@@ -16,7 +16,7 @@ const resolve = path.resolve;
 
 // [function]
 
-const inferVersion = function (root) {
+const detectVersion = function (root) {
   return env(root).then(({ game }) => game?.version ?? null);
 };
 
@@ -28,10 +28,10 @@ const init = function () {
 
 // [function]
 
-const main = function ({ project, root }) {
+const main = function ({ force, project, root, template }, handler) {
   const dest = resolve(root, project);
-  return init()
-    .then(() => inferVersion(dest))
+  return init(dest, { force, template }, handler)
+    .then(() => detectVersion(dest))
     .then((version) => prepare(dest, version))
     .then(() => ({ path: dest }));
 };

package/src/action/init/tool.js

@@ -34,13 +34,13 @@ const removeLicense = function (dest) {
 
 // [function]
 
-const inferVersion = function (root) {
+const detectVersion = function (root) {
   return env(root).then(({ game }) => game?.version ?? null);
 };
 
 // [function]
 
-const init = function (src, dest, { onBegin, onInfo }) {
+const scaffold = function (src, dest, { onBegin, onInfo }) {
   onBegin({ dest, src });
   return degit(src, { cache: false, force: true, verbose: false })
     .on("info", onInfo)
@@ -49,19 +49,22 @@ const init = function (src, dest, { onBegin, onInfo }) {
 
 // [function]
 
+const init = function (dest, { force, template }, handler) {
+  return pathExists(dest).then((exists) => {
+    if (exists && !force) {
+      throw new Error("Directory already exists. Use `--force` to overwrite.");
+    }
+    return scaffold(template, dest, handler);
+  });
+};
+
+// [function]
+
 const main = function ({ force, project, root, template }, handler) {
   const dest = resolve(root, project);
-  return pathExists(dest)
-    .then((exists) => {
-      if (exists && !force) {
-        throw new Error(
-          "Directory already exists. Use `--force` to overwrite.",
-        );
-      }
-      return init(template, dest, handler);
-    })
+  return init(dest, { force, template }, handler)
     .then(() => removeLicense(dest))
-    .then(() => inferVersion(dest))
+    .then(() => detectVersion(dest))
     .then((version) => prepare(dest, version))
     .then(() => ({ path: dest }));
 };

package/src/action/login/tool.js

@@ -2,13 +2,13 @@
 
 // [import]
 
+const account = require("../../account");
 const flow = require("./flow");
-const user = require("../../user");
 
 // [function]
 
 const main = function (conf, handler) {
-  return flow(handler).then(user.save);
+  return flow(handler).then(account.save);
 };
 
 // [export]

package/src/action/logout/tool.js

@@ -2,12 +2,12 @@
 
 // [import]
 
-const user = require("../../user");
+const account = require("../../account");
 
 // [function]
 
 const main = function () {
-  return user.remove();
+  return account.remove();
 };
 
 // [export]

package/src/action/whoami/tool.js

@@ -2,12 +2,12 @@
 
 // [import]
 
-const user = require("../../user");
+const account = require("../../account");
 
 // [function]
 
 const main = function (conf, handler) {
-  return user.get(handler);
+  return account.get(handler);
 };
 
 // [export]

package/src/parser/env.js

@@ -37,10 +37,10 @@ const parseJson = function (buf) {
 
 // [function]
 
-const extract = function (pkg) {
+const extract = function (conf) {
   /* eslint-disable camelcase */
-  const game = { version: pkg.version };
-  const workflow = { build: pkg.scripts?.build ?? "" };
+  const game = { version: conf.version };
+  const workflow = { build: conf.scripts?.build ?? "" };
   /* eslint-enable camelcase */
   return deepCompact({ game, workflow });
 };
@@ -52,7 +52,7 @@ const main = function (root) {
   return pathExists(file)
     .then((exists) => (exists ? readFile(file, "utf8") : null))
     .then((buf) => (buf === null ? {} : parseJson(buf)))
-    .then((pkg) => (Object.keys(pkg).length ? extract(pkg) : {}));
+    .then((conf) => (Object.keys(conf).length ? extract(conf) : {}));
 };
 
 // [export]

package/src/parser/manifest.js

@@ -7,10 +7,15 @@ const path = require("node:path");
 // [import]
 
 const fs = require("fs-extra");
-const TOML = require("@iarna/toml");
+
+// [import]
+
+const objs = require("../util/objs");
+const TOML = require("../util/toml");
 
 // [use]
 
+const deepCompact = objs.deepCompact;
 const join = path.join;
 const pathExists = fs.pathExists;
 const readFile = fs.readFile;
@@ -33,11 +38,18 @@ const parseToml = function (buf) {
 
 // [function]
 
+const extract = function (conf) {
+  return deepCompact(conf);
+};
+
+// [function]
+
 const main = function (root) {
   const file = join(root, MANIFEST);
   return pathExists(file)
     .then((exists) => (exists ? readFile(file, "utf8") : null))
-    .then((buf) => (buf === null ? {} : parseToml(buf)));
+    .then((buf) => (buf === null ? {} : parseToml(buf)))
+    .then((conf) => (Object.keys(conf).length ? extract(conf) : {}));
 };
 
 // [export]

package/src/prompt/template.js

@@ -10,8 +10,8 @@ module.exports = {
   select: {
     choices: [
       {
-        description: "Blank starter.",
-        name: "Blank",
+        description: "Zero-build static starter.",
+        name: "Default",
         value: `${REPO}/starter`,
       },
       {

package/src/schema/game.js

@@ -301,8 +301,12 @@ const zIconVideo = function (root) {
 const zId = function () {
   const field = "id";
   return z
-    .string()
-    .uuid(message(field, ["Must be a valid UUID."]))
+    .uuid(
+      message(field, [
+        "Must be a valid UUID.",
+        "Run `arc init` to generate a new game ID.",
+      ]),
+    )
     .refine(
       (value) => value === value.toLowerCase(),
       message(field, ["Must use lowercase characters."]),
@@ -389,7 +393,7 @@ const zTrailer = function () {
     .refine(
       (url) =>
         zVimeo().safeParse(url).success || zYouTube().safeParse(url).success,
-      message(field, ["Must be a YouTube (or Vimeo) URL."]),
+      message(field, ["Must be a YouTube or Vimeo URL."]),
     )
     .optional();
 };
@@ -402,7 +406,7 @@ const zVersion = function () {
     .string()
     .refine(
       (value) => validSemver(value) !== null,
-      message(field, ["Must be a valid semver."]),
+      message(field, ["Must be valid semver."]),
     );
 };
 

package/src/schema/workflow.js

@@ -61,7 +61,7 @@ const zDeployDir = function (root, { build }) {
     )
     .refine(
       (file) => isOutCheck(root, file),
-      message(field, ["Must be within the project."]),
+      message(field, ["Must be within the project directory."]),
     )
     .refine(
       (file) => isReservedCheck(root, file, MEDIA),
@@ -70,8 +70,8 @@ const zDeployDir = function (root, { build }) {
     .refine(
       (file) => build || existsCheck(root, file),
       message(field, [
-        "Must exist if there is no build step.",
-        "Run `arc inspect workflow.deploy_dir` for its value.",
+        "Must exist when there is no build step.",
+        "Run `arc inspect workflow.deploy_dir` to check the configured value.",
       ]),
     );
 };

package/src/util/delay.js

@@ -46,7 +46,7 @@ const poll = function (
       }
       const elapsed = Date.now() - started;
       if (elapsed >= timeout) {
-        throw new Error("Timed out.");
+        throw new Error("Operation timed out.");
       }
       return wait(backoff(elapsed, delay, factor, interval, maxDelay), next);
     });

package/src/util/output.js

@@ -2,11 +2,8 @@
 
 // [import]
 
-const TOML = require("@iarna/toml");
-
-// [import]
-
 const objs = require("./objs");
+const TOML = require("./toml");
 
 // [use]
 
@@ -35,7 +32,7 @@ const printToml = function (data, key = "value") {
   try {
     write(TOML.stringify(deepSort(data)));
   } catch (ex) {
-    write(TOML.stringify({ [field]: data }));
+    write(TOML.stringify(deepSort({ [field]: data })));
   }
 };
 

package/src/util/toml.js

@@ -0,0 +1,14 @@
+"use strict";
+
+// [import]
+
+const TOML = require("@iarna/toml");
+
+// [use]
+
+const parse = TOML.parse;
+const stringify = TOML.stringify;
+
+// [export]
+
+module.exports = { parse, stringify };

package/src/util/video.js

@@ -57,7 +57,7 @@ const readMp4 = function (file) {
     };
   };
   mp4.onError = function (mod, msg) {
-    error = new Error(`MP4Box(${mod}): ${msg}`);
+    error = new Error(msg);
   };
   const buffer = data.buffer.slice(
     data.byteOffset,
@@ -70,7 +70,7 @@ const readMp4 = function (file) {
     throw error;
   }
   if (!video) {
-    throw new Error("MP4 metadata not available.");
+    throw new Error("No video metadata found.");
   }
   return video;
 };