@nifrajs/content 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @nifrajs/content
 
+## 5.3.0
+
+### Patch Changes
+
+- 7d7bbe4: `defineCollection` takes `watch: false` to list and parse its directory once and return that snapshot from every later `all()`. The default still lists the directory and stats every file per call, which costs 3.5 ms per `all()` at 2,000 files; with `watch: false` it costs 0.005 ms. A file deleted and recreated with the same size and modification time is also read again, where a parse cached before the deletion used to be returned.
+
+## 5.2.1
+
+No changes in this release.
+
 ## 5.2.0
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nifrajs/content",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Typed, schema-validated content collections for nifra - Markdown + frontmatter, framework-agnostic.",
   "keywords": [
     "bun",

package/src/fs.ts

@@ -15,6 +15,11 @@ export interface CollectionConfig<S extends StandardSchemaV1> {
   readonly schema: S
   /** File extensions to include (default `[".md", ".markdown"]`). */
   readonly extensions?: readonly string[]
+  /** Look for changes on every `all()` (default `true`): a directory listing and a `stat` per file,
+   * so an edit shows without a restart. `false` lists and parses the directory once and returns that
+   * snapshot from then on, for a server whose content ships with its build. `get` checks its one
+   * file either way. */
+  readonly watch?: boolean
 }
 
 /** A typed collection over a content directory. */
@@ -80,6 +85,7 @@ export function defineCollection<S extends StandardSchemaV1>(
   const matches = (file: string): boolean => extensions.some((ext) => file.endsWith(ext))
   const fileCache = new Map<string, CachedEntry<InferSchema<S>>>()
   let collectionCache: CollectionSnapshot<InferSchema<S>> | undefined
+  let frozen: Promise<Array<Entry<InferSchema<S>>>> | undefined
 
   const readEntry = async (
     path: string,
@@ -109,20 +115,32 @@ export function defineCollection<S extends StandardSchemaV1>(
     )
   }
 
+  const load = async (): Promise<Array<Entry<InferSchema<S>>>> => {
+    const files = await listFiles()
+    const fingerprint = files.map((file) => `${file.file}\0${file.stamp}`).join("\0")
+    if (collectionCache?.fingerprint === fingerprint) return collectionCache.entries
+
+    const listed = new Set(files.map((file) => file.path))
+    for (const path of fileCache.keys()) if (!listed.has(path)) fileCache.delete(path)
+    const entries = await Promise.all(
+      files.map((file) => readEntry(file.path, slugOf(file.file), file.stamp)),
+    )
+    collectionCache = {
+      fingerprint,
+      entries,
+    }
+    return entries
+  }
+
   return {
     async all() {
-      const files = await listFiles()
-      const fingerprint = files.map((file) => `${file.file}\0${file.stamp}`).join("\0")
-      if (collectionCache?.fingerprint === fingerprint) return [...collectionCache.entries]
-
-      const entries = await Promise.all(
-        files.map((file) => readEntry(file.path, slugOf(file.file), file.stamp)),
-      )
-      collectionCache = {
-        fingerprint,
-        entries,
-      }
-      return [...entries]
+      if (config.watch !== false) return [...(await load())]
+      // A failed first read is not kept, so the next call retries it.
+      frozen ??= load().catch((error: unknown) => {
+        frozen = undefined
+        throw error
+      })
+      return [...(await frozen)]
     },
     async get(slug) {
       if (!isSafeSlug(slug)) return null
@@ -134,6 +152,7 @@ export function defineCollection<S extends StandardSchemaV1>(
         try {
           stat = await statPath(file)
         } catch {
+          fileCache.delete(file)
           continue // Not this extension; try the next configured one.
         }
         if (!stat.isFile()) continue