arcadible 0.1.45 → 0.1.46

package/src/parser/manifest.js

@@ -11,22 +11,23 @@ const fs = require("fs-extra");
 // [import]
 
 const cfgcode = require("../config/code");
-const cfgproduct = require("../config/product");
+const cfgfile = require("../config/file");
 const error = require("../util/error");
+const objs = require("../util/objs");
 const phrase = require("../phrase");
 const TOML = require("../util/toml");
 
 // [use]
 
 const ArcError = error.ArcError;
+const isTable = objs.isTable;
 const join = path.join;
 const pathExists = fs.pathExists;
 const readFile = fs.readFile;
 
 // [declare]
 
-const HANDLE = cfgproduct.handle;
-const MANIFEST = `${HANDLE}.toml`;
+const MANIFEST = cfgfile.MANIFEST;
 
 // [function]
 
@@ -45,12 +46,7 @@ const parseToml = function (buf) {
 // [function]
 
 const isEmptyTable = function (value) {
-  return (
-    value !== null &&
-    typeof value === "object" &&
-    !Array.isArray(value) &&
-    !Object.keys(value).length
-  );
+  return isTable(value) && !Object.keys(value).length;
 };
 
 // [function]
@@ -65,14 +61,20 @@ const extract = function (conf) {
 
 // [function]
 
-const main = function (root) {
+// arcadible.toml as written, or {} without it.
+const read = function (root) {
   const file = join(root, MANIFEST);
   return pathExists(file)
     .then((exists) => (exists ? readFile(file, "utf8") : null))
-    .then((buf) => (buf === null ? {} : parseToml(buf)))
-    .then((conf) => (Object.keys(conf).length ? extract(conf) : {}));
+    .then((buf) => (buf === null ? {} : parseToml(buf)));
+};
+
+// [function]
+
+const main = function (root) {
+  return read(root).then(extract);
 };
 
 // [export]
 
-module.exports = main;
+module.exports = Object.assign(main, { read });

package/src/parser/media.js

@@ -11,8 +11,8 @@ const fs = require("fs-extra");
 // [import]
 
 const cfgart = require("../config/art");
+const cfgfile = require("../config/file");
 const cfgimage = require("../config/image");
-const cfgproduct = require("../config/product");
 const cfgvideo = require("../config/video");
 const objs = require("../util/objs");
 
@@ -22,17 +22,15 @@ const deepCompact = objs.deepCompact;
 const extname = path.extname;
 const join = path.join;
 const parse = path.parse;
+// the manifest's paths use `/` on every platform, as Arcadible's do.
+const posixJoin = path.posix.join;
 const pathExists = fs.pathExists;
 const readdir = fs.promises.readdir;
 
 // [declare]
 
-const ART = cfgart;
-
-// [declare]
-
-const HANDLE = cfgproduct.handle;
-const MEDIA = `.${HANDLE}`;
+const GALLERY = cfgfile.GALLERY;
+const MEDIA = cfgfile.MEDIA;
 
 // [function]
 
@@ -50,9 +48,9 @@ const art = function (root) {
     list(join(root, MEDIA)).then((names) => ({
       ...game,
       ...Object.fromEntries(
-        ART.map((f) => [
+        cfgart.map((f) => [
           parse(f).name,
-          names.includes(f) ? join(MEDIA, f) : null,
+          names.includes(f) ? posixJoin(MEDIA, f) : null,
         ]),
       ),
     }));
@@ -64,7 +62,7 @@ const handleGallery = function (entries) {
   const exts = [...Object.keys(cfgimage), ...Object.keys(cfgvideo)];
   return entries
     .filter((f) => exts.includes(extname(f)))
-    .map((f) => join(MEDIA, "gallery", f))
+    .map((f) => posixJoin(GALLERY, f))
     .sort();
 };
 
@@ -72,7 +70,7 @@ const handleGallery = function (entries) {
 
 const gallery = function (root) {
   return (game) =>
-    list(join(root, MEDIA, "gallery"))
+    list(join(root, GALLERY))
       .then(handleGallery)
       .then((data) => ({ ...game, gallery: data }));
 };

package/src/parser/project.js

@@ -11,15 +11,17 @@ const fs = require("fs-extra");
 // [import]
 
 const cfgcode = require("../config/code");
-const cfgproduct = require("../config/product");
+const cfgfile = require("../config/file");
 const cfgworkflow = require("../config/workflow");
 const env = require("./env");
 const error = require("../util/error");
+const gameSchema = require("../schema/game");
 const manifest = require("./manifest");
 const media = require("./media");
 const phrase = require("../phrase");
 const promise = require("../util/promise");
 const readme = require("./readme");
+const workflowSchema = require("../schema/workflow");
 
 // [use]
 
@@ -33,7 +35,7 @@ const sep = path.sep;
 
 // [declare]
 
-const MANIFEST = `${cfgproduct.handle}.toml`;
+const MANIFEST = cfgfile.MANIFEST;
 
 // [function]
 
@@ -48,6 +50,18 @@ const configGame = function (readmeGame, mediaGame, envGame, manifestGame) {
 
 // [function]
 
+// the fields of `values` that `schema` knows. Arcadible ignores the rest, so
+// they're left out of what's packed and inspected; arc validate warns about
+// each (action/validate/unknown.js).
+const known = function (values, schema, root) {
+  const fields = Object.keys(schema({}, { root }).shape);
+  return Object.fromEntries(
+    Object.entries(values).filter(([field]) => fields.includes(field)),
+  );
+};
+
+// [function]
+
 const configWorkflow = function (envWorkflow, manifestWorkflow) {
   return {
     ...cfgworkflow,
@@ -95,7 +109,7 @@ const ensureManifest = function (root) {
       if (found !== false) {
         throw new ArcError(
           cfgcode.MANIFEST_MISSING,
-          phrase.noManifest(MANIFEST, shown(root), found && shown(found)),
+          phrase.manifestMissing(MANIFEST, shown(root), found && shown(found)),
         );
       }
     });
@@ -113,13 +127,21 @@ const parseSources = function (root, manifestData) {
     () => env(root),
   ];
   return promise.serial(parsers).then(([readmeData, mediaData, envData]) => ({
-    game: configGame(
-      readmeData.game,
-      mediaData.game,
-      envData.game,
-      manifestData.game,
+    game: known(
+      configGame(
+        readmeData.game,
+        mediaData.game,
+        envData.game,
+        manifestData.game,
+      ),
+      gameSchema,
+      root,
+    ),
+    workflow: known(
+      configWorkflow(envData.workflow, manifestData.workflow),
+      workflowSchema,
+      root,
     ),
-    workflow: configWorkflow(envData.workflow, manifestData.workflow),
   }));
 };
 

package/src/phrase.js

@@ -32,6 +32,13 @@ const waited = function (seconds) {
 
 // [function]
 
+// a command's heading when it fails: `Deploy aborted.`
+const aborted = function (command) {
+  return `${command[0].toUpperCase()}${command.slice(1)} aborted.`;
+};
+
+// [function]
+
 // a build that exited with `code`, or was stopped by `signal`, with what it
 // wrote to stderr.
 const buildFailed = function ({ code, signal, stderr }) {
@@ -71,12 +78,30 @@ const buildSubmitted = function (version, channel, built) {
 
 // [function]
 
+const buildSucceeded = function () {
+  return "Built.";
+};
+
+// [function]
+
+const cmdBuild = function () {
+  return `\`${TOOL} build\``;
+};
+
+// [function]
+
 const cmdDeploy = function () {
   return `\`${TOOL} deploy\``;
 };
 
 // [function]
 
+const cmdDeployGit = function () {
+  return `\`${TOOL} deploy git\``;
+};
+
+// [function]
+
 const cmdInit = function () {
   return `\`${TOOL} init\``;
 };
@@ -104,12 +129,18 @@ const cmdValidate = function () {
 const deployDirMissing = function (dir) {
   return blocks(
     `Unable to find deploy_dir: ${dir}`,
-    "Run `arc build`, or set deploy_dir to the folder your build writes.",
+    `Run ${cmdBuild()}, or set deploy_dir to the folder your build writes.`,
   );
 };
 
 // [function]
 
+const didYouMean = function (near) {
+  return `Did you mean: ${near}?`;
+};
+
+// [function]
+
 const docAttrInvalid = function (tag, attr, value) {
   return `Value '${value}' is not valid for the '${attr}' attribute on the '${tag}' tag.`;
 };
@@ -140,20 +171,22 @@ const docMediaMissing = function (src) {
 
 // [function]
 
-const docMediaType = function (src) {
-  return `Must be a PNG or MP4 file: ${src}`;
+// a description media src that isn't written as the gallery's path to it,
+// such as `./.arcadible/gallery/x.png`: Arcadible matches it as written.
+const docMediaPath = function (src, gallery) {
+  return `Must be written as ${gallery}/<file>: ${src}`;
 };
 
 // [function]
 
-const docTagUnallowed = function (tag) {
-  return `Tag '${tag}' is not permitted.`;
+const docMediaType = function (src) {
+  return `Must be a PNG or MP4 file: ${src}`;
 };
 
 // [function]
 
-const docUnsupported = function () {
-  return "Document has an unsupported file type.";
+const docTagUnallowed = function (tag) {
+  return `Tag '${tag}' is not permitted.`;
 };
 
 // [function]
@@ -183,8 +216,76 @@ const gameNotDeployed = function (game) {
 
 // [function]
 
+const initialized = function () {
+  return "Initialized.";
+};
+
+// [function]
+
+// the heading of arc validate's list of issues, warnings, or references:
+// `2 issues:`
+const listed = function (count, noun) {
+  return `${count} ${noun}${count === 1 ? "" : "s"}:`;
+};
+
+// [function]
+
+const loggedIn = function () {
+  return "Logged in.";
+};
+
+// [function]
+
+const loggedOut = function () {
+  return "Logged out.";
+};
+
+// [function]
+
+const loggingIn = function () {
+  return "Logging in...";
+};
+
+// [function]
+
+const noAccount = function () {
+  return "Not logged in.";
+};
+
+// [function]
+
+const noIssuesFound = function () {
+  return "No issues found.";
+};
+
+// [function]
+
+const nothingToDo = function () {
+  return "Nothing to do.";
+};
+
+// [function]
+
+const packed = function () {
+  return "Packed.";
+};
+
+// [function]
+
+const pressEnterToOpen = function () {
+  return "Press Enter to open the URL.";
+};
+
+// [function]
+
+const releaseFailedHeading = function () {
+  return "Release failed.";
+};
+
+// [function]
+
 // origin isn't the game's connected repository: none is, or another is.
-const gameRepoMissing = function (game, repo, url) {
+const repoNotConnected = function (game, repo, url) {
   return blocks(`${repo} isn't ${game}'s repository on ${TITLE}.`, [
     `The game's owner connects it in ${TITLE} Studio, on the game's Repository tab, and connects it again if it was renamed on GitHub:`,
     url,
@@ -208,7 +309,7 @@ const gameUnavailable = function (id) {
 
 // [function]
 
-const gitChangesPresent = function () {
+const gitUncommitted = function () {
   return blocks(
     "Uncommitted changes found.",
     "Commit, stash, or discard them first.",
@@ -235,12 +336,12 @@ const gitRemoteUnreachable = function () {
 
 // [function]
 
-const noManifest = function (file, dir, found) {
+const manifestMissing = function (file, dir, found) {
   return blocks(
     dir === "." ? `No ${file} in this directory.` : `No ${file} in ${dir}.`,
     found
-      ? `The project is in \`${found}\`: run arc there, or pass \`-C ${found}\`.`
-      : "Run arc in the project's directory, or pass -C, or start a project with `arc init`.",
+      ? `The project is in \`${found}\`: run ${TOOL} there, or pass \`-C ${found}\`.`
+      : `Run ${TOOL} in the project's directory, or pass \`-C\`, or start a project with ${cmdInit()}.`,
   );
 };
 
@@ -248,8 +349,8 @@ const noManifest = function (file, dir, found) {
 
 const projectNotRepoRoot = function (prefix) {
   return blocks(
-    `arc deploy git releases the project at the repository's root, and this one is in ${prefix}`,
-    "Deploy it with `arc deploy`, or give it a repository of its own.",
+    `${cmdDeployGit()} releases the project at the repository's root, and this one is in ${prefix}.`,
+    `Deploy it with ${cmdDeploy()}, or give it a repository of its own.`,
   );
 };
 
@@ -282,7 +383,7 @@ const gitTagPushFailed = function (version) {
 
 // [function]
 
-const gitVersionExists = function (version) {
+const gitTagExists = function (version) {
   return blocks(
     `Git tag for v${version} already exists, here or on origin.`,
     "Bump the version.",
@@ -390,7 +491,7 @@ const loginFailed = function () {
 
 // [function]
 
-const noGameId = function () {
+const gameIdMissing = function () {
   return blocks(
     "No game handle or ID.",
     `Pass one, or run it in a project after ${cmdInit()} has added an ID.`,
@@ -399,7 +500,7 @@ const noGameId = function () {
 
 // [function]
 
-const noLockFile = function () {
+const lockfileMissing = function () {
   return blocks("No lockfile found.", [
     "Install your dependencies to create one.",
     "Then commit it.",
@@ -414,7 +515,7 @@ const noProductionRelease = function () {
 
 // [function]
 
-const noTemplate = function () {
+const templateMissing = function () {
   return blocks("No template chosen.", [
     "Pass `--template <user/repo>`.",
     "Or pass `--yes` for the blank starter.",
@@ -424,7 +525,7 @@ const noTemplate = function () {
 // [function]
 
 const notLoggedIn = function () {
-  return blocks("Not logged in.", `Run ${cmdLogin()} to log in.`);
+  return blocks(noAccount(), `Run ${cmdLogin()} to log in.`);
 };
 
 // [function]
@@ -453,7 +554,7 @@ const openToContinue = function () {
 
 // [function]
 
-const packageFileMissing = function (file) {
+const packageIndexMissing = function (file) {
   return `Package is missing '${file}'.`;
 };
 
@@ -622,12 +723,6 @@ const templateUnavailable = function (template) {
 
 // [function]
 
-const timedOut = function () {
-  return "Timed out.";
-};
-
-// [function]
-
 const unableToFind = function (file) {
   return `Unable to find: ${file}`;
 };
@@ -641,7 +736,7 @@ const unableToOpen = function () {
 // [function]
 
 const unableToParse = function (file, message) {
-  return blocks(`Unable to parse ${file}.`, message);
+  return blocks(`Unable to parse ${file}.`, message.trim());
 };
 
 // [function]
@@ -655,6 +750,18 @@ const unableToReach = function () {
 
 // [function]
 
+const unknownField = function () {
+  return "Unknown field.";
+};
+
+// [function]
+
+const unknownTable = function () {
+  return "Unknown table.";
+};
+
+// [function]
+
 const uploadFailed = function (status) {
   return `Upload failed with status ${status}.`;
 };
@@ -670,6 +777,12 @@ const uploadRateLimited = function (version) {
 
 // [function]
 
+const waitTimedOut = function () {
+  return "Wait timed out.";
+};
+
+// [function]
+
 const workflowMissing = function (file) {
   return blocks(
     `No release workflow found: ${file}`,
@@ -687,7 +800,7 @@ const versionPrerelease = function (version) {
 
 // a version that's already published, with what is, so the developer knows
 // what to bump to.
-const versionPublished = function (version, { next, production, staging }) {
+const versionExists = function (version, { next, production, staging }) {
   const latest = [
     production ? `Production: ${production}` : null,
     staging ? `Staging: ${staging}` : null,
@@ -780,35 +893,38 @@ const videoWidthMin = function (width) {
 // [export]
 
 module.exports = {
+  aborted,
   buildFailed,
   buildOutputMissing,
   buildPublishing,
   buildPublishingGit,
   buildSubmitted,
+  buildSucceeded,
   cmdInit,
   cmdInspect,
   deployDirMissing,
+  didYouMean,
   docAttrInvalid,
   docAttrUnallowed,
   docCommentUnallowed,
   docMediaElement,
   docMediaMissing,
+  docMediaPath,
   docMediaType,
   docTagUnallowed,
-  docUnsupported,
   errorCode,
   gameHandleTaken,
+  gameIdMissing,
   gameNotDeployed,
   gameNotFound,
-  gameRepoMissing,
   gameUnavailable,
-  gitChangesPresent,
   gitRemoteMissing,
   gitRemoteUnreachable,
   gitRepoMissing,
   gitTagCreateFailed,
+  gitTagExists,
   gitTagPushFailed,
-  gitVersionExists,
+  gitUncommitted,
   httpError,
   imageAspect,
   imageFound,
@@ -819,30 +935,40 @@ module.exports = {
   imageUnsupported,
   imageWidthMax,
   imageWidthMin,
+  initialized,
   issuesAfterBuild,
   issuesFound,
+  listed,
+  lockfileMissing,
+  loggedIn,
+  loggedOut,
+  loggingIn,
   loginCodeExpired,
   loginFailed,
-  noGameId,
-  noLockFile,
-  noManifest,
+  manifestMissing,
+  noAccount,
+  noIssuesFound,
   noProductionRelease,
-  noTemplate,
   noVideoMetadata,
   noVideoTrack,
   notLoggedIn,
+  nothingToDo,
   openToContinue,
   opened,
-  packageFileMissing,
   packageFileTooLarge,
+  packageIndexMissing,
   packageTooLarge,
   packageTooManyFiles,
   packageUncompressedTooLarge,
+  packed,
+  pressEnterToOpen,
   projectNotRepoRoot,
   releaseFailed,
+  releaseFailedHeading,
   releasePublished,
   releaseTimedOut,
   releaseWaiting,
+  repoNotConnected,
   sessionExpired,
   sizeB,
   sizeGb,
@@ -854,17 +980,19 @@ module.exports = {
   starterPixiJs,
   starterThreeJs,
   tagPushed,
+  templateMissing,
   templateUnavailable,
-  timedOut,
   timeoutInvalid,
   unableToFind,
   unableToOpen,
   unableToParse,
   unableToReach,
+  unknownField,
+  unknownTable,
   uploadFailed,
   uploadRateLimited,
+  versionExists,
   versionPrerelease,
-  versionPublished,
   versionRelease,
   versionUnchecked,
   videoAspect,
@@ -878,5 +1006,6 @@ module.exports = {
   videoUnsupported,
   videoWidthMax,
   videoWidthMin,
+  waitTimedOut,
   workflowMissing,
 };