arcadible 0.1.4 → 0.1.6

package/bin/arc-default.js

@@ -31,12 +31,12 @@ const main = function (argv) {
       .scriptName(CMD)
       .usage("$0 <command> [options]")
       .command("deploy", "Deploy to Arcadible")
-      .command("init", "Initialize a project")
+      .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("validate", "Validate workspace")
-      .command("whoami", "Show current account")
       .help("help")
       .alias("help", "h")
       .version(pkg.version)

package/bin/arc-deploy.js

@@ -111,27 +111,26 @@ const main = function (argv) {
       .scriptName(`${CMD} ${SUBCMD}`)
       .usage("$0 [options]")
       .option("git", {
-        alias: "g",
         default: conf.git,
-        describe: "Deploy through Git.",
+        describe: "Deploy through Git",
         type: "boolean",
       })
       .option("json", {
         alias: "j",
         default: conf.json,
-        describe: "Format output as JSON.",
+        describe: "Format output as JSON",
         type: "boolean",
       })
       .option("quiet", {
         alias: "q",
         default: conf.quiet,
-        describe: "Output only errors.",
+        describe: "Output only errors",
         type: "boolean",
       })
       .option("cwd", {
         alias: "C",
         default: ".",
-        describe: "Set the working directory.",
+        describe: "Set the working directory",
         type: "string",
       })
       .help("help")

package/bin/arc-init.js

@@ -20,7 +20,7 @@ const output = require("../src/util/output");
 const pkg = require("../package.json");
 const project = require("../src/prompt/project");
 const rc = require("../src/util/rc");
-const starter = require("../src/prompt/starter");
+const template = require("../src/prompt/template");
 
 // [use]
 
@@ -70,7 +70,7 @@ const start = function (argv) {
     handler: handler({ json, quiet }),
     project: argv.project,
     root,
-    starter: argv.starter,
+    template: argv.template,
   })
     .then((data) => {
       const dir = relative(root, data.path);
@@ -110,14 +110,14 @@ const prompt = async function ({ yes, ...argv }) {
   const opts = { ...argv };
   if (yes) {
     opts.project ??= project.input.default;
-    opts.starter ??= starter.select.default;
+    opts.template ??= template.select.default;
     return opts;
   }
   if (!argv.project) {
     opts.project = await input(project.input);
   }
-  if (!argv.starter) {
-    opts.starter = await select(starter.select);
+  if (!argv.template) {
+    opts.template = await select(template.select);
   }
   return opts;
 };
@@ -131,43 +131,43 @@ const main = function (argv) {
       .usage("$0 <project> [options]")
       .command("$0 <project>", false, (cli) =>
         cli.positional("project", {
-          describe: "Set the project directory.",
+          describe: "Project directory",
           type: "string",
         }),
       )
-      .option("starter", {
+      .option("template", {
         alias: "t",
-        describe: "Select a project starter.",
+        describe: "Project template",
         type: "string",
       })
       .option("yes", {
         alias: "y",
         default: conf.yes,
-        describe: "Answer prompts using default values.",
+        describe: "Answer prompts using default values",
         type: "boolean",
       })
       .option("force", {
         alias: "f",
         default: conf.force,
-        describe: "Overwrite an existing directory.",
+        describe: "Overwrite an existing directory",
         type: "boolean",
       })
       .option("json", {
         alias: "j",
         default: conf.json,
-        describe: "Format output as JSON.",
+        describe: "Format output as JSON",
         type: "boolean",
       })
       .option("quiet", {
         alias: "q",
         default: conf.quiet,
-        describe: "Output only errors.",
+        describe: "Output only errors",
         type: "boolean",
       })
       .option("cwd", {
         alias: "C",
         default: ".",
-        describe: "Set the working directory.",
+        describe: "Set the working directory",
         type: "string",
       })
       .help("help")

package/bin/arc-inspect.js

@@ -71,20 +71,20 @@ const main = function (argv) {
       .command("$0 [key]", false, (cli) =>
         cli.positional("key", {
           default: conf.key,
-          describe: "Select a metadata key.",
+          describe: "Metadata key",
           type: "string",
         }),
       )
       .option("json", {
         alias: "j",
         default: conf.json,
-        describe: "Format output as JSON.",
+        describe: "Format output as JSON",
         type: "boolean",
       })
       .option("cwd", {
         alias: "C",
         default: ".",
-        describe: "Set the working directory.",
+        describe: "Set the working directory",
         type: "string",
       })
       .help("help")

package/bin/arc-login.js

@@ -104,7 +104,8 @@ const main = function (argv) {
       .usage("$0 [options]")
       .option("browser", {
         default: conf.browser,
-        describe: "Open a web browser automatically.",
+        describe:
+          "Open a web browser automatically (use --no-browser to disable)",
         type: "boolean",
       })
       .help("help")

package/bin/arc-pack.js

@@ -34,7 +34,7 @@ const SUBCMD = "pack";
 
 const conf = {
   json: false,
-  output: "package.zip",
+  output: "project.zip",
   quiet: false,
   ...findRc(CMD, SUBCMD, process.argv, ["--cwd", "-C"]),
 };
@@ -84,25 +84,25 @@ const main = function (argv) {
       .option("output", {
         alias: "o",
         default: conf.output,
-        describe: "Set the output path.",
+        describe: "Set the output path",
         type: "string",
       })
       .option("json", {
         alias: "j",
         default: conf.json,
-        describe: "Format output as JSON.",
+        describe: "Format output as JSON",
         type: "boolean",
       })
       .option("quiet", {
         alias: "q",
         default: conf.quiet,
-        describe: "Output only errors.",
+        describe: "Output only errors",
         type: "boolean",
       })
       .option("cwd", {
         alias: "C",
         default: ".",
-        describe: "Set the working directory.",
+        describe: "Set the working directory",
         type: "string",
       })
       .help("help")

package/bin/arc-validate.js

@@ -45,16 +45,13 @@ const start = function (argv) {
   return validate({ root: resolve(process.cwd(), argv.cwd) })
     .then((issues) => {
       const count = issues.length;
-      const term = count === 1 ? "issue" : "issues";
       if (json) {
         print({ issues });
+      } else if (count) {
+        log.hd(`${count} ${count === 1 ? "issue" : "issues"} found.`);
+        log.p(issues.map((error) => `✗ ${error}`));
       } else if (!quiet) {
-        if (count) {
-          log.hd(`${count} ${term} found.`);
-          log.p(issues.map((error) => `✗ ${error}`));
-        } else {
-          log.hs("Validated.");
-        }
+        log.hs("Validated.");
       }
       process.exit(count ? 1 : 0);
     })
@@ -80,19 +77,19 @@ const main = function (argv) {
       .option("json", {
         alias: "j",
         default: conf.json,
-        describe: "Format output as JSON.",
+        describe: "Format output as JSON",
         type: "boolean",
       })
       .option("quiet", {
         alias: "q",
         default: conf.quiet,
-        describe: "Output only errors.",
+        describe: "Output only errors",
         type: "boolean",
       })
       .option("cwd", {
         alias: "C",
         default: ".",
-        describe: "Set the working directory.",
+        describe: "Set the working directory",
         type: "string",
       })
       .help("help")

package/bin/arc-whoami.js

@@ -88,7 +88,7 @@ const main = function (argv) {
       .option("json", {
         alias: "j",
         default: conf.json,
-        describe: "Format output as JSON.",
+        describe: "Format output as JSON",
         type: "boolean",
       })
       .help("help")

package/package.json

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

package/src/action/deploy-git/git.js

@@ -27,7 +27,7 @@ const git = function (root, args, cb) {
 const ensureRepo = function (root, cb) {
   const message = [
     "Unable to find a Git repository.",
-    "Navigate to a Git repository and try again.",
+    "Ensure you are in a Git repository, or create one before continuing.",
   ];
   git(root, ["rev-parse", "--is-inside-work-tree"], (err) => {
     if (err) {
@@ -43,7 +43,7 @@ const ensureRepo = function (root, cb) {
 const ensureRemote = function (root, cb) {
   const message = [
     "Unable to access Git remote 'origin'.",
-    "Verify the remote exists and you have permission to access it.",
+    "Ensure the remote exists and you have permission to access it.",
   ];
   git(root, ["ls-remote", "origin"], (err) => {
     if (err) {
@@ -58,8 +58,8 @@ const ensureRemote = function (root, cb) {
 
 const ensureClean = function (root, cb) {
   const message = [
-    "Unable to continue with unstaged changes.",
-    "Stage, commit, or discard your local changes before deploying.",
+    "Unable to continue with Git changes present.",
+    "Ensure all changes are staged, committed, or discarded before continuing.",
   ];
   git(root, ["diff", "--quiet"], (err) => {
     if (err) {
@@ -89,7 +89,7 @@ const ensureClean = function (root, cb) {
 const createTag = function (root, version, cb) {
   const message = [
     "Unable to create Git tag.",
-    "Verify the release tag does not already exist locally.",
+    "Ensure the release tag does not already exist locally.",
   ];
   git(
     root,
@@ -117,7 +117,7 @@ const createTag = function (root, version, cb) {
 const pushTag = function (root, version, cb) {
   const message = [
     "Unable to push Git tag.",
-    "Verify the release tag does not already exist on remote 'origin'.",
+    "Ensure the release tag does not already exist on remote 'origin'.",
   ];
   git(root, ["push", "origin", `${PREFIX}${version}`], (err) => {
     if (err) {

package/src/action/deploy-git/tool.js

@@ -40,7 +40,7 @@ const deployEnsure = function ({ root }, { onInfo }, cb) {
       if (diff.cached) {
         onInfo({
           level: "warn",
-          message: "Staged but uncommitted changes will not be deployed.",
+          message: "Staged but uncommitted changes will not be included.",
         });
       }
       ensureRemote(root, cb);
@@ -64,7 +64,7 @@ const deploy = function (version, { root }, handler, cb) {
 
 const main = function ({ root }, { onBegin, ...handler }) {
   onBegin({ root });
-  return project.parse(root).then(
+  return project(root).then(
     ({ game }) =>
       new Promise((resolve, reject) => {
         deploy(game.version, { root }, handler, (err, data) => {

package/src/action/init/tool.js

@@ -27,14 +27,16 @@ const init = function (src, dest, { onBegin, onInfo }) {
 
 // [function]
 
-const main = function ({ force, project, root, starter }, handler) {
+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 exists. Run with `--force` to overwrite.");
+        throw new Error(
+          "Directory already exists. Use `--force` to overwrite.",
+        );
       }
-      return init(starter, dest, handler);
+      return init(template, dest, handler);
     })
     .then(() => ({ path: dest }));
 };

package/src/action/inspect/tool.js

@@ -17,7 +17,7 @@ const inspect = function (proj, key) {
 // [function]
 
 const main = function ({ key, root }) {
-  return project.parse(root).then((proj) => inspect(proj, key));
+  return project(root).then((proj) => inspect(proj, key));
 };
 
 // [export]

package/src/action/pack/tool.js

@@ -15,8 +15,8 @@ const Zip = require("../../util/zip");
 
 // [use]
 
+const parse = path.parse;
 const pathExists = fs.pathExists;
-const pathParse = path.parse;
 const resolve = path.resolve;
 
 // [declare]
@@ -46,8 +46,8 @@ const pack = function (name, game, { deployPath, mediaPath, zipPath }) {
 // [function]
 
 const main = function ({ output, root }) {
-  return project.parse(root).then(({ game, workflow }) =>
-    pack(pathParse(output).name, game, {
+  return project(root).then(({ game, workflow }) =>
+    pack(parse(output).name, game, {
       deployPath: resolve(root, workflow.deploy_dir),
       mediaPath: resolve(root, MEDIA),
       zipPath: resolve(root, output),

package/src/action/validate/tool.js

@@ -31,7 +31,7 @@ const validate = function (proj, { root }) {
 // [function]
 
 const main = function ({ root }) {
-  return project.parse(root).then((proj) => validate(proj, { root }));
+  return project(root).then((proj) => validate(proj, { root }));
 };
 
 // [export]

package/src/config/workflow.js

@@ -5,6 +5,6 @@
 module.exports = {
   /* eslint-disable camelcase */
   deploy_dir: ".arcadible-public",
-  skip_build: false,
+  skip_build: true,
   /* eslint-enable camelcase */
 };

package/src/parser/manifest.js

@@ -33,7 +33,7 @@ const parseToml = function (buf) {
 
 // [function]
 
-const parse = function (root) {
+const main = function (root) {
   const file = join(root, MANIFEST);
   return pathExists(file)
     .then((exists) => (exists ? readFile(file, "utf8") : null))
@@ -42,4 +42,4 @@ const parse = function (root) {
 
 // [export]
 
-module.exports = { parse };
+module.exports = main;

package/src/parser/media.js

@@ -14,11 +14,11 @@ const objs = require("../util/objs");
 
 // [use]
 
-const compactObjs = objs.compact;
+const deepCompact = objs.deepCompact;
 const extname = path.extname;
 const join = path.join;
+const parse = path.parse;
 const pathExists = fs.pathExists;
-const pathParse = path.parse;
 const readdir = fs.promises.readdir;
 
 // [declare]
@@ -44,7 +44,7 @@ const MEDIA = ".arcadible";
 
 const handleArt = function (exists) {
   return Object.fromEntries(
-    ART.map((f, i) => [pathParse(f).name, exists[i] ? join(MEDIA, f) : null]),
+    ART.map((f, i) => [parse(f).name, exists[i] ? join(MEDIA, f) : null]),
   );
 };
 
@@ -79,12 +79,12 @@ const gallery = function (root) {
 
 // [function]
 
-const parse = function (root) {
+const main = function (root) {
   return new Promise((resolve, reject) => {
     Promise.resolve({})
       .then(art(root))
       .then(gallery(root))
-      .then(compactObjs)
+      .then(deepCompact)
       .then((game) => ({ game }))
       .then(resolve)
       .catch(reject);
@@ -93,4 +93,4 @@ const parse = function (root) {
 
 // [export]
 
-module.exports = { parse };
+module.exports = main;

package/src/parser/pkg.js

@@ -8,8 +8,13 @@ const path = require("node:path");
 
 const fs = require("fs-extra");
 
+// [import]
+
+const objs = require("../util/objs");
+
 // [use]
 
+const deepCompact = objs.deepCompact;
 const join = path.join;
 const pathExists = fs.pathExists;
 const readFile = fs.readFile;
@@ -33,17 +38,16 @@ const parseJson = function (buf) {
 // [function]
 
 const extract = function (pkg) {
-  const game = { version: pkg.version || null };
-  return Object.fromEntries(
-    Object.entries({ game }).filter(([, value]) =>
-      Object.values(value).some(Boolean),
-    ),
-  );
+  /* eslint-disable camelcase */
+  const game = { version: pkg.version };
+  const workflow = { skip_build: pkg.scripts?.build ? false : null };
+  /* eslint-enable camelcase */
+  return deepCompact({ game, workflow });
 };
 
 // [function]
 
-const parse = function (root) {
+const main = function (root) {
   const file = join(root, PACKAGE);
   return pathExists(file)
     .then((exists) => (exists ? readFile(file, "utf8") : null))
@@ -53,4 +57,4 @@ const parse = function (root) {
 
 // [export]
 
-module.exports = { parse };
+module.exports = main;

package/src/parser/project.js

@@ -24,21 +24,22 @@ const configGame = function (readmeGame, mediaGame, pkgGame, manifestGame) {
 
 // [function]
 
-const configWorkflow = function (manifestWorkflow) {
+const configWorkflow = function (pkgWorkflow, manifestWorkflow) {
   return {
     ...cfgworkflow,
+    ...(pkgWorkflow || {}),
     ...(manifestWorkflow || {}),
   };
 };
 
 // [function]
 
-const parse = function (root) {
+const main = function (root) {
   const parsers = [
-    () => manifest.parse(root),
-    () => media.parse(root),
-    () => pkg.parse(root),
-    () => readme.parse(root),
+    () => manifest(root),
+    () => media(root),
+    () => pkg(root),
+    () => readme(root),
   ];
   return promise
     .serial(parsers)
@@ -49,11 +50,11 @@ const parse = function (root) {
         pkgData.game,
         manifestData.game,
       );
-      const workflow = configWorkflow(manifestData.workflow);
+      const workflow = configWorkflow(pkgData.workflow, manifestData.workflow);
       return { game, workflow };
     });
 };
 
 // [export]
 
-module.exports = { parse };
+module.exports = main;

package/src/parser/readme.js

@@ -17,7 +17,7 @@ const strs = require("../util/strs");
 
 // [use]
 
-const compactObjs = objs.compact;
+const deepCompact = objs.deepCompact;
 const join = path.join;
 const pathExists = fs.pathExists;
 const readFile = fs.readFile;
@@ -141,14 +141,14 @@ const findReadme = function (root) {
 
 // [function]
 
-const parse = function (root) {
+const main = function (root) {
   return findReadme(root)
     .then((file) => (file ? readFile(join(root, file), "utf8") : null))
     .then((buf) => (buf === null ? null : parseReadme(buf)))
-    .then(compactObjs)
+    .then(deepCompact)
     .then((game) => ({ game: game || null }));
 };
 
 // [export]
 
-module.exports = { parse };
+module.exports = main;

package/src/prompt/{starter.js → template.js}

@@ -10,32 +10,32 @@ module.exports = {
   select: {
     choices: [
       {
-        description: "Blank starter template.",
+        description: "Blank starter.",
         name: "Blank",
         value: `${REPO}/starter`,
       },
       {
-        description: "Three.js starter template.",
+        description: "Three.js starter.",
         name: "Three.js",
         value: `${REPO}/starter-threejs`,
       },
       {
-        description: "Phaser starter template.",
+        description: "Phaser starter.",
         name: "Phaser",
         value: `${REPO}/starter-phaser`,
       },
       {
-        description: "PixiJS starter template.",
+        description: "PixiJS starter.",
         name: "PixiJS",
         value: `${REPO}/starter-pixijs`,
       },
       {
-        description: "Babylon.js starter template.",
+        description: "Babylon.js starter.",
         name: "Babylon.js",
         value: `${REPO}/starter-babylonjs`,
       },
     ],
     default: `${REPO}/starter`,
-    message: "Starter",
+    message: "Template",
   },
 };