feat: remove skip array rules in favor of filterFn in routes scanner

The filter fn is more flexible can be controlled directly via tuyau

Author: thetutlage

src/code_scanners/routes_scanner/main.ts

@@ -22,6 +22,7 @@ import {
   type RoutesListItem,
   type ScannedController,
   type RoutesScannerRules,
+  type RoutesScannerFilterFn,
 } from '../../types/code_scanners.ts'
 
 /**
@@ -41,6 +42,8 @@ import {
  * const scannedRoutes = scanner.getScannedRoutes()
  */
 export class RoutesScanner {
+  #filter: RoutesScannerFilterFn = () => false
+
   /**
    * The root of the application from where we will resolve
    * paths.
@@ -103,7 +106,6 @@ export class RoutesScanner {
    * The rules to apply when scanning routes
    */
   rules: RoutesScannerRules = {
-    skip: [],
     request: {},
     response: {},
   }
@@ -119,15 +121,9 @@ export class RoutesScanner {
     this.pathsResolver = new PathsResolver(appRoot)
 
     rulesCollection.forEach((rules) => {
-      this.rules.skip = this.rules.skip.concat(rules.skip)
       Object.assign(this.rules.request, rules.request)
       Object.assign(this.rules.response, rules.response)
     })
-
-    /**
-     * Removing duplicates
-     */
-    this.rules.skip = Array.from(new Set([...this.rules.skip]))
   }
 
   /**
@@ -303,7 +299,7 @@ export class RoutesScanner {
      * name for the route. There could be chances where one controller+method
      * combination is bound to multiple routes.
      */
-    const routeName =
+    route.name =
       route.name ??
       new StringBuilder(controller.name)
         .removeSuffix('Controller')
@@ -315,7 +311,7 @@ export class RoutesScanner {
      * Skip route when its name is within the array of
      * skip routes
      */
-    if (this.rules.skip.includes(routeName)) {
+    if (this.#filter(route)) {
       return
     }
 
@@ -324,13 +320,13 @@ export class RoutesScanner {
      * and request if these values are not provided via rules.
      */
     const scannedRoute: ScannedRoute = {
-      name: routeName,
+      name: route.name,
       domain: route.domain,
       methods: route.methods,
       pattern: route.pattern,
       tokens: route.tokens,
-      request: this.rules.request[routeName],
-      response: this.rules.response[routeName],
+      request: this.rules.request[route.name],
+      response: this.rules.response[route.name],
       controller,
     }
 
@@ -365,7 +361,7 @@ export class RoutesScanner {
      * Skip route when it has a name and also part of
      * skip array
      */
-    if (route.name && this.rules.skip.includes(route.name)) {
+    if (route.name && this.#filter(route)) {
       debug('route skipped route: %O, rules: %O', route, this.rules)
       return
     }

src/types/code_scanners.ts

@@ -197,6 +197,12 @@ export type RoutesListItem = {
   tokens: { val: string; old: string; type: 0 | 1 | 2 | 3; end: string }[]
 }
 
+/**
+ * The filter fn to exclude routes from being processed. Return true
+ * to filter out (aka exclude) the route
+ */
+export type RoutesScannerFilterFn = (route: RoutesListItem) => boolean
+
 /**
  * Configuration rules accepted by the routes scanner to customize
  * the scanning behavior and override type inference.
@@ -219,12 +225,6 @@ export type RoutesListItem = {
  * }
  */
 export type RoutesScannerRules = {
-  /**
-   * An array of route names or controller+method paths to skip from processing.
-   * Useful for excluding routes that don't need type generation.
-   */
-  skip: string[]
-
   /**
    * Define custom response types for specific routes by their name
    * or controller+method path. Overrides automatic type inference.