Add filter to SearchIndexPlugin

jpmorganchase · Aug 29, 2024 · b75cd3f · b75cd3f
1 parent d138bcf
commit b75cd3f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/.changeset/cool-ads-carry.md b/.changeset/cool-ads-carry.md
@@ -0,0 +1,5 @@
+---
+'@jpmorganchase/mosaic-plugins': minor
+---
+
+Add a `filter` option to SearchIndexPlugin, which allows you to exclude pages from the search index.
diff --git a/packages/plugins/src/SearchIndexPlugin.ts b/packages/plugins/src/SearchIndexPlugin.ts
@@ -29,6 +29,10 @@ interface SearchIndexPluginOptions {
   maxLineCount?: number;
   keys?: string[];
   relevancy?: SearchRelevancy;
+  /**
+   * An array of glob patterns to exclude pages from the search index.
+   */
+  filter?: string[];
 }
 
 interface Optimization {
@@ -145,13 +149,13 @@ const SearchIndexPlugin: PluginType<Page, SearchIndexPluginOptions> = {
   async $beforeSend(
     mutableFilesystem,
     { config, serialiser, ignorePages },
-    { maxLineLength, maxLineCount, keys: optionKeys }
+    { maxLineLength, maxLineCount, keys: optionKeys, filter }
   ) {
     const pages = await Promise.all(
       (
         (await mutableFilesystem.promises.glob('**', {
           onlyFiles: true,
-          ignore: ignorePages.map(ignore => `**/${ignore}`),
+          ignore: ignorePages.map(ignore => `**/${ignore}`).concat(filter),
           cwd: '/'
         })) as string[]
       ).map(async pagePath => {