arcadible 0.1.39 → 0.1.41

package/README.md

@@ -7,7 +7,7 @@
 <h1 align="center">Arcadible CLI</h1>
 
 <p align="center">
-  Create, play, and share games with the world.
+  Create, play, and share games made with AI.
 </p>
 
 <p align="center">

package/package.json

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

package/src/action/predeploy/git.js

@@ -95,6 +95,23 @@ const ensureRepo = function (root) {
 
 // [function]
 
+// fails when the project isn't the repository's top level: the release
+// workflow builds from the root, so a project in a directory below it would
+// fail on GitHub, or release the root's game.
+const ensureRoot = function (root) {
+  return git(root, ["rev-parse", "--show-prefix"]).then((stdout) => {
+    const prefix = stdout.trim();
+    if (prefix) {
+      throw new ArcError(
+        cfgcode.PROJECT_NOT_REPO_ROOT,
+        phrase.projectNotRepoRoot(prefix),
+      );
+    }
+  });
+};
+
+// [function]
+
 // fails when HEAD has no release workflow, which Arcadible checks for when the
 // tag arrives (workflow_missing).
 const ensureWorkflow = function (root) {
@@ -178,6 +195,7 @@ module.exports = {
   ensureClean,
   ensureRemote,
   ensureRepo,
+  ensureRoot,
   ensureTagFree,
   ensureWorkflow,
   failWith,

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

@@ -19,6 +19,7 @@ const ensureClean = git.ensureClean;
 const ensureLockFile = pm.ensureLockFile;
 const ensureRemote = git.ensureRemote;
 const ensureRepo = git.ensureRepo;
+const ensureRoot = git.ensureRoot;
 const ensureTagFree = git.ensureTagFree;
 const ensureWorkflow = git.ensureWorkflow;
 const originRepo = git.originRepo;
@@ -71,10 +72,12 @@ const ensurePublishable = function ({ handle, id, version }, handler) {
 // [function]
 
 // the project's checks: a lockfile when there's a package.json, and a clean
-// repository with the release workflow and a reachable origin.
+// repository, whose root is the project, with the release workflow and a
+// reachable origin.
 const ensureProject = function (root) {
   return ensureLockFile(root)
     .then(() => ensureRepo(root))
+    .then(() => ensureRoot(root))
     .then(() => ensureClean(root))
     .then(() => ensureWorkflow(root))
     .then(() => ensureRemote(root));

package/src/config/code.js

@@ -24,6 +24,7 @@ const CLI = {
   LOCKFILE_MISSING: "lockfile_missing",
   LOGIN_EXPIRED: "login_expired",
   LOGIN_FAILED: "login_failed",
+  MANIFEST_MISSING: "manifest_missing",
   NETWORK_ERROR: "network_error",
   NOT_LOGGED_IN: "not_logged_in",
   PACKAGE_FILE_TOO_LARGE: "package_file_too_large",
@@ -33,6 +34,7 @@ const CLI = {
   PACKAGE_UNCOMPRESSED_TOO_LARGE: "package_uncompressed_too_large",
   PARSE_FAILED: "parse_failed",
   PATH_NOT_FOUND: "path_not_found",
+  PROJECT_NOT_REPO_ROOT: "project_not_repo_root",
   SESSION_EXPIRED: "session_expired",
   TEMPLATE_MISSING: "template_missing",
   TEMPLATE_UNAVAILABLE: "template_unavailable",
@@ -48,6 +50,7 @@ const CLI = {
 const RELEASE = {
   APP_NOT_INSTALLED: "app_not_installed",
   EXPIRED: "expired",
+  GAME_LIMIT_REACHED: "game_limit_reached",
   GAME_MISMATCH: "game_mismatch",
   GAME_UNAVAILABLE: "game_unavailable",
   INTERNAL: "internal",

package/src/parser/project.js

@@ -2,11 +2,16 @@
 
 // [import]
 
+const path = require("node:path");
+
+// [import]
+
 const fs = require("fs-extra");
 
 // [import]
 
 const cfgcode = require("../config/code");
+const cfgproduct = require("../config/product");
 const cfgworkflow = require("../config/workflow");
 const env = require("./env");
 const error = require("../util/error");
@@ -19,7 +24,16 @@ const readme = require("./readme");
 // [use]
 
 const ArcError = error.ArcError;
+const dirname = path.dirname;
+const isAbsolute = path.isAbsolute;
+const join = path.join;
 const pathExists = fs.pathExists;
+const relative = path.relative;
+const sep = path.sep;
+
+// [declare]
+
+const MANIFEST = `${cfgproduct.handle}.toml`;
 
 // [function]
 
@@ -44,6 +58,51 @@ const configWorkflow = function (envWorkflow, manifestWorkflow) {
 
 // [function]
 
+// a directory as the developer would type it: relative to where arc runs
+// when it's there, below it, or above it (`..`), or else its full path.
+const shown = function (dir) {
+  const rel = relative(process.cwd(), dir);
+  const above = rel.split(sep).every((part) => part === "..");
+  return isAbsolute(rel) || (rel.startsWith("..") && !above) ? dir : rel || ".";
+};
+
+// [function]
+
+// the nearest directory above `dir` with a manifest, or null. It's only
+// named in the error's hint: arc never reads a project it wasn't given.
+const nearestAbove = function (dir) {
+  const parent = dirname(dir);
+  if (parent === dir) {
+    return Promise.resolve(null);
+  }
+  return pathExists(join(parent, MANIFEST)).then((exists) => {
+    if (exists) {
+      return parent;
+    }
+    return nearestAbove(parent);
+  });
+};
+
+// [function]
+
+// fails when `root` has no manifest. A game's id is only ever in it, so a
+// project without one can't be deployed, and the likeliest cause is running
+// arc from inside a project: the hint names the project above, if any.
+const ensureManifest = function (root) {
+  return pathExists(join(root, MANIFEST))
+    .then((exists) => (exists ? false : nearestAbove(root)))
+    .then((found) => {
+      if (found !== false) {
+        throw new ArcError(
+          cfgcode.MANIFEST_MISSING,
+          phrase.noManifest(MANIFEST, shown(root), found && shown(found)),
+        );
+      }
+    });
+};
+
+// [function]
+
 // the other sources, once arcadible.toml is read: the README's title is read
 // word for word when arcadible.toml sets the short title.
 const parseSources = function (root, manifestData) {
@@ -66,16 +125,17 @@ const parseSources = function (root, manifestData) {
 
 // [function]
 
-// the project at `root`, which must exist: a mistyped -C would otherwise
-// read as an empty project.
+// the project at `root`, which must exist, with its manifest: a mistyped
+// -C would otherwise read as an empty project.
 const main = function (root) {
   return pathExists(root)
     .then((exists) => {
       if (!exists) {
         throw new ArcError(cfgcode.PATH_NOT_FOUND, phrase.unableToFind(root));
       }
-      return manifest(root);
+      return ensureManifest(root);
     })
+    .then(() => manifest(root))
     .then((manifestData) => parseSources(root, manifestData));
 };
 

package/src/phrase.js

@@ -214,6 +214,26 @@ const gitRemoteMissing = function () {
 
 // [function]
 
+const noManifest = 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`.",
+  );
+};
+
+// [function]
+
+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.",
+  );
+};
+
+// [function]
+
 const gitRepoMissing = function () {
   return blocks(
     "No Git repository found.",
@@ -771,6 +791,7 @@ module.exports = {
   loginFailed,
   noGameId,
   noLockFile,
+  noManifest,
   noProductionRelease,
   noTemplate,
   noVideoMetadata,
@@ -783,6 +804,7 @@ module.exports = {
   packageTooLarge,
   packageTooManyFiles,
   packageUncompressedTooLarge,
+  projectNotRepoRoot,
   releaseFailed,
   releasePublished,
   releaseTimedOut,

package/src/schema/workflow.js

@@ -43,45 +43,57 @@ const hasBuild = function (build) {
 
 // [function]
 
+// a value of neither type says what the matching kind expected, a list's for
+// a list and a string's otherwise, not the union's bare "Invalid input".
+const typeMessage = function (issue) {
+  const branch = Array.isArray(issue.input) ? 1 : 0;
+  return issue.errors?.[branch]?.[0]?.message;
+};
+
+// [function]
+
 const zBuild = function () {
-  // const field = "build";
-  return z.union([z.string(), z.array(z.string())]);
+  return z.union([z.string(), z.array(z.string())], { error: typeMessage });
 };
 
 // [function]
 
+// a directory inside the project with an index.html. Each check aborts the
+// rest when it fails, so one bad path gets one issue.
 const zDeployDir = function (root, { build }) {
   const field = "deploy_dir";
   return z
     .string()
-    .min(1, message(field, ["Must not be empty. Leave the field out instead."]))
-    .refine(
-      (file) => isRelativeCheck(root, file),
-      message(field, ["Must be a relative path."], ISSUE.PATH_INVALID),
-    )
-    .refine(
-      (file) => isInsideCheck(root, file),
-      message(field, ["Must be within the project."], ISSUE.PATH_INVALID),
-    )
-    .refine(
-      (file) => !isRootCheck(root, file),
-      message(
+    .min(1, {
+      ...message(field, ["Must not be empty. Leave the field out instead."]),
+      abort: true,
+    })
+    .refine((file) => isRelativeCheck(root, file), {
+      ...message(field, ["Must be a relative path."], ISSUE.PATH_INVALID),
+      abort: true,
+    })
+    .refine((file) => isInsideCheck(root, file), {
+      ...message(field, ["Must be within the project."], ISSUE.PATH_INVALID),
+      abort: true,
+    })
+    .refine((file) => !isRootCheck(root, file), {
+      ...message(
         field,
         ["Must be a directory inside the project, not the project root."],
         ISSUE.PATH_INVALID,
       ),
-    )
-    .refine(
-      (file) => avoidsCheck(root, file, MEDIA),
-      message(
+      abort: true,
+    })
+    .refine((file) => avoidsCheck(root, file, MEDIA), {
+      ...message(
         field,
         [`Must not contain ${MEDIA} in path.`],
         ISSUE.PATH_INVALID,
       ),
-    )
-    .refine(
-      (file) => hasBuild(build) || existsCheck(root, file),
-      message(
+      abort: true,
+    })
+    .refine((file) => hasBuild(build) || existsCheck(root, file), {
+      ...message(
         field,
         [
           "Must exist when no build step is defined.",
@@ -89,25 +101,26 @@ const zDeployDir = function (root, { build }) {
         ],
         ISSUE.PATH_INVALID,
       ),
-    )
-    .refine(
-      (file) => hasFileCheck(root, file, INDEX),
-      message(
+      abort: true,
+    })
+    .refine((file) => hasFileCheck(root, file, INDEX), {
+      ...message(
         field,
         [`Must have an ${INDEX} at its root.`],
         ISSUE.INDEX_MISSING,
       ),
-    )
-    .refine(
-      (file) => lacksFilesCheck(root, file, RESERVED),
-      message(
+      abort: true,
+    })
+    .refine((file) => lacksFilesCheck(root, file, RESERVED), {
+      ...message(
         field,
         [
           `Must not have ${RESERVED.join(" or ")} at its root. They're reserved for the files ${cfgproduct.title} adds.`,
         ],
         ISSUE.PATH_INVALID,
       ),
-    );
+      abort: true,
+    });
 };
 
 // [function]

package/src/util/schema.js

@@ -39,6 +39,13 @@ const codeOf = function (issue) {
       return typeof issue.input === "undefined"
         ? ISSUE.REQUIRED
         : ISSUE.TYPE_INVALID;
+    case "invalid_union":
+      // every branch refused the value's type, e.g. `build = 3`
+      return issue.errors.every((branch) =>
+        branch.every((each) => each.code === "invalid_type"),
+      )
+        ? ISSUE.TYPE_INVALID
+        : ISSUE.INVALID;
     case "invalid_value":
       return ISSUE.OPTION_INVALID;
     case "too_big":