added search.file()

Author: oscarotero

CHANGELOG.md

@@ -7,13 +7,19 @@ Go to the `v2` branch to see the changelog of Lume 2.
 Go to the `v1` branch to see the changelog of Lume 1.
 
 ## [3.1.2] - Unreleased
+### Added
+- `search.file()` to search for a single file.
+
+### Changed
+- Cache results of `search.files()`.
+
 ### Fixed
-- Ensure console output for validate_html and seo plugins are after the build process.
+- Ensure console output for validate_html and seo plugins is shown after the build process.
 - `run` command.
 - Added missing tests for SEO plugin.
 - Renamed `Config` interface of `seo` and `validate_html` plugins to `Options`.
 - Added export-ignore paths to `.gitattributes`.
-- `site.remote()`: support commit SHA
+- `site.remote()`: support commit SHA for GitHub versions.
 - Updated dependencies: `deno-loader`, `tailwindcss`, `html-validate`, `magic-string`, `minify-html` and some icons.
 
 ## [3.1.1] - 2025-10-20

core/searcher.ts

@@ -26,6 +26,7 @@ export default class Searcher {
   #files: StaticFile[];
   #sourceData: Map<string, Partial<Data>>;
   #cache = new Map<string, Data[]>();
+  #cacheFiles = new Map<string, string[]>();
   #filters: Filter[];
 
   constructor(options: Options) {
@@ -38,6 +39,7 @@ export default class Searcher {
   /** Clear the cache (used after a change in watch mode) */
   deleteCache() {
     this.#cache.clear();
+    this.#cacheFiles.clear();
   }
 
   /**
@@ -78,19 +80,12 @@ export default class Searcher {
 
   /** Search files using a glob */
   files(globOrRegexp?: RegExp | string): string[] {
-    const files = this.#files.map((file) => file.outputPath);
-    const pages = this.#pages.map((page) => page.outputPath);
-    const allFiles = [...files, ...pages];
-
-    if (!globOrRegexp) {
-      return allFiles;
-    }
-
-    const regexp = typeof globOrRegexp === "string"
-      ? globToRegExp(globOrRegexp)
-      : globOrRegexp;
+    return this.#searchFiles(globOrRegexp);
+  }
 
-    return allFiles.filter((file) => regexp.test(file));
+  /** Search a single file using a glob */
+  file(globOrRegexp?: RegExp | string): string | undefined {
+    return this.#searchFiles(globOrRegexp)[0];
   }
 
   /** Returns all values from the same key of a search */
@@ -154,6 +149,30 @@ export default class Searcher {
     this.#cache.set(id, result);
     return [...result] as (Data & T)[];
   }
+
+  #searchFiles(globOrRegexp?: RegExp | string): string[] {
+    const id = typeof globOrRegexp === "string"
+      ? globOrRegexp
+      : globOrRegexp?.source || "";
+
+    if (this.#cacheFiles.has(id)) {
+      return [...this.#cacheFiles.get(id)!];
+    }
+
+    const files = this.#files.map((file) => file.outputPath);
+    const pages = this.#pages.map((page) => page.outputPath);
+    let result: string[] = [...files, ...pages];
+
+    if (typeof globOrRegexp === "string") {
+      const regexp = globToRegExp(globOrRegexp);
+      result = result.filter((file) => regexp.test(file));
+    } else if (globOrRegexp instanceof RegExp) {
+      result = result.filter((file) => globOrRegexp.test(file));
+    }
+
+    this.#cacheFiles.set(id, result);
+    return [...result];
+  }
 }
 
 /**