arcadible 0.1.44 → 0.1.46

package/src/config/file.js

@@ -0,0 +1,23 @@
+"use strict";
+
+// [import]
+
+const cfgproduct = require("./product");
+
+// [declare]
+
+const HANDLE = cfgproduct.handle;
+const MEDIA = `.${HANDLE}`;
+
+// [export]
+
+// the project's files Arcadible reads, relative to its root, and the
+// manifest arc pack writes into the zip.
+module.exports = {
+  GALLERY: `${MEDIA}/gallery`,
+  MANIFEST: `${HANDLE}.toml`,
+  MEDIA,
+  PACKAGED: `${HANDLE}.json`,
+  // the release workflow, which builds a `git` release on GitHub Actions.
+  WORKFLOW: `.github/workflows/${HANDLE}-release.yml`,
+};

package/src/config/limit.js

@@ -0,0 +1,21 @@
+"use strict";
+
+// [declare]
+
+const MB = 1024 * 1024;
+
+// [export]
+
+// the limits on a packed game, as Arcadible enforces them when it publishes
+// a release (docs: limits.md). arc pack checks them so a build that would
+// fail there fails before it's uploaded.
+module.exports = {
+  // the most files in the zip.
+  FILES: 10000,
+  // the largest file, uncompressed.
+  FILE_SIZE: 64 * MB,
+  // everything packed, uncompressed.
+  TOTAL_SIZE: 256 * MB,
+  // the zip of deploy_dir alone, compressed.
+  ZIP_SIZE: 64 * MB,
+};

package/src/parser/env.js

@@ -58,10 +58,8 @@ const parseJson = function (buf) {
 // (node_modules/.bin), and its prebuild and postbuild run, as they do
 // locally. npm runs the scripts of a pnpm or Yarn project too.
 const extract = function (conf) {
-  /* eslint-disable camelcase */
   const game = { version: conf.version };
   const workflow = conf.scripts?.build ? { build: NPM_RUN_BUILD } : {};
-  /* eslint-enable camelcase */
   return deepCompact({ game, workflow }) ?? {};
 };
 

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/parser/self.js

@@ -0,0 +1,27 @@
+"use strict";
+
+// [import]
+
+const cfgcode = require("../config/code");
+const project = require("./project");
+
+// [function]
+
+// the game of the project at `root`, for `arc play` and `arc open` with no
+// game named; null outside a project, so they ask for a game
+// (game_id_missing) rather than for a project.
+const main = function (root) {
+  return project(root).then(
+    ({ game }) => game,
+    (ex) => {
+      if (ex.code === cfgcode.MANIFEST_MISSING) {
+        return null;
+      }
+      throw ex;
+    },
+  );
+};
+
+// [export]
+
+module.exports = main;