tsdown-stale-guard 0.0.0 → 0.1.0

package/README.md

@@ -8,13 +8,15 @@
 
 Build freshness validation for [tsdown](https://github.com/rolldown/tsdown). Records hashes of all files involved in a build, enabling fast up-to-date checks without re-building.
 
+> This plugin requires `tsdown@0.21.9` or later.
+
 ## Features
 
 - **tsdown/Rolldown plugin** — automatically tracks source files, output files, config, and package lock file
 - **Composite hash** — single hash for quick freshness checks
 - **Find-up search** — detects lock files and configs in monorepo setups
-- **CLI** — `tsdown-stale-guard check` for CI pipelines
-- **Programmatic API** — `checkBuildFreshness()` for tool integrations
+- **CLI** — `tsdown-stale-guard` for CI pipelines
+- **Programmatic API** — `checkBuildState()` for tool integrations
 
 ## Install
 
@@ -29,17 +31,17 @@ npm i tsdown-stale-guard
 ```ts
 // tsdown.config.ts
 import { defineConfig } from 'tsdown'
-import { TsdownStaleGuard } from 'tsdown-stale-guard'
+import { StaleGuardRecorder } from 'tsdown-stale-guard'
 
 export default defineConfig({
   entry: ['src/index.ts'],
   plugins: [
-    TsdownStaleGuard(),
+    StaleGuardRecorder(),
   ],
 })
 ```
 
-After building, a hash file will be generated at `node_modules/.cache/tsdown-stale-guard/hash.yaml`. Since it lives inside `node_modules`, it does not need to be gitignored.
+After building, a hash file will be generated at `node_modules/.cache/tsdown-stale-guard/hash.yaml`.
 
 Example of the generated hash file:
 
@@ -65,7 +67,7 @@ outputs:
 ### Plugin Options
 
 ```ts
-TsdownStaleGuard({
+StaleGuardRecorder({
   hashFile: 'node_modules/.cache/tsdown-stale-guard/hash.yaml', // hash file path (default)
   root: process.cwd(), // root directory (default)
   hashOutputs: true, // hash output files (default)
@@ -76,10 +78,10 @@ TsdownStaleGuard({
 
 ```bash
 # Check if the build is up to date
-tsdown-stale-guard check
+tsdown-stale-guard
 
 # Use a custom hash file path
-tsdown-stale-guard check --hash-file custom.hash.yaml
+tsdown-stale-guard --hash-file custom.hash.yaml
 ```
 
 Exit code `0` if fresh, `1` if stale.
@@ -87,9 +89,9 @@ Exit code `0` if fresh, `1` if stale.
 ### Programmatic API
 
 ```ts
-import { checkBuildFreshness } from 'tsdown-stale-guard'
+import { checkBuildState } from 'tsdown-stale-guard'
 
-const result = await checkBuildFreshness()
+const result = await checkBuildState()
 
 if (result.fresh) {
   console.log('Build is up to date')
@@ -133,7 +135,7 @@ Package lock files (`pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`, `bun.loc
 [npm-downloads-href]: https://npmjs.com/package/tsdown-stale-guard
 [bundle-src]: https://img.shields.io/bundlephobia/minzip/tsdown-stale-guard?style=flat&colorA=080f12&colorB=1fa669&label=minzip
 [bundle-href]: https://bundlephobia.com/result?p=tsdown-stale-guard
-[license-src]: https://img.shields.io/github/license/antfu/tsdown-stale-guard.svg?style=flat&colorA=080f12&colorB=1fa669
-[license-href]: https://github.com/antfu/tsdown-stale-guard/blob/main/LICENSE
+[license-src]: https://img.shields.io/github/license/antfu-collective/tsdown-stale-guard.svg?style=flat&colorA=080f12&colorB=1fa669
+[license-href]: https://github.com/antfu-collective/tsdown-stale-guard/blob/main/LICENSE
 [jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
 [jsdocs-href]: https://www.jsdocs.io/package/tsdown-stale-guard

package/dist/{check-YFLy7mcd.mjs → check-CWbzg4YR.mjs}

@@ -34,7 +34,7 @@ function serializeHashFile(data) {
 		version: data.version,
 		hash: data.hash
 	};
-	if (data.config) obj.config = { [data.config.file]: data.config.hash };
+	if (data.configs) obj.configs = Object.fromEntries(data.configs.map((e) => [e.file, e.hash]));
 	if (data.lockfile) obj.lockfile = { [data.lockfile.file]: data.lockfile.hash };
 	if (data.sources.length > 0) obj.sources = Object.fromEntries(data.sources.map((e) => [e.file, e.hash]));
 	if (data.outputs.length > 0) obj.outputs = Object.fromEntries(data.outputs.map((e) => [e.file, e.hash]));
@@ -45,7 +45,7 @@ function parseHashFile(content) {
 	return {
 		version: obj.version,
 		hash: obj.hash,
-		config: parseSection(obj.config),
+		configs: parseSectionList(obj.configs),
 		lockfile: parseSection(obj.lockfile),
 		sources: parseSectionList(obj.sources),
 		outputs: parseSectionList(obj.outputs)
@@ -78,22 +78,24 @@ async function writeHashFile(path, data) {
 //#endregion
 //#region src/check.ts
 const DEFAULT_HASH_FILE = "node_modules/.cache/tsdown-stale-guard/hash.yaml";
-async function checkBuildFreshness(options = {}) {
+async function checkBuildState(options = {}) {
 	const root = options.root || process.cwd();
 	const data = await readHashFile(resolve(root, options.hashFile || DEFAULT_HASH_FILE));
 	const changes = [];
-	if (data.config) await checkEntry(data.config, "config", root, changes);
+	if (data.configs) for (const entry of data.configs) await checkEntry(entry, "config", root, changes);
 	if (data.lockfile) await checkEntry(data.lockfile, "lockfile", root, changes);
 	for (const entry of data.sources) await checkEntry(entry, "source", root, changes);
 	for (const entry of data.outputs) await checkEntry(entry, "output", root, changes);
 	const currentHash = computeCompositeHash([
 		...data.sources,
 		...data.outputs,
-		...data.config ? [data.config] : [],
+		...data.configs || [],
 		...data.lockfile ? [data.lockfile] : []
 	]);
+	const fresh = changes.length === 0 && currentHash === data.hash;
 	return {
-		fresh: changes.length === 0 && currentHash === data.hash,
+		fresh,
+		stale: !fresh,
 		changes
 	};
 }
@@ -114,4 +116,4 @@ async function checkEntry(entry, category, root, changes) {
 	});
 }
 //#endregion
-export { writeHashFile as a, hashFiles as c, serializeHashFile as i, parseHashFile as n, computeCompositeHash as o, readHashFile as r, hashFile as s, checkBuildFreshness as t };
+export { writeHashFile as a, hashFiles as c, serializeHashFile as i, parseHashFile as n, computeCompositeHash as o, readHashFile as r, hashFile as s, checkBuildState as t };

package/dist/cli.mjs

@@ -1,12 +1,11 @@
 #!/usr/bin/env node
-import { t as checkBuildFreshness } from "./check-YFLy7mcd.mjs";
+import { t as checkBuildState } from "./check-CWbzg4YR.mjs";
 import process from "node:process";
+import cac from "cac";
 //#region src/cli.ts
-const args = process.argv.slice(2);
-const command = args[0];
-if (command === "check") {
-	const hashFileIdx = args.indexOf("--hash-file");
-	const result = await checkBuildFreshness({ hashFile: hashFileIdx !== -1 ? args[hashFileIdx + 1] : void 0 });
+const cli = cac("tsdown-stale-guard");
+cli.command("[...args]", "Check if the build is up to date").option("--hash-file <path>", "Path to the hash file").action(async (_args, options) => {
+	const result = await checkBuildState({ hashFile: options.hashFile });
 	if (result.fresh) {
 		console.log("Build is up to date.");
 		process.exit(0);
@@ -15,17 +14,8 @@ if (command === "check") {
 		for (const change of result.changes) console.log(`  ${change.type}: [${change.category}] ${change.file}`);
 		process.exit(1);
 	}
-} else {
-	console.log(`tsdown-stale-guard - Build freshness validation for tsdown
-
-Usage:
-  tsdown-stale-guard check              Check if the build is up to date
-  tsdown-stale-guard check --hash-file <path>  Use a custom hash file path
-
-Options:
-  --hash-file <path>  Path to the hash file (default: node_modules/.cache/tsdown-stale-guard/hash.yaml)
-  --help              Show this help message`);
-	process.exit(command === "--help" || command === "-h" ? 0 : 1);
-}
+});
+cli.help();
+cli.parse();
 //#endregion
 export {};

package/dist/index.d.mts

@@ -1,20 +1,21 @@
-import { Plugin } from "rolldown";
+import { TsdownPlugin } from "tsdown";
 
 //#region src/types.d.ts
-interface TsdownStaleGuardEntry {
+interface StaleGuardEntry {
   file: string;
   hash: string;
 }
-interface TsdownStaleGuardData {
+interface StaleGuardData {
   version: 1;
   hash: string;
-  config?: TsdownStaleGuardEntry;
-  lockfile?: TsdownStaleGuardEntry;
-  sources: TsdownStaleGuardEntry[];
-  outputs: TsdownStaleGuardEntry[];
+  configs?: StaleGuardEntry[];
+  lockfile?: StaleGuardEntry;
+  sources: StaleGuardEntry[];
+  outputs: StaleGuardEntry[];
 }
 interface CheckResult {
   fresh: boolean;
+  stale: boolean;
   changes: CheckChange[];
 }
 interface CheckChange {
@@ -22,7 +23,7 @@ interface CheckChange {
   category: 'config' | 'lockfile' | 'source' | 'output';
   file: string;
 }
-interface TsdownStaleGuardPluginOptions {
+interface StaleGuardRecorderOptions {
   /**
    * Path to the hash file.
    * @default 'node_modules/.cache/tsdown-stale-guard/hash.yaml'
@@ -53,14 +54,14 @@ interface CheckOptions {
 }
 //#endregion
 //#region src/check.d.ts
-declare function checkBuildFreshness(options?: CheckOptions): Promise<CheckResult>;
+declare function checkBuildState(options?: CheckOptions): Promise<CheckResult>;
 //#endregion
 //#region src/lockfile.d.ts
-declare function serializeHashFile(data: TsdownStaleGuardData): string;
-declare function parseHashFile(content: string): TsdownStaleGuardData;
-declare function readHashFile(path: string): Promise<TsdownStaleGuardData>;
+declare function serializeHashFile(data: StaleGuardData): string;
+declare function parseHashFile(content: string): StaleGuardData;
+declare function readHashFile(path: string): Promise<StaleGuardData>;
 //#endregion
 //#region src/plugin.d.ts
-declare function TsdownStaleGuard(options?: TsdownStaleGuardPluginOptions): Plugin;
+declare function StaleGuardRecorder(options?: StaleGuardRecorderOptions): TsdownPlugin;
 //#endregion
-export { type CheckChange, type CheckOptions, type CheckResult, TsdownStaleGuard, type TsdownStaleGuardData, type TsdownStaleGuardEntry, type TsdownStaleGuardPluginOptions, checkBuildFreshness, parseHashFile, readHashFile, serializeHashFile };
+export { type CheckChange, type CheckOptions, type CheckResult, type StaleGuardData, type StaleGuardEntry, StaleGuardRecorder, type StaleGuardRecorderOptions, checkBuildState, parseHashFile, readHashFile, serializeHashFile };

package/dist/index.mjs

@@ -1,7 +1,6 @@
-import { a as writeHashFile, c as hashFiles, i as serializeHashFile, n as parseHashFile, o as computeCompositeHash, r as readHashFile, s as hashFile, t as checkBuildFreshness } from "./check-YFLy7mcd.mjs";
+import { a as writeHashFile, c as hashFiles, i as serializeHashFile, n as parseHashFile, o as computeCompositeHash, r as readHashFile, s as hashFile, t as checkBuildState } from "./check-CWbzg4YR.mjs";
 import { existsSync } from "node:fs";
 import { dirname, join, relative, resolve } from "node:path";
-import process from "node:process";
 import { readdir } from "node:fs/promises";
 //#region src/detect.ts
 const PACKAGE_LOCK_FILES = [
@@ -11,15 +10,6 @@ const PACKAGE_LOCK_FILES = [
 	"bun.lockb",
 	"bun.lock"
 ];
-const TSDOWN_CONFIG_FILES = [
-	"tsdown.config.ts",
-	"tsdown.config.mts",
-	"tsdown.config.cts",
-	"tsdown.config.js",
-	"tsdown.config.mjs",
-	"tsdown.config.cjs",
-	"tsdown.config.json"
-];
 function findUp(names, cwd) {
 	let dir = resolve(cwd);
 	while (true) {
@@ -35,23 +25,26 @@ function findUp(names, cwd) {
 function detectPackageLock(cwd) {
 	return findUp(PACKAGE_LOCK_FILES, cwd);
 }
-function detectTsdownConfig(cwd) {
-	return findUp(TSDOWN_CONFIG_FILES, cwd);
-}
 //#endregion
 //#region src/plugin.ts
 const RE_QUERY = /\?.*$/;
 const RE_WINDOWS_DRIVE = /^[a-z]:\\/i;
 const RE_NODE_MODULES = /node_modules/;
 const DEFAULT_HASH_FILE = "node_modules/.cache/tsdown-stale-guard/hash.yaml";
-function TsdownStaleGuard(options = {}) {
+function StaleGuardRecorder(options = {}) {
 	const { hashFile: hashFilePath = DEFAULT_HASH_FILE, hashOutputs = true } = options;
 	const sourceIds = /* @__PURE__ */ new Set();
 	let root;
+	let configDeps;
+	let outDir;
+	let isTsdownConfigResolvedCalled = false;
 	return {
 		name: "tsdown-stale-guard",
-		buildStart() {
-			root = options.root || process.cwd();
+		tsdownConfigResolved(config) {
+			isTsdownConfigResolvedCalled = true;
+			root = options.root || config.cwd;
+			configDeps = config.configDeps;
+			outDir = config.outDir;
 		},
 		transform: {
 			filter: { id: { exclude: [RE_NODE_MODULES] } },
@@ -60,8 +53,8 @@ function TsdownStaleGuard(options = {}) {
 				if (cleanId.startsWith("/") || RE_WINDOWS_DRIVE.test(cleanId)) sourceIds.add(cleanId);
 			}
 		},
-		async writeBundle(opts) {
-			const outDir = opts.dir || resolve(root, "dist");
+		async writeBundle() {
+			if (!isTsdownConfigResolvedCalled) throw new Error("tsdownConfigResolved is not being called correctly. `tsdown-stale-guard` requires `tsdown@0.21.9` or later, please check your tsdown version.");
 			const resolvedHashFile = resolve(root, hashFilePath);
 			const sources = await hashFiles([...sourceIds].filter((f) => existsSync(f)), root);
 			let outputs = [];
@@ -74,14 +67,14 @@ function TsdownStaleGuard(options = {}) {
 				for (const file of files) if (file.isFile()) outputPaths.push(resolve(file.parentPath, file.name));
 				outputs = await hashFiles(outputPaths, root);
 			}
-			let config;
-			const configPath = detectTsdownConfig(root);
-			if (configPath) {
-				const hash = await hashFile(configPath);
-				config = {
-					file: toForwardSlash(relative(root, configPath)),
+			const configs = [];
+			if (configDeps) for (const dep of configDeps) {
+				const hash = await hashFile(dep);
+				const file = toForwardSlash(relative(root, dep));
+				configs.push({
+					file,
 					hash
-				};
+				});
 			}
 			let lockfileEntry;
 			const lockfilePath = detectPackageLock(root);
@@ -97,10 +90,10 @@ function TsdownStaleGuard(options = {}) {
 				hash: computeCompositeHash([
 					...sources,
 					...outputs,
-					...config ? [config] : [],
+					...configs,
 					...lockfileEntry ? [lockfileEntry] : []
 				]),
-				config,
+				configs,
 				lockfile: lockfileEntry,
 				sources,
 				outputs
@@ -112,4 +105,4 @@ function toForwardSlash(p) {
 	return p.replace(/\\/g, "/");
 }
 //#endregion
-export { TsdownStaleGuard, checkBuildFreshness, parseHashFile, readHashFile, serializeHashFile };
+export { StaleGuardRecorder, checkBuildState, parseHashFile, readHashFile, serializeHashFile };

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "tsdown-stale-guard",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Build freshness validation for tsdown",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/antfu",
-  "homepage": "https://github.com/antfu/tsdown-stale-guard#readme",
+  "homepage": "https://github.com/antfu-collective/tsdown-stale-guard#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/antfu/tsdown-stale-guard.git"
+    "url": "git+https://github.com/antfu-collective/tsdown-stale-guard.git"
   },
-  "bugs": "https://github.com/antfu/tsdown-stale-guard/issues",
+  "bugs": "https://github.com/antfu-collective/tsdown-stale-guard/issues",
   "keywords": [
     "tsdown",
     "build",
@@ -32,7 +32,11 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "tsdown": "^0.21.9"
+  },
   "dependencies": {
+    "cac": "^7.0.0",
     "yaml": "^2.8.3"
   },
   "devDependencies": {
@@ -44,10 +48,9 @@
     "eslint": "^10.2.0",
     "lint-staged": "^16.4.0",
     "publint": "^0.3.18",
-    "rolldown": "1.0.0-rc.15",
     "simple-git-hooks": "^2.13.1",
-    "tsdown": "^0.21.8",
-    "tsnapi": "^0.2.1",
+    "tsdown": "^0.21.9",
+    "tsnapi": "^0.3.0",
     "tsx": "^4.21.0",
     "typescript": "^6.0.2",
     "vite": "^8.0.8",