Make node: protocol imports configurable

Author: davidmyersdev

README.md

@@ -1,6 +1,6 @@
 # vite-plugin-node-polyfills
 
-A Vite plugin to polyfill Node's Core Modules for browser environments. Supports `node:` protocol imports.
+A Vite plugin to polyfill Node's Core Modules for browser environments. Supports [`node:` protocol imports](https://nodejs.org/dist/latest-v16.x/docs/api/esm.html#node-imports).
 
 ### Why do I need this?
 
@@ -34,7 +34,10 @@ import { nodePolyfills } from 'vite-plugin-node-polyfills'
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [
-    nodePolyfills(),
+    nodePolyfills({
+      // Whether to polyfill `node:` protocol imports.
+      protocolImports: true,
+    }),
   ],
 })
 ```

src/env.d.ts

@@ -2,7 +2,7 @@ declare module 'node-stdlib-browser/helpers/esbuild/plugin' {
   import { Plugin } from 'esbuild'
   import stdLibBrowser from 'node-stdlib-browser'
 
-  export default function(options: typeof stdLibBrowser): Plugin
+  export default function(options: Record<string, string>): Plugin
 }
 
 declare module 'node-stdlib-browser/helpers/rollup/plugin' {

src/index.ts

@@ -5,13 +5,56 @@ import { handleCircularDependancyWarning } from 'node-stdlib-browser/helpers/rol
 import esbuildPlugin from 'node-stdlib-browser/helpers/esbuild/plugin'
 import type { Plugin } from 'vite'
 
-export const nodePolyfills = (_options = {}): Plugin => {
+interface PolyfillOptions {
+  protocolImports: boolean
+}
+
+/**
+ * Returns a Vite plugin to polyfill Node's Core Modules for browser environments. Supports `node:` protocol imports.
+ *
+ * @example Use it in `vite.config.ts`
+ *
+ * ```ts
+ * // vite.config.ts
+ * import { defineConfig } from 'vite'
+ * import { nodePolyfills } from 'vite-plugin-node-polyfills'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     nodePolyfills({
+ *       // Whether to polyfill `node:` protocol imports.
+ *       protocolImports: true,
+ *     }),
+ *   ],
+ * })
+ * ```
+ */
+export const nodePolyfills = (options: Partial<PolyfillOptions> = {}): Plugin => {
   const require = createRequire(import.meta.url)
   const globalShims = require.resolve('node-stdlib-browser/helpers/esbuild/shim')
+  const optionsResolved: PolyfillOptions = {
+    protocolImports: true,
+    // User options take priority.
+    ...options,
+  }
 
   return {
     name: 'vite-plugin-node-polyfills',
     config: (_config, _env) => {
+      const polyfills = Object.entries(stdLibBrowser).reduce((included: Record<string, string>, [name, value]) => {
+        if (!optionsResolved.protocolImports) {
+          const isProtocolImport = /^node:/.test(name)
+
+          if (isProtocolImport) {
+            return included
+          }
+        }
+
+        included[name] = value
+
+        return included
+      }, {})
+
       return {
         build: {
           rollupOptions: {
@@ -41,14 +84,14 @@ export const nodePolyfills = (_options = {}): Plugin => {
               globalShims,
             ],
             plugins: [
-              esbuildPlugin(stdLibBrowser),
+              esbuildPlugin(polyfills),
             ],
           },
         },
         resolve: {
           // https://github.com/niksy/node-stdlib-browser/blob/3e7cd7f3d115ac5c4593b550e7d8c4a82a0d4ac4/README.md?plain=1#L150
           alias: {
-            ...stdLibBrowser,
+            ...polyfills,
           },
         },
       }

test/src/main.ts

@@ -1,3 +1,3 @@
-import { resolve } from 'path'
+import { resolve } from 'node:path'
 
 console.log(resolve('.'))

test/vite.config.ts

@@ -5,7 +5,9 @@ import { nodePolyfills } from 'vite-plugin-node-polyfills'
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [
-    nodePolyfills(),
+    nodePolyfills({
+      protocolImports: true,
+    }),
   ],
   root: resolve(__dirname),
 })