feat(core): add RegExp support for url filtering

harlan-zw · May 10, 2023 · 4a3be94 · 4a3be94
1 parent 5947ee7
commit 4a3be94
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/packages/core/src/puppeteer/worker.ts b/packages/core/src/puppeteer/worker.ts
@@ -10,7 +10,7 @@ import type {
   UnlighthouseTask,
   UnlighthouseWorker, UnlighthouseWorkerStats,
 } from '../types'
-import { ReportArtifacts, createTaskReportFromRoute } from '../util'
+import {ReportArtifacts, createTaskReportFromRoute, asRegExp} from '../util'
 import { useUnlighthouse } from '../unlighthouse'
 import { useLogger } from '../logger'
 import {
@@ -84,13 +84,13 @@ export async function createUnlighthouseWorker(tasks: Record<UnlighthouseTask, T
 
     if (resolvedConfig.scanner.include) {
       // must match
-      if (resolvedConfig.scanner.include.filter(rule => (new RegExp(rule).test(path))).length === 0)
+      if (resolvedConfig.scanner.include.filter(rule => asRegExp(rule).test(path)).length === 0)
         return
     }
 
     if (resolvedConfig.scanner.exclude) {
       // must not match
-      if (resolvedConfig.scanner.exclude.filter(rule => (new RegExp(rule).test(path))).length > 0)
+      if (resolvedConfig.scanner.exclude.filter(rule => asRegExp(rule).test(path)).length > 0)
         return
     }
 

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -350,13 +350,13 @@ export interface ResolvedUserConfig {
      *
      * @see https://unlighthouse.dev/guide/large-sites.html#include-url-patterns
      */
-    include?: string[]
+    include?: (string | RegExp)[]
     /**
      * Paths to ignore from scanning.
      *
      * @see https://unlighthouse.dev/guide/large-sites.html#exclude-url-patterns
      */
-    exclude?: string[]
+    exclude?: (string | RegExp)[]
     /**
      * Does javascript need to be executed in order to fetch internal links and SEO data.
      *

diff --git a/packages/core/src/util.ts b/packages/core/src/util.ts
@@ -160,3 +160,7 @@ export async function fetchUrlRaw(url: string, resolvedConfig: ResolvedUserConfi
     }
   }
 }
+
+export function asRegExp(rule: string | RegExp): RegExp {
+  return rule instanceof RegExp ? rule : new RegExp(rule)
+}
-Original file line number
+Diff line change
@@ Expand Up @@
         }
       }
     }
+    export function asRegExp(rule: string | RegExp): RegExp {
+      return rule instanceof RegExp ? rule : new RegExp(rule)
+    }