@shop-on/theme-cli 0.1.0 → 0.2.0

package/dist/audit/command.mjs

@@ -6,7 +6,7 @@ import { BAR, formatReport } from "./report.mjs";
 import { auditRoutes, checkRoutes } from "./routes.mjs";
 import { startBuiltServer } from "./server.mjs";
 import { fetchStoreData, storeProblems } from "./store.mjs";
-import { spawn } from "node:child_process";
+import { runThemeBuild } from "../theme/build.mjs";
 import { existsSync } from "node:fs";
 import path from "node:path";
 import { parseArgs, styleText } from "node:util";
@@ -30,23 +30,7 @@ const processIo = {
 };
 const defaultDeps = {
 	fetchStoreData,
-	build: (themeDir) => new Promise((resolve, reject) => {
-		const child = spawn("pnpm", ["run", "build"], {
-			cwd: themeDir,
-			stdio: [
-				"ignore",
-				process.stderr,
-				process.stderr
-			]
-		});
-		const kill = () => child.kill();
-		process.once("exit", kill);
-		child.once("error", reject);
-		child.once("exit", (code) => {
-			process.off("exit", kill);
-			resolve(code ?? 1);
-		});
-	}),
+	build: runThemeBuild,
 	startServer: startBuiltServer,
 	openBrowser
 };

package/dist/audit/server.mjs

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 import { redact, secretValues } from "./env.mjs";
 import { createRequire } from "node:module";
-import { spawn } from "node:child_process";
 import { closeSync, cpSync, existsSync, mkdirSync, mkdtempSync, openSync, readFileSync, rmSync, writeFileSync } from "node:fs";
 import path from "node:path";
+import { spawn } from "node:child_process";
 import net from "node:net";
 import os from "node:os";
 //#region src/audit/server.ts

package/dist/index.mjs

@@ -4,6 +4,7 @@ import { runLogin } from "./login.mjs";
 import { runCredentialsRevoke } from "./theme/credentials.mjs";
 import { runDev } from "./theme/dev.mjs";
 import { runInit } from "./theme/init.mjs";
+import { runPack } from "./theme/pack.mjs";
 //#region src/index.ts
 const USAGE = `usage: shop-on <command>
 
@@ -12,6 +13,7 @@ const USAGE = `usage: shop-on <command>
   theme dev                             run this theme in the hosted theme editor
   theme credentials revoke <client-id>  revoke a dev storefront credential
   theme audit                           measure this theme against the quality bar
+  theme pack                            pack the built theme into its version tarball
 
 Each command takes --help.`;
 const [group, command, ...rest] = process.argv.slice(2);
@@ -20,6 +22,7 @@ else if (group === "theme" && command === "init") process.exitCode = await runIn
 else if (group === "theme" && command === "dev") process.exitCode = await runDev({ argv: rest });
 else if (group === "theme" && command === "credentials" && rest[0] === "revoke") process.exitCode = await runCredentialsRevoke({ argv: rest.slice(1) });
 else if (group === "theme" && command === "audit") process.exitCode = await runAudit({ argv: rest });
+else if (group === "theme" && command === "pack") process.exitCode = await runPack({ argv: rest });
 else {
 	const help = group === void 0 || group === "--help" || group === "-h";
 	(help ? console.log : console.error)(USAGE);

package/dist/theme/build.mjs

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+import { spawn } from "node:child_process";
+//#region src/theme/build.ts
+/** Runs the theme's `pnpm run build` and resolves with its exit code. Build
+* output goes to stderr, so a command's own stdout stays parseable. */
+function runThemeBuild(themeDir) {
+	return new Promise((resolve, reject) => {
+		const child = spawn("pnpm", ["run", "build"], {
+			cwd: themeDir,
+			stdio: [
+				"ignore",
+				process.stderr,
+				process.stderr
+			]
+		});
+		const kill = () => child.kill();
+		process.once("exit", kill);
+		child.once("error", reject);
+		child.once("exit", (code) => {
+			process.off("exit", kill);
+			resolve(code ?? 1);
+		});
+	});
+}
+//#endregion
+export { runThemeBuild };

package/dist/theme/dev.mjs

@@ -6,10 +6,10 @@ import { adminOrigin, discover, ensureLoggedIn, resolveApiUrl } from "../auth/oa
 import { openUrl } from "../open-url.mjs";
 import { graphql } from "../auth/api.mjs";
 import { createRequire } from "node:module";
-import { spawn } from "node:child_process";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import { parseArgs } from "node:util";
+import { spawn } from "node:child_process";
 //#region src/theme/dev.ts
 const DEV_USAGE = `usage: shop-on theme dev [--api <url>] [--env dev|staging|prod]
 

