fix: disallow string filters for resolveId

Author: sxzz

docs/guide/index.md

@@ -294,6 +294,8 @@ export const bunPlugin = unplugin.bun
 To optimize performance in native bundlers, leverage the `filter` option in `resolveId`, `transform`, and `load`
 hooks to exclude files that don’t require processing.
 
+`resolveId.filter.id` only accepts a `RegExp`.
+
 ```ts twoslash
 import { createUnplugin } from 'unplugin'
 

src/rollup/index.ts

@@ -29,7 +29,7 @@ export function toRollupPlugin(
     && (!nativeFilter && typeof plugin.resolveId === 'object' && plugin.resolveId.filter)
   ) {
     const resolveIdHook = plugin.resolveId
-    const { handler, filter } = normalizeObjectHook('load', resolveIdHook)
+    const { handler, filter } = normalizeObjectHook('resolveId', resolveIdHook)
 
     replaceHookHandler('resolveId', resolveIdHook, function (...args) {
       const [id] = args

src/types.ts

@@ -71,19 +71,24 @@ export type FilterPattern = Arrayable<StringOrRegExp>
 export type StringFilter
   = | FilterPattern
     | { include?: FilterPattern | undefined, exclude?: FilterPattern | undefined }
-export interface HookFilter {
+
+export interface ResolveIdHookFilter {
+  id?: RegExp | undefined
+}
+
+export interface LoadHookFilter {
   id?: StringFilter | undefined
+}
+
+export interface TransformHookFilter extends LoadHookFilter {
   code?: StringFilter | undefined
 }
 
-export interface ObjectHook<T extends HookFnMap[keyof HookFnMap], F extends keyof HookFilter> {
-  filter?: Pick<HookFilter, F> | undefined
+export interface ObjectHook<T extends HookFnMap[keyof HookFnMap], F> {
+  filter?: F | undefined
   handler: T
 }
-export type Hook<
-  T extends HookFnMap[keyof HookFnMap],
-  F extends keyof HookFilter,
-> = T | ObjectHook<T, F>
+export type Hook<T extends HookFnMap[keyof HookFnMap], F> = T | ObjectHook<T, F>
 
 export interface HookFnMap {
   // Build Hooks
@@ -109,9 +114,9 @@ export interface UnpluginOptions {
 
   buildStart?: HookFnMap['buildStart'] | undefined
   buildEnd?: HookFnMap['buildEnd'] | undefined
-  transform?: Hook<HookFnMap['transform'], 'code' | 'id'> | undefined
-  load?: Hook<HookFnMap['load'], 'id'> | undefined
-  resolveId?: Hook<HookFnMap['resolveId'], 'id'> | undefined
+  transform?: Hook<HookFnMap['transform'], TransformHookFilter> | undefined
+  load?: Hook<HookFnMap['load'], LoadHookFilter> | undefined
+  resolveId?: Hook<HookFnMap['resolveId'], ResolveIdHookFilter> | undefined
   writeBundle?: HookFnMap['writeBundle'] | undefined
 
   watchChange?: ((this: UnpluginBuildContext, id: string, change: { event: 'create' | 'update' | 'delete' }) => void) | undefined

src/utils/filter.ts

@@ -1,4 +1,11 @@
-import type { Hook, HookFilter, StringFilter, StringOrRegExp } from '../types'
+import type {
+  Hook,
+  TransformHookFilter as HookFilter,
+  LoadHookFilter,
+  ResolveIdHookFilter,
+  StringFilter,
+  StringOrRegExp,
+} from '../types'
 import { resolve } from 'node:path'
 import picomatch from 'picomatch'
 import { toArray } from './general'
@@ -142,17 +149,21 @@ function createFilterForTransform(
   }
 }
 
-export function normalizeObjectHook<T extends (...args: any[]) => any, F extends keyof HookFilter>(
-  name: 'resolveId' | 'load',
-  hook: Hook<T, F>,
+export function normalizeObjectHook<T extends (...args: any[]) => any>(
+  name: 'resolveId',
+  hook: Hook<T, ResolveIdHookFilter>,
 ): { handler: T, filter: PluginFilter }
-export function normalizeObjectHook<T extends (...args: any[]) => any, F extends keyof HookFilter>(
+export function normalizeObjectHook<T extends (...args: any[]) => any>(
+  name: 'load',
+  hook: Hook<T, LoadHookFilter>,
+): { handler: T, filter: PluginFilter }
+export function normalizeObjectHook<T extends (...args: any[]) => any>(
   name: 'transform',
-  hook: Hook<T, F>,
+  hook: Hook<T, HookFilter>,
 ): { handler: T, filter: TransformHookFilter }
-export function normalizeObjectHook<T extends (...args: any[]) => any, F extends keyof HookFilter>(
+export function normalizeObjectHook<T extends (...args: any[]) => any>(
   name: 'resolveId' | 'load' | 'transform',
-  hook: Hook<T, F>,
+  hook: Hook<T, ResolveIdHookFilter | LoadHookFilter | HookFilter>,
 ): {
   handler: T
   filter: PluginFilter | TransformHookFilter
@@ -165,12 +176,13 @@ export function normalizeObjectHook<T extends (...args: any[]) => any, F extends
   }
   else {
     handler = hook.handler
-    const hookFilter = hook.filter as HookFilter | undefined
+    const hookFilter = hook.filter
     if (name === 'resolveId' || name === 'load') {
       filter = createFilterForId(hookFilter?.id)
     }
     else {
-      filter = createFilterForTransform(hookFilter?.id, hookFilter?.code)
+      const transformFilter = hookFilter as HookFilter | undefined
+      filter = createFilterForTransform(transformFilter?.id, transformFilter?.code)
     }
   }
 

test/unit-tests/filter/filter.test.ts

@@ -19,15 +19,25 @@ function createUnpluginWithHooks(
   }))
 }
 
-function createIdHook() {
+function createResolveIdHook() {
   const handler = vi.fn()
   return {
     hook: {
       filter: {
-        id: {
-          include: [/\.js$/],
-          exclude: [/entry.js$/, /not-expect/],
-        },
+        id: /^(?!.*(?:entry\.js|not-expect)).*\.js$/,
+      },
+      handler,
+    },
+    handler,
+  }
+}
+
+function createLoadHook() {
+  const handler = vi.fn()
+  return {
+    hook: {
+      filter: {
+        id: '**/mod.js',
       },
       handler,
     },
@@ -72,8 +82,8 @@ describe('filter', () => {
   })
 
   it('vite', async () => {
-    const { hook: resolveId, handler: resolveIdHandler } = createIdHook()
-    const { hook: load, handler: loadHandler } = createIdHook()
+    const { hook: resolveId, handler: resolveIdHandler } = createResolveIdHook()
+    const { hook: load, handler: loadHandler } = createLoadHook()
     const { hook: transform, handler: transformHandler } = createTransformHook()
     const plugin = createUnpluginWithHooks(resolveId, load, transform).vite
     // we need to define `enforce` here for the plugin to be run
@@ -96,8 +106,8 @@ describe('filter', () => {
   })
 
   it('rollup', async () => {
-    const { hook: resolveId, handler: resolveIdHandler } = createIdHook()
-    const { hook: load, handler: loadHandler } = createIdHook()
+    const { hook: resolveId, handler: resolveIdHandler } = createResolveIdHook()
+    const { hook: load, handler: loadHandler } = createLoadHook()
     const { hook: transform, handler: transformHandler } = createTransformHook()
     const plugin = createUnpluginWithHooks(resolveId, load, transform).rollup
 
@@ -110,8 +120,8 @@ describe('filter', () => {
   })
 
   it('rolldown', async () => {
-    const { hook: resolveId, handler: resolveIdHandler } = createIdHook()
-    const { hook: load, handler: loadHandler } = createIdHook()
+    const { hook: resolveId, handler: resolveIdHandler } = createResolveIdHook()
+    const { hook: load, handler: loadHandler } = createLoadHook()
     const { hook: transform, handler: transformHandler } = createTransformHook()
     const plugin = createUnpluginWithHooks(resolveId, load, transform).rolldown
 
@@ -124,8 +134,8 @@ describe('filter', () => {
   })
 
   it('webpack', async () => {
-    const { hook: resolveId, handler: resolveIdHandler } = createIdHook()
-    const { hook: load, handler: loadHandler } = createIdHook()
+    const { hook: resolveId, handler: resolveIdHandler } = createResolveIdHook()
+    const { hook: load, handler: loadHandler } = createLoadHook()
     const { hook: transform, handler: transformHandler } = createTransformHook()
     const plugin = createUnpluginWithHooks(resolveId, load, transform).webpack
 
@@ -143,8 +153,8 @@ describe('filter', () => {
   })
 
   it('rspack', async () => {
-    const { hook: resolveId, handler: resolveIdHandler } = createIdHook()
-    const { hook: load, handler: loadHandler } = createIdHook()
+    const { hook: resolveId, handler: resolveIdHandler } = createResolveIdHook()
+    const { hook: load, handler: loadHandler } = createLoadHook()
     const { hook: transform, handler: transformHandler } = createTransformHook()
     const plugin = createUnpluginWithHooks(resolveId, load, transform).rspack
 
@@ -162,8 +172,8 @@ describe('filter', () => {
   })
 
   it('esbuild', async () => {
-    const { hook: resolveId, handler: resolveIdHandler } = createIdHook()
-    const { hook: load, handler: loadHandler } = createIdHook()
+    const { hook: resolveId, handler: resolveIdHandler } = createResolveIdHook()
+    const { hook: load, handler: loadHandler } = createLoadHook()
     const { hook: transform, handler: transformHandler } = createTransformHook()
     const plugin = createUnpluginWithHooks(resolveId, load, transform).esbuild
 
@@ -178,8 +188,8 @@ describe('filter', () => {
   })
 
   onlyBun('bun', async () => {
-    const { hook: resolveId, handler: resolveIdHandler } = createIdHook()
-    const { hook: load, handler: loadHandler } = createIdHook()
+    const { hook: resolveId, handler: resolveIdHandler } = createResolveIdHook()
+    const { hook: load, handler: loadHandler } = createLoadHook()
     const { hook: transform, handler: transformHandler } = createTransformHook()
     const plugin = createUnpluginWithHooks(resolveId, load, transform).bun