arcadible 1.0.13 → 1.0.14

package/bin/arc-deploy.js

@@ -334,7 +334,14 @@ const start = function (argv) {
         // whoami
         current,
         // pack
-        git ? null : pack({ input: artifact?.path, project: parsed, root }),
+        git
+          ? null
+          : pack({
+              input: artifact?.path,
+              onWarning: handler({ json, pb, quiet, sw, warnings }).onWarning,
+              project: parsed,
+              root,
+            }),
         // build: whether workflow.build ran
         Boolean(artifact),
       ]);

package/bin/arc-pack.js

@@ -31,6 +31,7 @@ const print = output.print;
 const resolve = path.resolve;
 const SpinnerWheel = spinner.SpinnerWheel;
 const warn = output.warn;
+const warning = output.warning;
 
 // [declare]
 
@@ -56,8 +57,9 @@ const start = function (argv) {
   const root = resolve(process.cwd(), argv.cwd);
   // the project, parsed once for both steps.
   let parsed = null;
-  // what --json lists under `warnings`.
+  // what --json lists under `warnings`: arc validate's, then the package's.
   let warnings = [];
+  const packed = [];
   let sw = new SpinnerWheel("Validating… %s");
   sw.start(json || quiet);
   return checked(root, (found) => {
@@ -71,12 +73,21 @@ const start = function (argv) {
       sw.start(json || quiet);
       return pack({
         input: argv.input,
+        // the package's own, printed once it's packed.
+        onWarning({ code, message }) {
+          packed.push(warning(code, message));
+        },
         output: argv.output,
         project: parsed,
         root,
       });
     })
     .then((artifact) => {
+      warnings = [...warnings, ...packed];
+      if (!json && !quiet && packed.length) {
+        sw.stop(true);
+        packed.forEach((each) => log.pw(each.message));
+      }
       if (json) {
         print({ artifact, warnings });
         return;

package/package.json

@@ -65,5 +65,5 @@
   "scripts": {
     "test": "node --test \"test/**/*.test.js\""
   },
-  "version": "1.0.13"
+  "version": "1.0.14"
 }

package/src/action/pack/tool.js

@@ -19,6 +19,7 @@ const given = require("../../parser/given");
 const limits = require("./limits");
 const phrase = require("../../phrase");
 const size = require("../../util/size");
+const unsound = require("./unsound");
 const Zip = require("../../util/zip");
 
 // [use]
@@ -106,7 +107,7 @@ const verifyTotal = function (zip) {
 const pack = function (
   name,
   game,
-  { deployDir, inputPath, mediaPath, outputPath },
+  { deployDir, inputPath, mediaPath, onWarning, outputPath },
 ) {
   const zip = new Zip(name);
   return pathExists(inputPath)
@@ -136,6 +137,9 @@ const pack = function (
     })
     .then(verifyTotal)
     .then((file) => {
+      if (onWarning) {
+        unsound(file.entries()).forEach(onWarning);
+      }
       file.write(outputPath);
       return { path: outputPath, ...file.stat() };
     });
@@ -143,7 +147,9 @@ const pack = function (
 
 // [function]
 
-const main = function ({ input, output, ...conf }) {
+// `onWarning` gets each of the package's warnings, such as a `.env` file
+// in it, as a command's own.
+const main = function ({ input, onWarning, output, ...conf }) {
   const root = conf.root;
   return given(conf).then(({ game, workflow }) => {
     const name = game.handle ?? game.id;
@@ -154,6 +160,7 @@ const main = function ({ input, output, ...conf }) {
       deployDir: inputPath === deployDir,
       inputPath,
       mediaPath: resolve(root, MEDIA),
+      onWarning,
       outputPath: resolve(root, file),
     });
   });

package/src/action/pack/unsound.js

@@ -0,0 +1,69 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const cfgcode = require("../../config/code");
+const phrase = require("../../phrase");
+
+// [use]
+
+const posixBasename = path.posix.basename;
+const WARNING = cfgcode.WARNING;
+
+// [declare]
+
+// the files any player could download that are almost never meant to be
+// public, kept short on purpose, to grow later (OUTPUT.md, Codes): a `.env`
+// file other than an example of one, and a git repository.
+const ENV = /^\.env(?:\..+)?$/u;
+const ENV_EXAMPLE = /\.(?:example|sample|template)$/u;
+const GIT = ".git";
+// the folder of a project's installed packages, at the package's root.
+const MODULES = "node_modules/";
+
+// [function]
+
+// the private files among the package's, each once: a `.env` file by its
+// path, and a git repository by its folder.
+const privates = function (names) {
+  const found = names.flatMap((name) => {
+    const parts = name.split("/");
+    const git = parts.slice(0, -1).indexOf(GIT);
+    if (git !== -1) {
+      return [`${parts.slice(0, git + 1).join("/")}/`];
+    }
+    const base = posixBasename(name);
+    return ENV.test(base) && !ENV_EXAMPLE.test(base) ? [name] : [];
+  });
+  return [...new Set(found)].sort();
+};
+
+// [function]
+
+// the packed files' warnings, as a command's own (`onWarning`): what the
+// package holds, never a guess at how it's served (OUTPUT.md, Codes).
+const main = function (entries) {
+  const names = entries.map((entry) => entry.name);
+  return [
+    ...(names.some((name) => name.startsWith(MODULES))
+      ? [
+          {
+            code: WARNING.PACKAGE_FILE_DEV,
+            message: phrase.packageFileDev(MODULES),
+          },
+        ]
+      : []),
+    ...privates(names).map((file) => ({
+      code: WARNING.PACKAGE_FILE_PRIVATE,
+      message: phrase.packageFilePrivate(file),
+    })),
+  ];
+};
+
+// [export]
+
+module.exports = main;

package/src/action/validate/tool.js

@@ -9,6 +9,7 @@ const readmeFile = require("../../parser/readme-file");
 const schema = require("../../util/schema");
 const sections = require("../../parser/sections");
 const unknown = require("./unknown");
+const unsound = require("./unsound");
 const workflow = require("../../schema/workflow");
 
 // [use]
@@ -56,7 +57,7 @@ const main = function (conf) {
   return Promise.all([given(conf), structure(root), unknown(root)]).then(
     ([proj, readmeStructure, warnings]) => ({
       issues: validate(proj, readmeStructure, { root }),
-      warnings: warnings.sort(schema.compare),
+      warnings: [...warnings, ...unsound(proj)].sort(schema.compare),
     }),
   );
 };

package/src/action/validate/unsound.js

@@ -0,0 +1,166 @@
+"use strict";
+
+// [import]
+
+const path = require("node:path");
+
+// [import]
+
+const semver = require("semver");
+
+// [import]
+
+const cfgart = require("../../config/art");
+const cfgcode = require("../../config/code");
+const cfgfile = require("../../config/file");
+const output = require("../../util/output");
+const phrase = require("../../phrase");
+
+// [use]
+
+const extname = path.extname;
+const parse = path.parse;
+const posixBasename = path.posix.basename;
+const prerelease = semver.prerelease;
+const validSemver = semver.valid;
+const WARNING = cfgcode.WARNING;
+
+// [declare]
+
+const MEDIA = cfgfile.MEDIA;
+
+// [declare]
+
+// the art fields, such as `icon`, each of which may have a `_video`.
+const ART = cfgart
+  .map((file) => parse(file).name)
+  .filter((name) => !name.endsWith("_video"));
+// a screenshot's name, as the store reads it (ui2's `screenshots()`).
+const SCREENSHOT = /^screenshot_(\d+)(?:_([^.]+))?\.[^.]+$/u;
+// a name one case or separator away from a screenshot's: `Screenshot_01`,
+// `screenshot-01`, `screenshot01`, with any qualifier after it.
+const SCREENSHOT_NEAR = /^screenshot[-_ ]?(\d+)(?:[-_ ](.+))?$/iu;
+
+// [function]
+
+// a warning about a field, in an issue's shape, with its details.
+const warning = function (code, field, [message, ...details]) {
+  return { ...output.warning(code, message, field), details };
+};
+
+// [function]
+
+// the fields a release leaves out whose defaults it may not mean: a release
+// version's `visibility` and `title`, and a public one's `inputs`. A
+// prerelease changes no store page, so it's never warned about.
+const unset = function (game) {
+  const version = game.version;
+  if (!validSemver(version) || prerelease(version)) {
+    return [];
+  }
+  const fields = [
+    "visibility",
+    "title",
+    ...(game.visibility === "public" ? ["inputs"] : []),
+  ];
+  return fields
+    .filter((field) => typeof game[field] === "undefined")
+    .map((field) =>
+      warning(WARNING.FIELD_UNSET, `game.${field}`, phrase.fieldUnset(field)),
+    );
+};
+
+// [function]
+
+// each art video without its PNG, such as `icon_video` without `icon`.
+const unpaired = function (game) {
+  return ART.filter((art) => game[`${art}_video`] && !game[art]).map((art) =>
+    warning(
+      WARNING.ART_VIDEO_UNPAIRED,
+      `game.${art}_video`,
+      phrase.artVideoUnpaired(art, `${MEDIA}/${art}.png`),
+    ),
+  );
+};
+
+// [function]
+
+// the gallery's file names, or none when it isn't a list of paths, which
+// its issues report.
+const galleryNames = function (game) {
+  const gallery = game.gallery;
+  if (!Array.isArray(gallery)) {
+    return [];
+  }
+  return gallery
+    .filter((file) => typeof file === "string")
+    .map((file) => posixBasename(file));
+};
+
+// [function]
+
+// screenshots with one number and qualifier, such as `screenshot_1.png` and
+// `screenshot_01.png`, which the store can show only one of.
+const repeated = function (names) {
+  const groups = {};
+  for (const name of names) {
+    const match = SCREENSHOT.exec(name);
+    if (match) {
+      const key = `${Number(match[1])}_${match[2] ?? ""}`;
+      groups[key] = [...(groups[key] ?? []), name];
+    }
+  }
+  return Object.values(groups)
+    .filter((group) => group.length > 1)
+    .map((group) =>
+      warning(
+        WARNING.SCREENSHOT_NUMBER_REPEATED,
+        "game.gallery",
+        phrase.screenshotNumberRepeated(group),
+      ),
+    );
+};
+
+// [function]
+
+// a gallery file named almost as a screenshot, with the name it might mean.
+const misnamed = function (names) {
+  return names.flatMap((name) => {
+    if (SCREENSHOT.test(name)) {
+      return [];
+    }
+    const ext = extname(name);
+    const match = SCREENSHOT_NEAR.exec(parse(name).name);
+    if (!match) {
+      return [];
+    }
+    const qualifier = match[2] ? `_${match[2]}` : "";
+    const near = `screenshot_${match[1]}${qualifier}${ext}`;
+    return [
+      warning(WARNING.SCREENSHOT_NAME_INVALID, "game.gallery", [
+        phrase.screenshotNameInvalid(name),
+        phrase.didYouMean(near),
+      ]),
+    ];
+  });
+};
+
+// [function]
+
+// what the resolved manifest has that's sound by its rules but almost never
+// meant, as warnings: facts about the project, never a guess at how the
+// store will show it (OUTPUT.md, Codes).
+const main = function (proj) {
+  const game = proj?.game ?? {};
+  const names = galleryNames(game);
+  return [
+    ...unset(game),
+    ...unpaired(game),
+    ...repeated(names),
+    ...misnamed(names),
+  ];
+};
+
+// [export]
+
+module.exports = main;

package/src/config/code.js

@@ -103,10 +103,16 @@ const ISSUE = {
 // they follow the same rules, and share the Errors page, so no warning code
 // is also an error or issue code.
 const WARNING = {
+  ART_VIDEO_UNPAIRED: "art_video_unpaired",
   DEPLOY_DIR_NOT_BUILT: "deploy_dir_not_built",
   FIELD_UNKNOWN: "field_unknown",
+  FIELD_UNSET: "field_unset",
   GAME_HANDLE_LAPSED: "game_handle_lapsed",
   GAME_HANDLE_LIMIT_REACHED: "game_handle_limit_reached",
+  PACKAGE_FILE_DEV: "package_file_dev",
+  PACKAGE_FILE_PRIVATE: "package_file_private",
+  SCREENSHOT_NAME_INVALID: "screenshot_name_invalid",
+  SCREENSHOT_NUMBER_REPEATED: "screenshot_number_repeated",
   VERSION_UNCHECKED: "version_unchecked",
 };
 // every error code, for checking one exists.

package/src/phrase.js

@@ -13,6 +13,15 @@ const TAIL_LINES = 20;
 
 // [function]
 
+const artVideoUnpaired = function (art, png) {
+  return [
+    `Has no ${art} beside it.`,
+    `Add ${png} too, for places that don't show video.`,
+  ];
+};
+
+// [function]
+
 // a message's reason, then each block of details after a blank line
 // (OUTPUT.md). A block of several lines is an array.
 const blocks = function (reason, ...details) {
@@ -23,6 +32,54 @@ const blocks = function (reason, ...details) {
 
 // [function]
 
+// a release's field left out, keyed by field: what leaving it out means,
+// then what to set.
+const fieldUnset = function (field) {
+  return {
+    inputs: [
+      "Not set, so this release lists no inputs.",
+      "Set inputs to how the game is played.",
+    ],
+    title: [
+      "Not set, so this release has no title.",
+      "Start the README with a # title, or set title.",
+    ],
+    visibility: [
+      "Not set, so this release is unlisted: it plays by link only.",
+      'Set visibility = "public" to list it, or "unlisted" to keep it so.',
+    ],
+  }[field];
+};
+
+// [function]
+
+const packageFileDev = function (dir) {
+  return `Packing ${dir}, a project's installed packages.\nSet deploy_dir to the folder your build writes.`;
+};
+
+// [function]
+
+const packageFilePrivate = function (file) {
+  return `Packing ${file}, which anyone can download.\nLeave it out of the package unless it's meant to be public.`;
+};
+
+// [function]
+
+const screenshotNameInvalid = function (name) {
+  return `Not a screenshot's name: ${name}.`;
+};
+
+// [function]
+
+const screenshotNumberRepeated = function (names) {
+  return [
+    `Screenshots share a number: ${names.join(", ")}.`,
+    "Give each screenshot its own number.",
+  ];
+};
+
+// [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 "…".
@@ -1077,6 +1134,7 @@ const videoWidthMin = function (width) {
 
 module.exports = {
   aborted,
+  artVideoUnpaired,
   buildFailed,
   buildOutputMissing,
   buildPublishing,
@@ -1097,6 +1155,7 @@ module.exports = {
   docMediaType,
   docTagUnallowed,
   errorCode,
+  fieldUnset,
   gameHandleChanged,
   gameHandleLapsed,
   gameHandleLimit,
@@ -1142,6 +1201,8 @@ module.exports = {
   nothingToDo,
   openToContinue,
   opened,
+  packageFileDev,
+  packageFilePrivate,
   packageFileTooLarge,
   packageIndexMissing,
   packagePathReserved,
@@ -1163,6 +1224,8 @@ module.exports = {
   remoteKept,
   remoteUnreachable,
   repoNotConnected,
+  screenshotNameInvalid,
+  screenshotNumberRepeated,
   serveAlone,
   serveNext,
   serveNextUrl,