package/dist/theme/init.mjs

@@ -5,10 +5,10 @@ import { apiFlag, ensureLoggedIn, resolveApiUrl } from "../auth/oauth.mjs";
 import { openUrl } from "../open-url.mjs";
 import { graphql } from "../auth/api.mjs";
 import { formatCredentialList } from "./credentials.mjs";
-import { spawn } from "node:child_process";
 import { existsSync, readdirSync, rmSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import { parseArgs } from "node:util";
+import { spawn } from "node:child_process";
 import os from "node:os";
 import { randomBytes } from "node:crypto";
 import { packageManagerCommands, scaffoldTheme } from "@shop-on/create-theme";

package/dist/theme/pack.mjs

@@ -0,0 +1,124 @@
+#!/usr/bin/env node
+import { runThemeBuild } from "./build.mjs";
+import { processIo } from "../audit/command.mjs";
+import { existsSync, readFileSync, readdirSync, renameSync, rmSync, statSync } from "node:fs";
+import path from "node:path";
+import { parseArgs } from "node:util";
+import { create } from "tar";
+//#region src/theme/pack.ts
+const USAGE = `usage: shop-on theme pack [--theme <dir>] [--out <path>] [--build]
+
+  --theme <dir>   the theme to pack (default: the current directory)
+  --out <path>    where to write the tarball, a file or a directory
+                  (default: <handle>-<version>.tar.gz in the theme directory)
+  --build         run \`pnpm run build\` first`;
+/** The entries the theme store refuses a version without
+* (`Theme::Versions::Create::REQUIRED_FILES` in the api). */
+const REQUIRED_FILES = [
+	"theme.json",
+	"release-notes.md",
+	"server/index.mjs",
+	"config/settings-schema.json"
+];
+const SEMVER = /^\d+\.\d+\.\d+$/;
+/** Packs the theme and returns the exit code. */
+async function runPack({ argv, cwd = process.cwd(), io = processIo, deps: overrides = {} }) {
+	const deps = {
+		build: runThemeBuild,
+		...overrides
+	};
+	let values;
+	try {
+		({values} = parseArgs({
+			args: argv,
+			options: {
+				theme: { type: "string" },
+				out: { type: "string" },
+				build: {
+					type: "boolean",
+					default: false
+				},
+				help: {
+					type: "boolean",
+					short: "h",
+					default: false
+				}
+			}
+		}));
+	} catch (err) {
+		io.err(`${err.message}\n\n${USAGE}`);
+		return 2;
+	}
+	if (values.help) {
+		io.out(USAGE);
+		return 0;
+	}
+	const themeDir = path.resolve(cwd, values.theme ?? ".");
+	const fail = (message) => {
+		io.err(message);
+		return 1;
+	};
+	const pkgPath = path.join(themeDir, "package.json");
+	if (!existsSync(pkgPath)) return fail(`${themeDir} is not a theme: it has no package.json`);
+	const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
+	if (values.build) {
+		const code = await deps.build(themeDir);
+		if (code !== 0) return fail(`the build failed (exit ${code})`);
+	}
+	const outputDir = path.join(themeDir, ".output");
+	if (!existsSync(outputDir)) return fail(`${themeDir} has no .output: run \`pnpm build\` first, or pass --build`);
+	const missing = REQUIRED_FILES.filter((rel) => !isFile(path.join(outputDir, rel)));
+	if (missing.length > 0) return fail(`.output is missing ${missing.join(", ")}; the theme store refuses a version without them`);
+	let version;
+	try {
+		({version} = JSON.parse(readFileSync(path.join(outputDir, "theme.json"), "utf8")));
+	} catch (err) {
+		return fail(`.output/theme.json is not valid JSON: ${err.message}`);
+	}
+	if (typeof version !== "string" || !SEMVER.test(version)) return fail(`.output/theme.json#version ${JSON.stringify(version)} is not semver (X.Y.Z)`);
+	if (pkg.version !== void 0 && pkg.version !== version) return fail(`.output is version ${version} but package.json says ${pkg.version}: rebuild, or pass --build`);
+	const fileName = `${themeHandle(pkg.name, themeDir)}-${version}.tar.gz`;
+	let outPath = path.join(themeDir, fileName);
+	if (values.out !== void 0) {
+		const out = path.resolve(cwd, values.out);
+		outPath = isDirectory(out) || values.out.endsWith("/") ? path.join(out, fileName) : out;
+	}
+	const tmpPath = `${outPath}.partial`;
+	let entries = 0;
+	try {
+		await create({
+			gzip: true,
+			file: tmpPath,
+			cwd: outputDir,
+			portable: true,
+			filter: (entryPath, stat) => {
+				const base = path.basename(entryPath);
+				if (base === ".DS_Store" || base.startsWith("._")) return false;
+				const keep = "isFile" in stat && (stat.isFile() || stat.isDirectory());
+				if (keep) entries += 1;
+				return keep;
+			}
+		}, readdirSync(outputDir).sort());
+		renameSync(tmpPath, outPath);
+	} catch (err) {
+		rmSync(tmpPath, { force: true });
+		return fail(`could not write ${outPath}: ${err.message}`);
+	}
+	const kb = Math.round(statSync(outPath).size / 1024);
+	const shown = path.relative(cwd, outPath);
+	io.out(`${shown.startsWith("..") ? outPath : shown} (${entries} entries, ${kb} KB)`);
+	return 0;
+}
+/** `@shop-on/themes/kito` → `kito`; the directory name when there's no name. */
+function themeHandle(name, themeDir) {
+	const last = name?.split("/").pop();
+	return last && last.length > 0 ? last : path.basename(themeDir);
+}
+function isFile(p) {
+	return existsSync(p) && statSync(p).isFile();
+}
+function isDirectory(p) {
+	return existsSync(p) && statSync(p).isDirectory();
+}
+//#endregion
+export { REQUIRED_FILES, USAGE, runPack };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shop-on/theme-cli",
-  "version": "0.1.0",
-  "description": "The Shop-On theme developer CLI: `shop-on login`, `shop-on theme init`, `shop-on theme dev` and `shop-on theme audit`.",
+  "version": "0.2.0",
+  "description": "The Shop-On theme developer CLI: `shop-on login`, `shop-on theme init`, `shop-on theme dev`, `shop-on theme audit` and `shop-on theme pack`.",
   "license": "SEE LICENSE IN dist/LICENSE.md",
   "bin": {
     "shop-on": "./dist/index.mjs"
@@ -13,21 +13,22 @@
   "dependencies": {
     "chrome-launcher": "^1.2.2",
     "lighthouse": "^13.5.0",
-    "wrangler": "4.145.0",
-    "@shop-on/create-theme": "0.1.0",
-    "@shop-on/theme-dev-host": "0.1.0"
+    "tar": "^7.5.22",
+    "wrangler": "4.151.0",
+    "@shop-on/create-theme": "0.2.0",
+    "@shop-on/theme-dev-host": "0.2.0"
   },
   "devDependencies": {
-    "@types/node": "26.6.3",
+    "@types/node": "26.6.5",
     "tsx": "^4.23.15",
     "typescript": "7.0.2",
-    "vitest": "5.0.3"
+    "vitest": "5.0.5"
   },
   "engines": {
     "node": "^20.19.0 || >=22.12.0"
   },
   "scripts": {
     "check-types": "tsc --noEmit",
-    "test": "vitest run"
+    "test": "vitest run --maxWorkers=2"
   }
 }