arcadible 0.1.42 → 0.1.43

package/README.md

@@ -35,7 +35,7 @@ arc init star-drift && cd star-drift
 arc deploy
 ```
 
-Your repository is the store page: `arcadible.toml` holds the game's settings, `README.md` its title and description, and `.arcadible/` its art. `arc deploy` validates, builds, packages, and publishes it, then waits until the release is live.
+Your repository is the store page: `arcadible.toml` holds the game's settings, `README.md` its title and description, and `.arcadible/` its art. `arc deploy` validates, builds, packages, and publishes it, then waits until the release is live. A new project starts at a prerelease version, `0.1.0-beta.1`, so its first deploy goes to staging: a link to play and share, before players see it.
 
 ## Commands
 

package/bin/arc-build.js

@@ -35,6 +35,7 @@ const print = output.print;
 const relative = path.relative;
 const resolve = path.resolve;
 const SpinnerWheel = spinner.SpinnerWheel;
+const warn = output.warn;
 
 // [declare]
 
@@ -65,7 +66,7 @@ const start = function (argv) {
       parsed = proj;
       return validate({ project: parsed, root });
     })
-    .then((issues) => {
+    .then(({ issues, warnings }) => {
       const count = issues.length;
       if (count) {
         throw new ArcError(
@@ -75,6 +76,7 @@ const start = function (argv) {
         );
       }
       sw.stop(true);
+      warn(warnings, { json, quiet });
       sw = new SpinnerWheel("Building... %s");
       sw.start(json || quiet);
       return build({ project: parsed, root });

package/bin/arc-deploy.js

@@ -41,6 +41,7 @@ const print = output.print;
 const ProgressBar = progress.ProgressBar;
 const resolve = path.resolve;
 const SpinnerWheel = spinner.SpinnerWheel;
+const warn = output.warn;
 
 // [declare]
 
@@ -260,7 +261,7 @@ const start = function (argv) {
       parsed = proj;
       return validate({ project: parsed, root });
     })
-    .then((issues) => {
+    .then(({ issues, warnings }) => {
       const count = issues.length;
       if (count) {
         throw new ArcError(
@@ -270,6 +271,7 @@ const start = function (argv) {
         );
       }
       sw.stop(true);
+      warn(warnings, { json, quiet });
       sw = new SpinnerWheel("Checking... %s");
       // git deploys need no login: anyone who can push to the repository can
       // release, and the Arcadible GitHub App publishes the release. Anyone
@@ -314,7 +316,23 @@ const start = function (argv) {
     .then(([current, artifact]) =>
       Promise.all([current, artifact, artifact ? project(root) : parsed]),
     )
-    .then(([current, artifact, proj]) => {
+    .then(([current, artifact, proj]) =>
+      Promise.all([
+        current,
+        artifact,
+        proj,
+        proj === parsed ? null : validate({ project: proj, root }),
+      ]),
+    )
+    .then(([current, artifact, proj, validated]) => {
+      const count = validated?.issues.length ?? 0;
+      if (count) {
+        throw new ArcError(
+          cfgcode.VALIDATION_FAILED,
+          phrase.issuesAfterBuild(count),
+          { data: { issues: validated.issues } },
+        );
+      }
       parsed = proj;
       sw.stop(true);
       sw = new SpinnerWheel("Packing... %s");

package/bin/arc-pack.js

@@ -34,6 +34,7 @@ const findRc = rc.findRc;
 const print = output.print;
 const resolve = path.resolve;
 const SpinnerWheel = spinner.SpinnerWheel;
+const warn = output.warn;
 
 // [declare]
 
@@ -66,7 +67,7 @@ const start = function (argv) {
       parsed = proj;
       return validate({ project: parsed, root });
     })
-    .then((issues) => {
+    .then(({ issues, warnings }) => {
       const count = issues.length;
       if (count) {
         throw new ArcError(
@@ -76,6 +77,7 @@ const start = function (argv) {
         );
       }
       sw.stop(true);
+      warn(warnings, { json, quiet });
       sw = new SpinnerWheel("Packing... %s");
       sw.start(json || quiet);
       return pack({

package/bin/arc-validate.js

@@ -28,6 +28,7 @@ const dereference = schema.dereference;
 const findRc = rc.findRc;
 const print = output.print;
 const resolve = path.resolve;
+const schemaPrint = schema.print;
 
 // [declare]
 
@@ -48,24 +49,30 @@ const conf = {
 const start = function (argv) {
   const json = argv.json;
   return validate({ root: resolve(process.cwd(), argv.cwd) })
-    .then((issues) => {
+    .then(({ issues, warnings }) => {
       const count = issues.length;
       if (json) {
-        print({ issues });
-      } else if (count) {
+        print({ issues, warnings });
+      } else {
         const [probs, refs] = dereference(issues);
         const probcount = probs.length;
         if (probcount) {
           log.hdo(`${probcount} ${probcount === 1 ? "issue" : "issues"}:`);
           log.p(probs.map((prob) => `✗ ${prob}`));
         }
+        const warncount = argv.quiet ? 0 : warnings.length;
+        if (warncount) {
+          log.hwo(`${warncount} ${warncount === 1 ? "warning" : "warnings"}:`);
+          log.p(warnings.map((each) => `⚠ ${schemaPrint(each)}`));
+        }
         const refcount = refs.length;
         if (refcount) {
           log.h(`${refcount} ${refcount === 1 ? "reference" : "references"}:`);
           log.p(refs);
         }
-      } else if (!argv.quiet) {
-        log.hs("No issues found.");
+        if (!count && !argv.quiet) {
+          log.hs("No issues found.");
+        }
       }
       process.exit(count ? 1 : 0);
     })

package/package.json

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

package/src/action/validate/tool.js

@@ -8,6 +8,7 @@ const readme = require("../../schema/readme");
 const readmeFile = require("../../parser/readme-file");
 const schema = require("../../util/schema");
 const sections = require("../../parser/sections");
+const unknown = require("./unknown");
 const workflow = require("../../schema/workflow");
 
 // [use]
@@ -49,10 +50,14 @@ const validate = function (proj, readmeStructure, { root }) {
 
 // [function]
 
+// the project's issues, which fail it, and its warnings, which don't.
 const main = function (conf) {
   const root = conf.root;
-  return Promise.all([given(conf), structure(root)]).then(
-    ([proj, readmeStructure]) => validate(proj, readmeStructure, { root }),
+  return Promise.all([given(conf), structure(root), unknown(root)]).then(
+    ([proj, readmeStructure, warnings]) => ({
+      issues: validate(proj, readmeStructure, { root }),
+      warnings: warnings.sort(schema.compare),
+    }),
   );
 };
 

package/src/action/validate/unknown.js

@@ -0,0 +1,85 @@
+"use strict";
+
+// [import]
+
+const cfgcode = require("../../config/code");
+const game = require("../../schema/game");
+const manifest = require("../../parser/manifest");
+const strs = require("../../util/strs");
+const workflow = require("../../schema/workflow");
+
+// [use]
+
+const closest = strs.closest;
+const ISSUE = cfgcode.ISSUE;
+
+// [function]
+
+// the fields each table takes, from its schema.
+const known = function (root) {
+  return {
+    game: Object.keys(game({}, { root }).shape),
+    workflow: Object.keys(workflow({}, { root }).shape),
+  };
+};
+
+// [function]
+
+// a warning, in an issue's shape: Arcadible ignores what it doesn't know, so
+// it's reported without failing, with the name it might have meant.
+const warning = function (path, message, near) {
+  return {
+    code: ISSUE.FIELD_UNKNOWN,
+    details: near ? [`Did you mean: ${near}?`] : [],
+    link: null,
+    message,
+    path,
+  };
+};
+
+// [function]
+
+// a value outside any table, such as a `handle` above `[game]`: the field
+// it is, in the table that takes it, if any.
+const untabled = function (fields, name) {
+  const table = Object.keys(fields).find((each) => fields[each].includes(name));
+  return warning(name, "Unknown field.", table ? `${table}.${name}` : null);
+};
+
+// [function]
+
+const isTable = function (value) {
+  return value !== null && typeof value === "object" && !Array.isArray(value);
+};
+
+// [function]
+
+// the tables and fields in arcadible.toml that Arcadible doesn't know, such
+// as a misspelled `genre`, as warnings.
+const main = function (root) {
+  const fields = known(root);
+  const tables = Object.keys(fields);
+  return manifest(root).then((conf) =>
+    Object.entries(conf).flatMap(([table, values]) => {
+      if (!isTable(values)) {
+        return Object.hasOwn(fields, table) ? [] : [untabled(fields, table)];
+      }
+      if (!Object.hasOwn(fields, table)) {
+        return [warning(table, "Unknown table.", closest(table, tables))];
+      }
+      return Object.keys(values)
+        .filter((field) => !fields[table].includes(field))
+        .map((field) =>
+          warning(
+            `${table}.${field}`,
+            "Unknown field.",
+            closest(field, fields[table]),
+          ),
+        );
+    }),
+  );
+};
+
+// [export]
+
+module.exports = main;

package/src/config/code.js

@@ -76,6 +76,7 @@ const ISSUE = {
   DESCRIPTION_RULES_MISSING: "description_rules_missing",
   DUPLICATE: "duplicate",
   EMPTY: "empty",
+  FIELD_UNKNOWN: "field_unknown",
   INDEX_MISSING: "index_missing",
   INVALID: "invalid",
   MARKDOWN_INVALID: "markdown_invalid",

package/src/phrase.js

@@ -216,7 +216,7 @@ const gitRemoteMissing = function () {
 
 const noManifest = function (file, dir, found) {
   return blocks(
-    dir === "." ? `No ${file} in this directory.` : `No ${file} in ${dir}`,
+    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`.",
@@ -337,6 +337,17 @@ const timeoutInvalid = function () {
 
 // [function]
 
+// issues in what the build wrote, such as its art, once arc deploy has
+// 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.`,
+  );
+};
+
+// [function]
+
 const issuesFound = function (count) {
   return blocks(
     `${count} ${count === 1 ? "issue" : "issues"} found.`,
@@ -786,6 +797,7 @@ module.exports = {
   imageUnsupported,
   imageWidthMax,
   imageWidthMin,
+  issuesAfterBuild,
   issuesFound,
   loginExpired,
   loginFailed,

package/src/schema/game.js

@@ -177,7 +177,7 @@ const zSetBasefile = function (field, schema, { max, min }) {
 const zString = function (field, char, { max, min }) {
   return z
     .string()
-    .min(min, atLeast(field, min, "character"))
+    .min(min, { ...atLeast(field, min, "character"), abort: min === 1 })
     .max(max, message(field, [`Must not exceed: ${max} characters`]))
     .superRefine((str, ctx) => {
       const invalid = invalidChars(str, char);
@@ -430,15 +430,29 @@ const zGenres = function () {
 
 // [function]
 
+// each of a handle's rules on its own, so a handle lists every one it breaks:
+// its length, its characters, and its hyphens. The database's
+// check (db/check/game.sql) is the same rules in one regex.
 const zHandle = function () {
   const field = "handle";
   return z.optional(
-    z
-      .string()
-      .min(1, { ...atLeast(field, 1), abort: true })
-      .regex(
-        /^[a-z0-9](?:(?![-]{2})[a-z0-9-]){1,22}[a-z0-9]$/u,
-        message(field, ["Contains invalid characters."]),
+    zString(field, /[a-z0-9-]/u, { max: 24, min: 1 })
+      .min(3, atLeast(field, 3, "characters"))
+      .refine(
+        (str) => !str.startsWith("-") && !str.endsWith("-"),
+        message(
+          field,
+          ["Must not start or end with a hyphen."],
+          ISSUE.CHARACTERS_INVALID,
+        ),
+      )
+      .refine(
+        (str) => !str.includes("--"),
+        message(
+          field,
+          ["Must not contain consecutive hyphens."],
+          ISSUE.CHARACTERS_INVALID,
+        ),
       ),
   );
 };

package/src/util/log.js

@@ -82,6 +82,14 @@ const hdo = function (message) {
 
 // [function]
 
+// a warning heading on stdout, for when the warnings are part of the result,
+// as with arc validate's.
+const hwo = function (message) {
+  log(console.log, message, { bold: true, color: "yellow" });
+};
+
+// [function]
+
 const pw = function (message) {
   log(console.warn, message, { color: "yellow" });
 };
@@ -122,6 +130,7 @@ module.exports = {
   hd,
   hdo,
   hs,
+  hwo,
   nlhd,
   nlp,
   nlpd,

package/src/util/output.js

@@ -11,6 +11,7 @@ const error = require("./error");
 const log = require("./log");
 const objs = require("./objs");
 const phrase = require("../phrase");
+const schema = require("./schema");
 const TOML = require("./toml");
 
 // [use]
@@ -106,6 +107,18 @@ const abort = function (
   process.exit(1);
 };
 
+// [function]
+
+// arc validate's warnings, such as an unknown field, on stderr in yellow,
+// before a command that validates goes on. Left out with `--json` and
+// `--quiet`; arc validate --json lists them.
+const warn = function (warnings, { json, quiet } = {}) {
+  if (json || quiet) {
+    return;
+  }
+  warnings.forEach((each) => log.pw(`⚠ ${schema.print(each)}`));
+};
+
 // [export]
 
-module.exports = { abort, print, printJson, printToml };
+module.exports = { abort, print, printJson, printToml, warn };

package/src/util/strs.js

@@ -2,6 +2,42 @@
 
 // [function]
 
+// the number of single-character edits between two strings (Levenshtein).
+const distance = function (a, b) {
+  let row = Array.from({ length: b.length + 1 }, (_, i) => i);
+  for (let i = 1; i <= a.length; i += 1) {
+    const next = [i];
+    for (let j = 1; j <= b.length; j += 1) {
+      next[j] = Math.min(
+        row[j] + 1,
+        next[j - 1] + 1,
+        row[j - 1] + (a[i - 1] === b[j - 1] ? 0 : 1),
+      );
+    }
+    row = next;
+  }
+  return row[b.length];
+};
+
+// [function]
+
+// the candidate nearest `str`, for "Did you mean", or null when none is
+// within two edits.
+const closest = function (str, candidates) {
+  let best = null;
+  let min = 3;
+  for (const candidate of candidates) {
+    const d = distance(str, candidate);
+    if (d < min) {
+      best = candidate;
+      min = d;
+    }
+  }
+  return best;
+};
+
+// [function]
+
 const indentLines = function (strs, spaces = 2) {
   const pad = " ".repeat(spaces);
   return strs
@@ -28,4 +64,10 @@ const trimWhitespace = function (str) {
 
 // [export]
 
-module.exports = { indentLines, stripLeadingInvisible, trimWhitespace };
+module.exports = {
+  closest,
+  distance,
+  indentLines,
+  stripLeadingInvisible,
+  trimWhitespace,
+};