spooder 4.2.11 → 4.2.12

package/README.md

@@ -62,7 +62,8 @@ The `CLI` component of `spooder` is a global command-line tool for running serve
 	- [`safe(fn: Callable): Promise<void>`](#api-error-handling-safe)
 - [API > Content](#api-content)
 	- [`parse_template(template: string, replacements: Record<string, string>, drop_missing: boolean): string`](#api-content-parse-template)
-	- [`generate_hash_subs(length: number, prefix: string): Promise<Record<string, string>>`](#api-content-generate-hash-subs)
+	- [`generate_hash_subs(length: number, prefix: string, hashes?: Record<string, string>): Promise<Record<string, string>>`](#api-content-generate-hash-subs)
+	- [`get_git_hashes(length: number): Promise<Record<string, string>>`](#api-content-get-git-hashes)
 	- [`apply_range(file: BunFile, request: Request): HandlerReturnType`](#api-content-apply-range)
 - [API > State Management](#api-state-management)
 	- [`set_cookie(res: Response, name: string, value: string, options?: CookieOptions)`](#api-state-management-set-cookie)
@@ -1098,7 +1099,7 @@ parse_template(..., {
 ```
 
 <a id="api-content-generate-hash-subs"></a>
-### 🔧 `generate_hash_subs(prefix: string): Promise<Record<string, string>>`
+### 🔧 `generate_hash_subs(length: number, prefix: string, hashes?: Record<string, string>): Promise<Record<string, string>>`
 
 Generate a replacement table for mapping file paths to hashes in templates. This is useful for cache-busting static assets.
 
@@ -1142,6 +1143,29 @@ server.route('/test', (req, url) => {
 });
 ```
 
+<a id="api-content-get-git-hashes"></a>
+### 🔧 ``get_git_hashes(length: number): Promise<Record<string, string>>``
+
+Internally, `generate_hash_subs()` uses `get_git_hashes()` to retrieve the hash table from git. This function is exposed for convenience.
+
+> [!IMPORTANT]
+> Internally `get_git_hashes()` uses `git ls-tree -r HEAD`, so the working directory must be a git repository.
+
+```ts
+const hashes = await get_git_hashes(7);
+// { 'docs/project-logo.png': '754d9ea' }
+```
+
+If you're using `generate_hash_subs()` and `get_git_hashes()` at the same time, it is more efficient to pass the result of `get_git_hashes()` directly to `generate_hash_subs()` to prevent redundant calls to git.
+
+```ts
+const hashes = await get_git_hashes(7);
+const subs = await generate_hash_subs(7, undefined, hashes);
+
+// hashes[0] -> { 'docs/project-logo.png': '754d9ea' }
+// subs[0] -> { 'hash=docs/project-logo.png': '754d9ea' }
+```
+
 <a id="api-apply-range"></a>
 ### 🔧 `apply_range(file: BunFile, request: Request): HandlerReturnType`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "spooder",
 	"type": "module",
-	"version": "4.2.11",
+	"version": "4.2.12",
 	"exports": {
 		".": {
 			"bun": "./src/api.ts",

package/src/api.ts

@@ -170,7 +170,7 @@ export function parse_template(template: string, replacements: Replacements, dro
 	return result;
 }
 
-export async function generate_hash_subs(length = 7, prefix = 'hash='): Promise<Record<string, string>> {
+export async function get_git_hashes(length = 7): Promise<Record<string, string>> {
 	const cmd = ['git', 'ls-tree', '-r', 'HEAD'];
 	const process = Bun.spawn(cmd, {
 		stdout: 'pipe',
@@ -180,7 +180,7 @@ export async function generate_hash_subs(length = 7, prefix = 'hash='): Promise<
 	await process.exited;
 
 	if (process.exitCode as number > 0)
-		throw new Error('generate_hash_subs() failed, `' + cmd.join(' ') + '` exited with non-zero exit code.');
+		throw new Error('get_git_hashes() failed, `' + cmd.join(' ') + '` exited with non-zero exit code.');
 
 	const stdout = await Bun.readableStreamToText(process.stdout as ReadableStream);
 	const hash_map: Record<string, string> = {};
@@ -188,11 +188,20 @@ export async function generate_hash_subs(length = 7, prefix = 'hash='): Promise<
 	const regex = /([^\s]+)\s([^\s]+)\s([^\s]+)\t(.+)/g;
 	let match: RegExpExecArray | null;
 
-	let hash_count = 0;
-	while (match = regex.exec(stdout)) {
-		hash_map[prefix + match[4]] = match[3].substring(0, length);
-		hash_count++;
-	}
+	while (match = regex.exec(stdout))
+		hash_map[match[4]] = match[3].substring(0, length);
+
+	return hash_map;
+}
+
+export async function generate_hash_subs(length = 7, prefix = 'hash=', hashes?: Record<string, string>): Promise<Record<string, string>> {	
+	const hash_map: Record<string, string> = {};
+
+	if (!hashes)
+		hashes = await get_git_hashes(length);
+
+	for (const [file, hash] of Object.entries(hashes))
+		hash_map[prefix + file] = hash;
 
 	return hash_map;
 }