@stim-cli/expo-build-cache 1.0.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Janic Duplessis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# @stim-cli/expo-build-cache
+
+> Commands use `stim`. If it is not installed globally, replace `stim` with
+> `npx stim-cli`.
+
+A local Expo build cache provider. When no native input has changed, the CLI
+installs a cached `.app` / `.apk` instead of compiling — which is the difference
+between a JS-only change costing a simulator boot and costing a full native
+build.
+
+Local on purpose: a directory under `$HOME` shared by every worktree on the
+machine. No account, no network, and a second worktree building the same commit
+is a hit rather than a second five-minute build.
+
+```bash
+npm i -D @stim-cli/expo-build-cache
+```
+
+Point your Expo config at it. **Which key depends on the SDK, and the wrong one
+is a silent no-op rather than an error:**
+
+```jsonc
+// SDK 54+
+{ "expo": { "buildCacheProvider": { "plugin": "@stim-cli/expo-build-cache" } } }
+
+// SDK 53 — reads only the experiments key and ignores the top-level one
+{ "expo": { "experiments": { "buildCacheProvider": { "plugin": "@stim-cli/expo-build-cache" } } } }
+```
+
+Add a `.fingerprintignore` for anything that changes without changing the build.
+`ios/Podfile.lock` is the usual culprit: pod checksums can embed absolute paths,
+which makes the fingerprint differ per machine and the cache never hit.
+
+Watch for `[build-cache] hit` or `miss` in the output. A miss means you changed
+something native — or that you are the first workspace on this commit.
+
+### Housekeeping
+
+The cache registers itself with [`stim-cli`](https://www.npmjs.com/package/stim-cli)
+if it is installed, so it can be reported and trimmed:
+
+```bash
+stim gc                            # what it has grown to (reported on every run)
+stim gc --delete --older-than 30   # drop entries unused for 30 days
+```
+
+stim-cli is an optional peer. Without it the cache works exactly the same; it is
+just invisible to housekeeping.
+
+The location can be overridden by `STIM_CLI_BUILD_CACHE`, or machine-wide by `caches.buildCache` in `~/.stim-cli/config.json` (an absolute path; the env var wins). The CLI and this package resolve both identically, so they always share one store.

package/dist/index.d.mts

@@ -0,0 +1,16 @@
+import { BuildRunOptions, buildCacheKey } from "@stim-cli/core";
+//#region index.d.ts
+declare function cacheRoot(): string;
+declare function resolveBuildCache({ platform, fingerprintHash, runOptions }: {
+  platform: string;
+  fingerprintHash: string;
+  runOptions?: BuildRunOptions;
+}): Promise<string | null>;
+declare function uploadBuildCache({ platform, fingerprintHash, buildPath, runOptions }: {
+  platform: string;
+  fingerprintHash: string;
+  buildPath?: string;
+  runOptions?: BuildRunOptions;
+}): Promise<string | null>;
+//#endregion
+export { buildCacheKey, cacheRoot, resolveBuildCache, uploadBuildCache };

package/dist/index.mjs

@@ -0,0 +1,95 @@
+import fs from "node:fs";
+import path from "node:path";
+import { buildCacheKey, buildCacheRoot, registerCache } from "@stim-cli/core";
+import { execFileSync } from "node:child_process";
+//#region index.ts
+let registeredDir = null;
+function cacheRoot() {
+	return buildCacheRoot();
+}
+function entryDir(platform, key) {
+	return path.join(cacheRoot(), platform, key);
+}
+function shortKey(key, fingerprintHash) {
+	return `${String(fingerprintHash).slice(0, 12)}${key.slice(String(fingerprintHash).length)}`;
+}
+function artifactIn(dir) {
+	if (!fs.existsSync(dir)) return null;
+	let found;
+	try {
+		found = fs.readdirSync(dir).find((f) => f.endsWith(".app") || f.endsWith(".apk"));
+	} catch {
+		return null;
+	}
+	return found ? path.join(dir, found) : null;
+}
+function registerOnce() {
+	const root = cacheRoot();
+	if (registeredDir === root) return;
+	registeredDir = root;
+	registerCache({
+		dir: root,
+		name: "Expo build cache",
+		prune: "entries",
+		entriesDepth: 2,
+		note: "built .app/.apk keyed on the native fingerprint"
+	});
+}
+async function resolveBuildCache({ platform, fingerprintHash, runOptions }) {
+	registerOnce();
+	const key = buildCacheKey(platform, fingerprintHash, runOptions);
+	const hit = artifactIn(entryDir(platform, key));
+	if (hit) {
+		console.log(`[build-cache] hit ${platform} ${shortKey(key, fingerprintHash)}`);
+		try {
+			fs.utimesSync(path.dirname(hit), /* @__PURE__ */ new Date(), /* @__PURE__ */ new Date());
+		} catch {}
+		return hit;
+	}
+	console.log(`[build-cache] miss ${platform} ${shortKey(key, fingerprintHash)}`);
+	return null;
+}
+async function uploadBuildCache({ platform, fingerprintHash, buildPath, runOptions }) {
+	registerOnce();
+	if (!buildPath || !fs.existsSync(buildPath)) return null;
+	const key = buildCacheKey(platform, fingerprintHash, runOptions);
+	const dest = entryDir(platform, key);
+	if (artifactIn(dest)) return artifactIn(dest);
+	const staging = `${dest}.staging-${process.pid}`;
+	fs.rmSync(staging, {
+		recursive: true,
+		force: true
+	});
+	fs.mkdirSync(staging, { recursive: true });
+	try {
+		execFileSync("cp", [
+			"-c",
+			"-R",
+			buildPath,
+			path.join(staging, path.basename(buildPath))
+		]);
+	} catch {
+		execFileSync("cp", [
+			"-R",
+			buildPath,
+			path.join(staging, path.basename(buildPath))
+		]);
+	}
+	fs.mkdirSync(path.dirname(dest), { recursive: true });
+	fs.rmSync(dest, {
+		recursive: true,
+		force: true
+	});
+	try {
+		fs.renameSync(staging, dest);
+	} catch {
+		fs.rmSync(staging, {
+			recursive: true,
+			force: true
+		});
+	}
+	console.log(`[build-cache] stored ${platform} ${shortKey(key, fingerprintHash)}`);
+	return artifactIn(dest);
+}
+//#endregion
+export { buildCacheKey, cacheRoot, resolveBuildCache, uploadBuildCache };

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@stim-cli/expo-build-cache",
+  "version": "1.0.0-rc.0",
+  "description": "Local Expo build cache provider: installs a cached .app/.apk instead of compiling when no native input changed.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/appandflow/stim-cli.git",
+    "directory": "packages/expo-build-cache"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "module-sync": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "dependencies": {
+    "@stim-cli/core": "^1.0.0-rc.0"
+  },
+  "engines": {
+    "node": "^20.19.4 || >=22.12.0"
+  },
+  "scripts": {
+    "test": "node --test test/*.test.js",
+    "build": "tsdown"
+  }
+}