arcadible 1.0.2 → 1.0.5

package/src/action/validate/checked.js

@@ -0,0 +1,37 @@
+"use strict";
+
+// [import]
+
+const cfgcode = require("../../config/code");
+const error = require("../../util/error");
+const phrase = require("../../phrase");
+const project = require("../../parser/project");
+const validateTool = require("./tool");
+
+// [use]
+
+const ArcError = error.ArcError;
+
+// [function]
+
+// parses and validates the project at `root` for a command that goes on from
+// it (arc build, arc pack, arc deploy): resolves with the parsed project, or
+// rejects as validation_failed with its issues in `data`. `onWarnings` gets
+// the warnings either way, for --json to list beside the result or the error.
+const checked = async function (root, onWarnings) {
+  const parsed = await project(root);
+  const { issues, warnings } = await validateTool({ project: parsed, root });
+  onWarnings(warnings);
+  if (issues.length) {
+    throw new ArcError(
+      cfgcode.VALIDATION_FAILED,
+      phrase.issuesFound(issues.length),
+      { data: { issues } },
+    );
+  }
+  return parsed;
+};
+
+// [export]
+
+module.exports = checked;

package/src/api.js

@@ -11,6 +11,18 @@ const VERSION = "v1";
 
 // [function]
 
+// an API path with each value encoded as one segment, so a handle or version
+// can't add a segment or a query: pathOf`/games/${id}`.
+const pathOf = function (strings, ...values) {
+  return strings.reduce(
+    (out, each, i) =>
+      out + each + (i < values.length ? encodeURIComponent(values[i]) : ""),
+    "",
+  );
+};
+
+// [function]
+
 // the full URL of an API path, with `params` as its query. Undefined and null
 // params are left out.
 const endpoint = function (path, params) {
@@ -45,7 +57,7 @@ const postFlow = function (form, params, headers) {
 // [function]
 
 const flow = function (id, params, headers) {
-  return request.get(endpoint(`/flows/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/flows/${id}`, params), headers);
 };
 
 // [function]
@@ -57,20 +69,23 @@ const postUpload = function (form, params, headers) {
 // [function]
 
 const discoverGame = function (id, params, headers) {
-  return request.get(endpoint(`/discover/games/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/discover/games/${id}`, params), headers);
 };
 
 // [function]
 
 const discoverGameBuilds = function (id, params, headers) {
-  return request.get(endpoint(`/discover/games/${id}/builds`, params), headers);
+  return request.get(
+    endpoint(pathOf`/discover/games/${id}/builds`, params),
+    headers,
+  );
 };
 
 // [function]
 
 const discoverGameBuild = function (id, version, params, headers) {
   return request.get(
-    endpoint(`/discover/games/${id}/builds/${version}`, params),
+    endpoint(pathOf`/discover/games/${id}/builds/${version}`, params),
     headers,
   );
 };
@@ -80,7 +95,7 @@ const discoverGameBuild = function (id, version, params, headers) {
 // a game's releases, which anyone can read: what each says about itself.
 const discoverGameReleases = function (id, params, headers) {
   return request.get(
-    endpoint(`/discover/games/${id}/releases`, params),
+    endpoint(pathOf`/discover/games/${id}/releases`, params),
     headers,
   );
 };
@@ -90,10 +105,7 @@ const discoverGameReleases = function (id, params, headers) {
 // the game's connected repository, if it's `owner/name`; otherwise 404.
 const discoverGameRepo = function (id, owner, name, params, headers) {
   return request.get(
-    endpoint(
-      `/discover/games/${id}/repos/${encodeURIComponent(owner)}/${encodeURIComponent(name)}`,
-      params,
-    ),
+    endpoint(pathOf`/discover/games/${id}/repos/${owner}/${name}`, params),
     headers,
   );
 };
@@ -102,7 +114,7 @@ const discoverGameRepo = function (id, owner, name, params, headers) {
 
 const gameBuild = function (id, version, params, headers) {
   return request.get(
-    endpoint(`/games/${id}/builds/${version}`, params),
+    endpoint(pathOf`/games/${id}/builds/${version}`, params),
     headers,
   );
 };
@@ -113,7 +125,7 @@ const gameBuild = function (id, version, params, headers) {
 // its status is available, taken, limit, or lapsed.
 const gameHandle = function (id, handle, params, headers) {
   return request.get(
-    endpoint(`/games/${id}/handles/${handle}`, params),
+    endpoint(pathOf`/games/${id}/handles/${handle}`, params),
     headers,
   );
 };
@@ -121,13 +133,16 @@ const gameHandle = function (id, handle, params, headers) {
 // [function]
 
 const release = function (id, params, headers) {
-  return request.get(endpoint(`/releases/${id}`, params), headers);
+  return request.get(endpoint(pathOf`/releases/${id}`, params), headers);
 };
 
 // [function]
 
 const accountReleases = function (id, params, headers) {
-  return request.get(endpoint(`/accounts/${id}/releases`, params), headers);
+  return request.get(
+    endpoint(pathOf`/accounts/${id}/releases`, params),
+    headers,
+  );
 };
 
 // [export]

package/src/config/code.js

@@ -13,6 +13,7 @@ const CLI = {
   ARGUMENT_INVALID: "argument_invalid",
   BUILD_FAILED: "build_failed",
   DEPLOY_DIR_MISSING: "deploy_dir_missing",
+  DEPLOY_RATE_LIMITED: "deploy_rate_limited",
   GAME_HANDLE_TAKEN: "game_handle_taken",
   GAME_ID_MISSING: "game_id_missing",
   GAME_NOT_DEPLOYED: "game_not_deployed",
@@ -43,7 +44,6 @@ const CLI = {
   TEMPLATE_MISSING: "template_missing",
   TEMPLATE_UNAVAILABLE: "template_unavailable",
   UPLOAD_FAILED: "upload_failed",
-  UPLOAD_RATE_LIMITED: "upload_rate_limited",
   VALIDATION_FAILED: "validation_failed",
   WAIT_TIMED_OUT: "wait_timed_out",
 };
@@ -105,7 +105,7 @@ const WARNING = {
   DEPLOY_DIR_NOT_BUILT: "deploy_dir_not_built",
   FIELD_UNKNOWN: "field_unknown",
   GAME_HANDLE_LAPSED: "game_handle_lapsed",
-  GAME_HANDLE_LIMIT: "game_handle_limit",
+  GAME_HANDLE_LIMIT_REACHED: "game_handle_limit_reached",
   VERSION_UNCHECKED: "version_unchecked",
 };
 // every error code, for checking one exists.

package/src/parser/readme.js

@@ -12,7 +12,7 @@ const strs = require("../util/strs");
 const deepCompact = objs.deepCompact;
 const trimWhitespace = strs.trimWhitespace;
 
-// [define]
+// [declare]
 
 const COMMENT = 8;
 

package/src/phrase.js

@@ -6,8 +6,10 @@ const cfgproduct = require("./config/product");
 
 // [declare]
 
+const HANDLE = cfgproduct.handle;
 const TITLE = cfgproduct.title;
 const TOOL = cfgproduct.tool;
+const TAIL_LINES = 20;
 
 // [function]
 
@@ -21,6 +23,22 @@ const blocks = function (reason, ...details) {
 
 // [function]
 
+// the last lines a tool printed, stdout's then stderr's, since some, such as
+// tsc, print their errors on stdout, or "" when it printed nothing. Lines
+// left out are marked with "…".
+const tail = function (...outputs) {
+  const lines = outputs
+    .map((output) => output?.trim())
+    .filter(Boolean)
+    .join("\n")
+    .split("\n");
+  return lines.length > TAIL_LINES
+    ? ["…", ...lines.slice(-TAIL_LINES)].join("\n")
+    : lines.join("\n");
+};
+
+// [function]
+
 // a wait, in words: "5 minutes", "90 seconds".
 const waited = function (seconds) {
   if (seconds % 60 === 0) {
@@ -39,10 +57,10 @@ const aborted = function (command) {
 
 // [function]
 
-// a build that exited with `code`, or was stopped by `signal`, with what it
-// wrote to stderr.
-const buildFailed = function ({ code, signal, stderr }) {
-  const output = stderr?.trim();
+// a build that exited with `code`, or was stopped by `signal`, with the end
+// of what it printed.
+const buildFailed = function ({ code, signal, stderr, stdout }) {
+  const output = tail(stdout, stderr);
   return blocks(
     signal
       ? `Build stopped by ${signal}.`
@@ -142,19 +160,19 @@ const didYouMean = function (near) {
 // [function]
 
 const docAttrInvalid = function (tag, attr, value) {
-  return `Value '${value}' is not valid for the '${attr}' attribute on the '${tag}' tag.`;
+  return `Value '${value}' isn't allowed for ${attr} on <${tag}>.`;
 };
 
 // [function]
 
 const docAttrUnallowed = function (tag, attr) {
-  return `Attribute '${attr}' is not permitted on the '${tag}' tag.`;
+  return `Attribute ${attr} isn't allowed on <${tag}>.`;
 };
 
 // [function]
 
 const docCommentUnallowed = function () {
-  return "HTML comments are not permitted.";
+  return "HTML comments aren't allowed.";
 };
 
 // [function]
@@ -186,7 +204,7 @@ const docMediaType = function (src) {
 // [function]
 
 const docTagUnallowed = function (tag) {
-  return `Tag '${tag}' is not permitted.`;
+  return `Tag <${tag}> isn't allowed.`;
 };
 
 // [function]
@@ -208,13 +226,13 @@ const gameHandleTaken = function (handle) {
 // [function]
 
 const gameHandleLapsed = function (handle) {
-  return `Handle ${handle} lapsed: it comes back with a production release, so deploying without it.`;
+  return `Handle ${handle} lapsed, so deploying without it.\nA production release takes it back.`;
 };
 
 // [function]
 
 const gameHandleLimit = function (handle) {
-  return `Handle ${handle} not applied: your unreleased games already hold 5 handles, so deploying without it.`;
+  return `Handle ${handle} not applied, so deploying without it.\nYour unreleased games already hold 5 handles.`;
 };
 
 // [function]
@@ -285,7 +303,7 @@ const packed = function () {
 // [function]
 
 const portInvalid = function () {
-  return "The port must be a whole number from 1 to 65535.";
+  return "`--port` must be a whole number from 1 to 65535.";
 };
 
 // [function]
@@ -311,13 +329,13 @@ const remoteName = function (name) {
 
 // arc serve's copy of one of Arcadible's files, kept from `fetchedAt`.
 const remoteKept = function (name, fetchedAt) {
-  return `${TITLE} can't be reached, so serving ${remoteName(name)} saved on ${fetchedAt.slice(0, 10)}.`;
+  return `Unable to reach ${TITLE}.\nServing ${remoteName(name)} saved on ${fetchedAt.slice(0, 10)}.`;
 };
 
 // [function]
 
 const remoteUnreachable = function (name) {
-  return `${TITLE} can't be reached, and ${remoteName(name)} isn't saved yet. The game runs without it until ${TITLE} is back.`;
+  return `Unable to reach ${TITLE}, and ${remoteName(name)} isn't saved.\nThe game runs without it until ${TITLE} is back.`;
 };
 
 // [function]
@@ -334,6 +352,20 @@ const serveAlone = function () {
 
 // [function]
 
+// the label before a play link in a result.
+const playLabel = function () {
+  return "Play:";
+};
+
+// [function]
+
+// the label before a store page's link in a result.
+const storeLabel = function () {
+  return "Store:";
+};
+
+// [function]
+
 const serveNext = function (dir) {
   return `Reloads when ${dir}/ changes. Press Ctrl+C to stop.`;
 };
@@ -359,7 +391,7 @@ const serveNextUrl = function () {
 // [function]
 
 const urlInvalid = function () {
-  return "The URL must start with http:// or https://, such as http://localhost:5173.";
+  return "`--url` must start with http:// or https://.";
 };
 
 // [function]
@@ -368,8 +400,12 @@ const urlInvalid = function () {
 // says how to add them.
 const urlNotFrameable = function (url, link) {
   return blocks(
-    `⚠ The play page can't frame ${url}.`,
-    "Send Cross-Origin-Embedder-Policy: require-corp and Cross-Origin-Resource-Policy: cross-origin.",
+    `The play page can't frame ${url}.`,
+    [
+      "Its server doesn't send the headers the play page needs:",
+      "Cross-Origin-Embedder-Policy: require-corp",
+      "Cross-Origin-Resource-Policy: cross-origin",
+    ],
     ["Add them to your server, as the starters' vite.config.js does:", link],
   );
 };
@@ -377,7 +413,7 @@ const urlNotFrameable = function (url, link) {
 // [function]
 
 const urlUnreachable = function (url) {
-  return `⚠ Nothing answers at ${url} yet. Start your server, then reload the play page.`;
+  return `Nothing answers at ${url}.\nStart your server, then reload the play page.`;
 };
 
 // [function]
@@ -396,10 +432,11 @@ const releaseFailedHeading = function () {
 
 // origin isn't the game's connected repository: none is, or another is.
 const repoNotConnected = function (game, repo, url) {
-  return blocks(`${repo} isn't ${game}'s repository on ${TITLE}.`, [
-    `Connect it in ${TITLE} Studio, on the game's Repository tab (again if it was renamed on GitHub):`,
-    url,
-  ]);
+  return blocks(
+    `${repo} isn't ${game}'s repository on ${TITLE}.`,
+    [`Connect it on the game's Repository tab in ${TITLE} Studio:`, url],
+    "If it was renamed on GitHub, connect it again.",
+  );
 };
 
 // [function]
@@ -411,10 +448,10 @@ const gameNotFound = function (idOrHandle) {
 // [function]
 
 const gameUnavailable = function (id) {
-  return blocks(`Game unavailable: ${id}`, [
-    "It was deleted, or belongs to another account.",
+  return blocks(
+    `Game unavailable: ${id}\nIt was deleted, or belongs to another account.`,
     "Give game.id a new UUID to deploy it as a new game.",
-  ]);
+  );
 };
 
 // [function]
@@ -430,7 +467,7 @@ const gitUncommitted = function () {
 
 const gitRemoteMissing = function () {
   return blocks(
-    "No Git remote 'origin'.",
+    "No Git remote origin.",
     "Add the game's GitHub repository as origin.",
   );
 };
@@ -439,8 +476,8 @@ const gitRemoteMissing = function () {
 
 const gitRemoteUnreachable = function () {
   return blocks(
-    "Unable to reach Git remote 'origin'.",
-    "Check your connection, and that you can access it.",
+    "Unable to reach Git remote origin.",
+    "Check your internet connection, and that you can access it.",
   );
 };
 
@@ -450,8 +487,14 @@ 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 ${TOOL} there, or pass \`-C ${found}\`.`
-      : `Run ${TOOL} in the project's directory, or pass \`-C\`, or start a project with ${cmdInit()}.`,
+      ? [
+          `Found a project in ${found}.`,
+          `Run \`${TOOL}\` there, or pass \`-C ${found}\`.`,
+        ]
+      : [
+          `Run \`${TOOL}\` in a project's directory, or pass \`-C <dir>\`.`,
+          `To start a project, run ${cmdInit()}.`,
+        ],
   );
 };
 
@@ -459,7 +502,7 @@ const manifestMissing = function (file, dir, found) {
 
 const projectNotRepoRoot = function (prefix) {
   return blocks(
-    `${cmdDeployGit()} releases the project at the repository's root, and this one is in ${prefix}.`,
+    `Project is in ${prefix}, not the repository's root.\n${cmdDeployGit()} releases only a project at the root.`,
     `Deploy it with ${cmdDeploy()}, or give it a repository of its own.`,
   );
 };
@@ -475,19 +518,28 @@ const gitRepoMissing = function () {
 
 // [function]
 
-const gitTagCreateFailed = function (version) {
-  return blocks(`Unable to create Git tag for v${version}.`, [
-    "Check that the repository has a commit.",
-    "Check that your Git name and email are set.",
-  ]);
+// with the end of what git printed, such as a lock file it found.
+const gitTagCreateFailed = function (version, stderr) {
+  const output = tail(stderr);
+  return blocks(
+    `Unable to create Git tag for v${version}.`,
+    ...(output ? [output] : []),
+    [
+      "Check that the repository has a commit.",
+      "Check that your Git name and email are set.",
+    ],
+  );
 };
 
 // [function]
 
-const gitTagPushFailed = function (version) {
+// with the end of what git printed, such as a hook's refusal.
+const gitTagPushFailed = function (version, stderr) {
+  const output = tail(stderr);
   return blocks(
     `Unable to push Git tag for v${version}.`,
-    "Check that you can push to 'origin'.",
+    ...(output ? [output] : []),
+    "Check that you can push to origin.",
   );
 };
 
@@ -564,7 +616,7 @@ const imageWidthMin = function (width) {
 // [function]
 
 const timeoutInvalid = function () {
-  return "The timeout must be a number of seconds above 0.";
+  return "`--timeout` must be a number of seconds above 0.";
 };
 
 // [function]
@@ -573,8 +625,8 @@ const timeoutInvalid = function () {
 // parsed the project again.
 const issuesAfterBuild = function (count) {
   return blocks(
-    `${count} ${count === 1 ? "issue" : "issues"} found after the build.`,
-    `The build writes files the manifest reads. Run ${cmdValidate()} for details.`,
+    `${count} ${count === 1 ? "issue" : "issues"} found after the build.\nThe build writes files the manifest reads.`,
+    `Run ${cmdValidate()} for details.`,
   );
 };
 
@@ -590,13 +642,13 @@ const issuesFound = function (count) {
 // [function]
 
 const loginCodeExpired = function () {
-  return "Login code expired.";
+  return blocks("Login code expired.", `Run ${cmdLogin()} again.`);
 };
 
 // [function]
 
 const loginFailed = function () {
-  return "Login request failed.";
+  return blocks("Login request failed.", `Run ${cmdLogin()} again.`);
 };
 
 // [function]
@@ -611,10 +663,10 @@ const gameIdMissing = function () {
 // [function]
 
 const lockfileMissing = function () {
-  return blocks("No lockfile found.", [
-    "Install your dependencies to create one.",
-    "Then commit it.",
-  ]);
+  return blocks(
+    "No lockfile found.",
+    "Install your dependencies to create one, and commit it.",
+  );
 };
 
 // [function]
@@ -676,10 +728,14 @@ const packageFileTooLarge = function (file, size) {
 
 // [function]
 
-const packagePathReserved = function (folder) {
+// `name` is a folder when it ends with "/": the reserved folder, which a
+// build may load from, or the media folder. A file is the manifest.
+const packagePathReserved = function (name) {
   return blocks(
-    `'${folder}/' is reserved for ${TITLE}.`,
-    "Rename the folder, and the paths that load from it.",
+    `'${name}' is reserved for ${TITLE}.`,
+    name.toLowerCase() === `${HANDLE}/`
+      ? "Rename the folder, and the paths that load from it."
+      : `${TITLE} adds its own, so leave it out of the folder you pack.`,
   );
 };
 
@@ -688,7 +744,7 @@ const packagePathReserved = function (folder) {
 const packageTooLarge = function (size) {
   return blocks(
     `Package is larger than ${size} MB.`,
-    "Store assets don't count toward it.",
+    ".arcadible/ doesn't count toward it.",
   );
 };
 
@@ -712,7 +768,7 @@ const packageUncompressedTooLarge = function (size) {
 // open it.
 const releaseFailed = function ({ message }, studio) {
   return blocks(
-    (message ?? "").split(/(?<=\.)\s+/u).join("\n"),
+    (message ?? "No reason given.").split(/(?<=\.)\s+/u).join("\n"),
     ...(studio ? [[`${TITLE} Studio:`, studio]] : []),
   );
 };
@@ -742,10 +798,10 @@ const releaseTimedOut = function (
     ]);
   }
   if (found) {
-    return blocks(
-      head,
-      `It may still finish. The ${TITLE} check on the tagged commit says how it went.`,
-    );
+    return blocks(head, [
+      "It may still finish.",
+      `The ${TITLE} check on the tagged commit says how it went.`,
+    ]);
   }
   return blocks(
     head,
@@ -753,7 +809,7 @@ const releaseTimedOut = function (
       "GitHub Actions hasn't released it yet, or its workflow failed:",
       actions ?? "See the repository's Actions tab.",
     ],
-    `If the workflow passed, the ${TITLE} check on the tagged commit says why.`,
+    `If the workflow passed, see the ${TITLE} check on the tagged commit.`,
   );
 };
 
@@ -762,7 +818,7 @@ const releaseTimedOut = function (
 // the spinner while `--wait` waits: on GitHub Actions until the release
 // exists, then on Arcadible.
 const releaseWaiting = function (building) {
-  return building ? "Waiting for GitHub Actions... %s" : "Publishing... %s";
+  return building ? "Waiting for GitHub Actions… %s" : "Publishing… %s";
 };
 
 // [function]
@@ -833,10 +889,13 @@ const tagPushed = function (tag) {
 
 // [function]
 
-const templateUnavailable = function (template) {
+// `starter` is the starter its name suggests.
+const templateUnavailable = function (template, starter) {
   return blocks(
     `Unable to download template ${template}.`,
-    "Check that it's a public GitHub repository, or a folder in one.",
+    starter
+      ? `Did you mean: ${starter}?`
+      : "Check that it's a public GitHub repository, or a folder in one.",
   );
 };
 
@@ -887,9 +946,9 @@ const uploadFailed = function (status) {
 
 // [function]
 
-const uploadRateLimited = function (version) {
+const deployRateLimited = function (version) {
   return blocks(
-    `v${version} was uploaded in the last 5 minutes.`,
+    `v${version} was deployed in the last 5 minutes.`,
     "Wait, then deploy again.",
   );
 };
@@ -1022,6 +1081,7 @@ module.exports = {
   cmdInit,
   cmdInspect,
   deployDirMissing,
+  deployRateLimited,
   didYouMean,
   docAttrInvalid,
   docAttrUnallowed,
@@ -1083,6 +1143,7 @@ module.exports = {
   packageTooManyFiles,
   packageUncompressedTooLarge,
   packed,
+  playLabel,
   portInUse,
   portInvalid,
   pressEnterToOpen,
@@ -1110,6 +1171,7 @@ module.exports = {
   starterPhaser,
   starterPixiJs,
   starterThreeJs,
+  storeLabel,
   tagPushed,
   templateMissing,
   templateUnavailable,
@@ -1121,7 +1183,6 @@ module.exports = {
   unknownField,
   unknownTable,
   uploadFailed,
-  uploadRateLimited,
   urlInvalid,
   urlNotFrameable,
   urlUnreachable,