Add matchFilter and ignoreFilter

README.md

@@ -109,8 +109,27 @@ Autoload can be customised using the following options:
   })
   ```
 
+- `matchFilter` (optional) - Filter matching any path that should be loaded. Can be a RegExp, a string or a function returning a boolean.
+
+  ```js
+  fastify.register(autoLoad, {
+    dir: path.join(__dirname, 'plugins'),
+    matchFilter: (path) => path.split("/").at(-2) === "handlers"
+  })
+  ```
+
+
+- `ignoreFilter` (optional) - Filter matching any path that should not be loaded. Can be a RegExp, a string or a function returning a boolean.
+
+  ```js
+  fastify.register(autoLoad, {
+    dir: path.join(__dirname, 'plugins'),
+    ignoreFilter: (path) => path.endsWith('.spec.js')
+  })
+  ```
 
-- `ignorePattern` (optional) - Regex matching any file that should not be loaded
+
+- `ignorePattern` (optional) - RegExp matching any file or folder that should not be loaded.
 
   ```js
   fastify.register(autoLoad, {
@@ -119,6 +138,7 @@ Autoload can be customised using the following options:
   })
   ```
 
+
 - `indexPattern` (optional) - Regex to override the `index.js` naming convention
 
   ```js

index.js

@@ -129,7 +129,7 @@ function getScriptType (fname, packageType) {
 
 // eslint-disable-next-line default-param-last
 async function findPlugins (dir, options, hookedAccumulator = {}, prefix, depth = 0, hooks = []) {
-  const { indexPattern, ignorePattern, scriptPattern, dirNameRoutePrefix, maxDepth, autoHooksPattern } = options
+  const { indexPattern, ignorePattern, ignoreFilter, matchFilter, scriptPattern, dirNameRoutePrefix, maxDepth, autoHooksPattern } = options
   const list = await readdir(dir, { withFileTypes: true })
   let currentHooks = []
 
@@ -171,7 +171,7 @@ async function findPlugins (dir, options, hookedAccumulator = {}, prefix, depth
       throw new Error(`@fastify/autoload cannot import hooks plugin at '${file}'. To fix this error compile TypeScript to JavaScript or use 'ts-node' to run your app.`)
     }
 
-    hookedAccumulator[prefix || '/'].plugins.push({ file, type, prefix })
+    accumulatePlugin({ file, type }, indexDirent.name)
     const hasDirectory = list.find((dirent) => dirent.isDirectory())
 
     if (!hasDirectory) {
@@ -226,13 +226,27 @@ async function findPlugins (dir, options, hookedAccumulator = {}, prefix, depth
 
       // Don't place hook in plugin queue
       if (!autoHooksPattern.test(dirent.name)) {
-        hookedAccumulator[prefix || '/'].plugins.push({ file, type, prefix })
+        accumulatePlugin({ file, type }, dirent.name)
       }
     }
   }
   await Promise.all(directoryPromises)
 
   return hookedAccumulator
+
+  function accumulatePlugin ({ file, type }, direntName = 'index.ts') {
+    const routePath = `${prefix ?? ''}/${direntName}`
+
+    if (matchFilter && !filterPath(routePath, matchFilter)) {
+      return
+    }
+
+    if (ignoreFilter && filterPath(routePath, ignoreFilter)) {
+      return
+    }
+
+    hookedAccumulator[prefix || '/'].plugins.push({ file, type, prefix })
+  }
 }
 
 async function loadPlugin ({ file, type, directoryPrefix, options, log }) {
@@ -315,6 +329,18 @@ function registerPlugin (fastify, meta, allPlugins, parentPlugins = {}) {
   meta.registered = true
 }
 
+function filterPath (path, filter) {
+  if (typeof filter === 'string') {
+    return path.includes(filter)
+  }
+
+  if (filter instanceof RegExp) {
+    return filter.test(path)
+  }
+
+  return filter(path)
+}
+
 /**
  * Used to determine if the contents of a required autoloaded file matches
  * the shape of a Fastify route configuration object.

package.json

@@ -17,6 +17,7 @@
     "typescript:tsx": "node scripts/unit-typescript-tsx.js",
     "typescript:esbuild": "node scripts/unit-typescript-esbuild.js",
     "typescript:vitest": "vitest run",
+    "typescript:vitest:dev": "vitest",
     "unit": "node scripts/unit.js",
     "unit:with-modules": "tap test/commonjs/*.js test/module/*.js test/typescript/*.ts"
   },

test/commonjs/ts-node/routes/bar/index.ts

@@ -0,0 +1,5 @@
+module.exports.default = async (fastify: any) => {
+  fastify.get("/", function () {
+    return { foo: "bar" };
+  })
+};

test/commonjs/ts-node/routes/foo/baz/index.ts

@@ -0,0 +1,5 @@
+module.exports.default = async (fastify: any) => {
+  fastify.get("/", function () {
+    return { foo: "bar" };
+  })
+};

test/vitest/filter.test.ts

@@ -0,0 +1,86 @@
+'use strict'
+
+import { describe, test, expect } from 'vitest'
+import Fastify from 'fastify'
+import AutoLoad from '../../index'
+import { join } from 'path'
+
+describe.concurrent("Vitest ignore filters test suite", function () {
+  const app = Fastify()
+    app.register(AutoLoad, {
+      dir: join(__dirname, '../commonjs/ts-node/routes'),
+      ignoreFilter: "foo"
+    })
+
+  test("Test the root route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/'
+    })
+    expect(response.statusCode).toEqual(200)
+  })
+
+  test("Test /foo route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/foo'
+    })
+    expect(response.statusCode).toBe(404)
+  })
+
+  test("Test /bar route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/bar'
+    })
+    expect(response.statusCode).toBe(200)
+  })
+
+  test("Test /baz route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/foo/baz'
+    })
+    expect(response.statusCode).toBe(404)
+  })
+})
+
+describe.concurrent("Vitest match filters test suite", function () {
+  const app = Fastify()
+  app.register(AutoLoad, {
+    dir: join(__dirname, '../commonjs/ts-node/routes'),
+    matchFilter: "/foo"
+  })
+
+  test("Test the root route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/'
+    })
+    expect(response.statusCode).toEqual(404)
+  })
+
+  test("Test /foo route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/foo'
+    })
+    expect(response.statusCode).toBe(200)
+  })
+
+  test("Test /bar route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/bar'
+    })
+    expect(response.statusCode).toBe(404)
+  })
+
+  test("Test /baz route", async function () {
+    const response = await app.inject({
+      method: 'GET',
+      url: '/foo/baz'
+    })
+    expect(response.statusCode).toBe(200)
+  })
+})

types/index.d.ts

@@ -4,10 +4,13 @@ type FastifyAutoloadPlugin = FastifyPluginCallback<NonNullable<fastifyAutoload.A
 
 declare namespace fastifyAutoload {
   type RewritePrefix = (folderParent: string, folderName: string) => string | boolean
+  type Filter = string | RegExp | ((value: {file: string; path: string}) => boolean)
 
   export interface AutoloadPluginOptions {
     dir: string
     dirNameRoutePrefix?: boolean | RewritePrefix
+    ignoreFilter?: Filter
+    matchFilter?: Filter
     ignorePattern?: RegExp
     scriptPattern?: RegExp
     indexPattern?: RegExp

types/index.test-d.ts

@@ -61,11 +61,29 @@ const opt8: AutoloadPluginOptions = {
   dir: 'test',
   encapsulate: false,
 }
+const opt9: AutoloadPluginOptions = {
+  dir: 'test',
+  ignoreFilter: /test/,
+  matchFilter: /handler/
+}
+const opt10: AutoloadPluginOptions = {
+  dir: 'test',
+  ignoreFilter: 'test',
+  matchFilter: 'handler'
+}
+const opt11: AutoloadPluginOptions = {
+  dir: 'test',
+  ignoreFilter: ({file}) => file.endsWith('.spec.ts'),
+  matchFilter: ({path}) => path.split("/").at(-2) === 'handlers'
+}
 app.register(fastifyAutoloadDefault, opt1)
 app.register(fastifyAutoloadDefault, opt2)
 app.register(fastifyAutoloadDefault, opt3)
 app.register(fastifyAutoloadDefault, opt4)
 app.register(fastifyAutoloadDefault, opt5)
 app.register(fastifyAutoloadDefault, opt6)
 app.register(fastifyAutoloadDefault, opt7)
-app.register(fastifyAutoloadDefault, opt8)
+app.register(fastifyAutoloadDefault, opt8)
+app.register(fastifyAutoloadDefault, opt9)
+app.register(fastifyAutoloadDefault, opt10)
+app.register(fastifyAutoloadDefault, opt11)