@indiegems/gem-web-sdk 5.9.0

package/bin/gem-sdk-stamp.mjs

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+/**
+ * gem-sdk-stamp — record which gem-web-sdk a game build carries.
+ *
+ *   gem-sdk-stamp <build-directory>
+ *
+ * Run it after your bundler, on the directory you upload:
+ *
+ *   "build": "vite build && gem-sdk-stamp dist"
+ *
+ * It writes one file, `gem-web-sdk.json`, at the root of that directory:
+ *
+ *   { "schema_version": 1, "sdk_version": "1.2.3" }
+ *
+ * WHY YOU NEED IT. A published web build has to say which SDK version it was made
+ * against, so that a game left on a version the platform no longer supports can
+ * be found and its author told. Your bundle already carries the version inside
+ * it, but only your bundler knows which of its output files that ended up in, so
+ * finding it there means reading all of them. This file is at the same path for
+ * every game, which is the whole reason it exists.
+ *
+ * THE VERSION IS NOT A VALUE YOU PASS. It is read from the copy of the package
+ * this command was installed as — the same copy your bundler compiled into the
+ * build — so the two cannot disagree, and upgrading the dependency is the only
+ * thing that changes it.
+ *
+ * SAFE TO RUN TWICE. It replaces whatever it finds, which is what makes it
+ * correct in a build directory that is reused rather than cleaned.
+ */
+
+import { readdirSync, readFileSync, statSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { argv, exit, stderr, stdout } from 'node:process';
+import { fileURLToPath } from 'node:url';
+
+/** The name a reader looks for. Fixed, because a path nobody can name is no better than a search. */
+const STAMP_FILE = 'gem-web-sdk.json';
+
+const USAGE =
+  'usage: gem-sdk-stamp <build-directory>\n' +
+  '  The directory your bundler wrote and you upload, e.g. "vite build && gem-sdk-stamp dist".';
+
+function fail(message) {
+  stderr.write(`gem-sdk-stamp: ${message}\n`);
+  exit(1);
+}
+
+function main() {
+  const target = argv[2];
+  if (target === undefined || target === '' || target.startsWith('-')) {
+    fail(`no build directory given.\n${USAGE}`);
+    return;
+  }
+
+  let stats;
+  try {
+    stats = statSync(target);
+  } catch {
+    fail(`${target} does not exist. Run this after your build, on the directory it wrote.`);
+    return;
+  }
+  if (!stats.isDirectory()) {
+    fail(`${target} is a file. This takes the build directory you upload, not a file inside it.`);
+    return;
+  }
+
+  // An empty directory is the mistake of running this BEFORE the build rather
+  // than after it. Left alone it succeeds, and the upload then carries a version
+  // for a build that was never there.
+  const contents = readdirSync(target).filter((name) => name !== STAMP_FILE);
+  if (contents.length === 0) {
+    fail(`${target} is empty — nothing has been built into it yet. Run this after your bundler.`);
+    return;
+  }
+
+  const own = join(dirname(fileURLToPath(import.meta.url)), '..', 'package.json');
+  const version = JSON.parse(readFileSync(own, 'utf8')).version;
+  if (typeof version !== 'string' || version === '') {
+    fail('the installed gem-web-sdk states no version, so there is nothing to record.');
+    return;
+  }
+
+  const stamp = {
+    $comment:
+      'Written by gem-sdk-stamp when this build was made. sdk_version is the ' +
+      '@indiegems/gem-web-sdk release the build carries. Unknown fields are ignored.',
+    schema_version: 1,
+    sdk_version: version,
+  };
+  const path = join(target, STAMP_FILE);
+  writeFileSync(path, `${JSON.stringify(stamp, null, 2)}\n`);
+  stdout.write(`gem-sdk-stamp: ${path} records gem-web-sdk ${version}\n`);
+}
+
+main();