feat: add options.ignore

Author: caoxiemeihao

src/index.ts

@@ -11,7 +11,6 @@ import type { NodeLoaderOptions, WebpackAssetRelocatorLoader } from './types'
 import { COLOURS } from 'vite-plugin-utils/function'
 import {
   type NativeRecord,
-  type NativeRecordType,
   createCjs,
   ensureDir,
   getInteropSnippet,
@@ -22,8 +21,13 @@ import {
 export interface NativeOptions {
   /** @default 'node_natives' */
   assetsDir?: string
-  /** By default native modules are automatically detected if this option is not explicitly configure by the user. */
+  /** 
+   * By default native modules are automatically detected if this option is not explicitly configure by the user.
+   * @deprecated use `ignore` option instead
+   */
   natives?: string[] | ((natives: string[]) => string[])
+  /** Ignore the specified native module. */
+  ignore?: (name: string) => boolean | undefined
   /** Enable and configure webpack. */
   webpack?: {
     config?: (config: Configuration) => Configuration | undefined | Promise<Configuration | undefined>
@@ -44,8 +48,7 @@ const nativesMap = new Map<string, {
   status: 'built' | 'resolved'
   nativeFilename: string
   interopFilename: string
-  type: NativeRecordType
-  nodeFiles: string[]
+  native: NativeRecord
 }>
 
 export default function native(options: NativeOptions): Plugin {
@@ -61,21 +64,16 @@ export default function native(options: NativeOptions): Plugin {
       const outDir = config.build?.outDir ?? 'dist'
       output = normalizePath(path.join(resolvedRoot, outDir, assetsDir))
 
-      const depsNativeRecord = await getDependenciesNatives(resolvedRoot)
-      const depsNatives = [...depsNativeRecord.keys()]
+      let nativeRecord = await getDependenciesNatives(resolvedRoot)
 
       if (options.natives) {
         const natives = Array.isArray(options.natives)
           ? options.natives
-          : options.natives(depsNatives)
+          : options.natives([...nativeRecord.keys()])
         // TODO: bundle modules based on `natives`.
       }
 
       const withDistAssetBase = (p: string) => (assetsDir && p) ? `${assetsDir}/${p}` : p
-
-      let detectedNativeRecord: NativeRecord = new Map
-      let detectedNatives: string[] = []
-
       const alias: Alias = {
         find: /(.*)/,
         // Keep `customResolver` receive original source.
@@ -85,54 +83,51 @@ export default function native(options: NativeOptions): Plugin {
           if (!importer) return
           if (!bareImportRE.test(source)) return
 
-          if (!depsNativeRecord.has(source)) {
-            // Auto detection.
+          if (!nativeRecord.has(source)) {
+            // Dynamic deep detection.
             // e.g. serialport -> @serialport/bindings-cpp
-            const nativeRecord = await resolveNativeRecord(source, importer)
-            if (nativeRecord) {
-              detectedNativeRecord = new Map([...detectedNativeRecord, ...nativeRecord])
-              detectedNatives = [...depsNativeRecord.keys()]
-            }
+            nativeRecord = new Map([...nativeRecord, ...(await resolveNativeRecord(source, importer) ?? [])])
           }
 
-          if ([...depsNatives, ...detectedNatives].includes(source)) {
-            const nativeFilename = path.join(output, source + NativeExt)
-            const interopFilename = path.join(output, source + InteropExt)
+          const nativeItem = nativeRecord.get(source)
+          if (!nativeItem) return
 
-            if (!nativesMap.get(source)) {
-              ensureDir(output)
+          if (options.ignore?.(source) === false) {
+            nativeItem.ignore = true
+            return
+          }
 
-              // Generate Vite and Webpack interop file.
-              fs.writeFileSync(
-                interopFilename,
-                getInteropSnippet(source, `./${withDistAssetBase(source + NativeExt)}`),
-              )
+          const nativeFilename = path.join(output, source + NativeExt)
+          const interopFilename = path.join(output, source + InteropExt)
 
-              // We did not immediately call the `webpackBundle()` build here 
-              // because `build.emptyOutDir = true` will cause the built file to be removed.
+          if (!nativesMap.get(source)) {
+            ensureDir(output)
 
-              const isDetected = detectedNativeRecord.has(source)
+            // Generate Vite and Webpack interop file.
+            fs.writeFileSync(
+              interopFilename,
+              getInteropSnippet(source, `./${withDistAssetBase(source + NativeExt)}`),
+            )
 
-              // Collect modules that are explicitly used.
-              nativesMap.set(source, {
-                status: 'resolved',
-                nativeFilename,
-                interopFilename,
-                type: isDetected ? 'detected' : 'dependencies',
-                nodeFiles: isDetected
-                  ? detectedNativeRecord.get(source)?.nativeFiles!
-                  : depsNativeRecord.get(source)?.nativeFiles!,
-              })
-            }
+            // We did not immediately call the `webpackBundle()` build here 
+            // because `build.emptyOutDir = true` will cause the built file to be removed.
 
-            return { id: interopFilename }
+            // Collect modules that are explicitly used.
+            nativesMap.set(source, {
+              status: 'resolved',
+              nativeFilename,
+              interopFilename,
+              native: nativeItem,
+            })
           }
+
+          return { id: interopFilename }
         },
       }
 
       modifyAlias(config, [alias])
       // Run build are not necessary.
-      modifyOptimizeDeps(config, [...depsNatives, ...detectedNatives])
+      modifyOptimizeDeps(config, [...nativeRecord.keys()])
     },
     async buildEnd(error) {
       if (error) return
@@ -258,3 +253,7 @@ async function webpackBundle(
     })
   })
 }
+
+async function ensureNodeFiles() {
+
+}

src/utils.ts

@@ -6,12 +6,12 @@ import glob from 'fast-glob'
 import _libEsm from 'lib-esm'
 import { node_modules as findNodeModules } from 'vite-plugin-utils/function'
 
-export type NativeRecordType = 'dependencies' | 'detected'
-export type NativeRecord = Map<string, {
-  type: NativeRecordType
+export interface NativeRecord {
+  type: 'dependencies' | 'detected'
   path: string
   nativeFiles: string[]
-}>
+  ignore?: true
+}
 
 // @ts-ignore
 const libEsm: typeof import('lib-esm').default = _libEsm.default || _libEsm
@@ -39,10 +39,10 @@ export async function globNativeFiles(cwd: string) {
   return nativeFiles
 }
 
-export async function getDependenciesNatives(root = process.cwd()): Promise<NativeRecord> {
+export async function getDependenciesNatives(root = process.cwd()): Promise<Map<string, NativeRecord>> {
   const node_modules_paths = findNodeModules(root)
   // Native modules of package.json
-  const natives: NativeRecord = new Map
+  const natives = new Map<string, NativeRecord>
 
   for (const node_modules_path of node_modules_paths) {
     const pkgId = path.join(node_modules_path, '../package.json')
@@ -52,6 +52,8 @@ export async function getDependenciesNatives(root = process.cwd()): Promise<Nati
       const deps = Object.keys(pkg.dependencies || {}).concat(Object.keys(pkg.devDependencies || {}))
 
       for (const dep of deps) {
+        if (natives.has(dep)) continue
+
         const depPath = path.join(node_modules_path, dep)
         const nativeFiles = await globNativeFiles(depPath)
 
@@ -90,7 +92,7 @@ export function ensureDir(dir: string) {
   return dir
 }
 
-export async function resolveNativeRecord(source: string, importer: string): Promise<NativeRecord | undefined> {
+export async function resolveNativeRecord(source: string, importer: string): Promise<Map<string, NativeRecord> | undefined> {
   let modulePath: string | undefined
   try {
     const modulePackageJson = cjs.require.resolve(`${source}/package.json`, {
@@ -100,11 +102,11 @@ export async function resolveNativeRecord(source: string, importer: string): Pro
   } catch { }
 
   if (modulePath) {
-    const nodeFiles = await globNativeFiles(modulePath)
-    return new Map().set(source, {
-      type: 'deep-dependencies',
+    const nativeFiles = await globNativeFiles(modulePath)
+    return new Map<string, NativeRecord>().set(source, {
+      type: 'detected',
       path: modulePath,
-      nodeFiles,
+      nativeFiles,
     })
   }
 }