Add ignore option to builtinsPrefix setting

Septh · Septh · commit 20f7ed24b66c · 2023-05-07T20:07:11.000+02:00
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ export default {
       builtins?: boolean
 
       // node: prefix handing for importing Node builtins. Default: 'add'.
-      builtinsPrefix?: 'add' | 'strip'
+      builtinsPrefix?: 'add' | 'strip' | 'ignore'
 
       // The path(s) to your package.json. See below for default.
       packagePath?: string | string[]
@@ -83,10 +83,11 @@ export default {
 #### builtins?: boolean = true
 Set the `builtins` option to `false` if you'd like to use some shims/polyfills for those. You'll most certainly need [an other plugin](https://github.com/ionic-team/rollup-plugin-node-polyfills) for this.
 
-#### builtinsPrefix?: 'add' | 'strip' = 'add'
+#### builtinsPrefix?: 'add' | 'strip' | 'ignore' = 'add'
 How to handle the `node:` scheme used in recent versions of Node (i.e., `import path from 'node:path'`).<br>
 - If `add` (the default), the `node:` prefix is always added. In effect, this homogenizes all your imports of node builtins to their prefixed version.
 - If `strip` (the default), the import is always resolved unprefixed. In effect, this homogenizes all your imports of node builtins to their unprefixed version.
+- `ignore` will simply leave all prefixes as written in your code.
 > _Note that prefix handling is independant of the `builtins` options being enabled or disabled._
 
 #### packagePath?: string | string[] = []
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/index.ts b/src/index.ts
@@ -19,10 +19,11 @@ export interface ExternalsOptions {
      * node: prefix handing for importing Node builtins:
      * - `'add'`    turns `'path'` to `'node:path'`
      * - `'strip'`  turns `'node:path'` to `'path'`
+     * - `'ignore'` leave Node builtin names as-is
      *
      * Defaults to `add`.
      */
-    builtinsPrefix?: 'add' | 'strip'
+    builtinsPrefix?: 'add' | 'strip' | 'ignore'
 
     /**
      * Path/to/your/package.json file (or array of paths).
@@ -140,7 +141,7 @@ function externals(options: ExternalsOptions = {}): Plugin {
         async buildStart() {
             // Map the include and exclude options to arrays of regexes.
             [ include, exclude ] = ([ 'include', 'exclude' ] as const).map(option =>
-                ([] as (string | RegExp | null | undefined | false)[])
+                ([] as Array<string | RegExp | null | undefined | false>)
                     .concat(config[option])
                     .reduce((result, entry, index) => {
                         if (entry) {
@@ -192,7 +193,7 @@ function externals(options: ExternalsOptions = {}): Plugin {
                 try {
                     const json = (await fs.readFile(packageFile)).toString()
                     try {
-                        const pkg = JSON.parse(json) as PackageJson
+                        const pkg: PackageJson = JSON.parse(json)
                         Object.assign(dependencies,
                             config.deps     ? pkg.dependencies         : undefined,
                             config.devDeps  ? pkg.devDependencies      : undefined,
@@ -229,23 +230,25 @@ function externals(options: ExternalsOptions = {}): Plugin {
         },
 
         async resolveId(id) {
-            // Ignore virtual modules and already resolved ids.
-            if (id.charCodeAt(0) === 0 || path.isAbsolute(id))
+            // Let Rollup handle already resolved ids, relative imports and virtual modules.
+            if (path.isAbsolute(id) || /^(?:\0|\.{1,2}[\\/])/.test(id))
                 return null
 
             // Handle node builtins.
             if (id.startsWith(nodePrefix) || builtins.all.has(id)) {
                 const stripped = id.replace(nodePrefixRx, '')
                 return {
-                    id: config.builtinsPrefix === 'add' || builtins.alwaysPrefixed.has(id)
-                        ? nodePrefix + stripped
-                        : stripped,
-                    external: (config.builtins || isIncluded(id)) && !isExcluded(id),
+                    id: config.builtinsPrefix === 'ignore'
+                        ? id
+                        : config.builtinsPrefix === 'add' || builtins.alwaysPrefixed.has(id)
+                            ? nodePrefix + stripped
+                            : stripped,
+                    external: config.builtins && !isExcluded(id),
                     moduleSideEffects: false
                 }
             }
 
-            // Handle other imports.
+            // Handle npm dependencies.
             return isIncluded(id) && !isExcluded(id)
                 ? false     // external
                 : null      // normal handling
diff --git a/test/_common.ts b/test/_common.ts
@@ -25,6 +25,16 @@ type ImplementedHooks =
     | 'buildStart'
     | 'resolveId'
 
+// This config makes for empty include[] and exclude[] patterns.
+export const noDepsAtAllOptions: ExternalsOptions = {
+    packagePath: path.join(__dirname, 'fixtures/no-deps.package.json'),
+    builtins: false,
+    deps: false,
+    devDeps: false,
+    optDeps: false,
+    peerDeps: false
+}
+
 export async function callHook(plugin: Plugin, hookName: ImplementedHooks, ...args: any[]) {
     const hook = plugin[hookName] as ObjectHook<(this: typeof fakePluginContext, ...args: any) => any>
     if (typeof hook === 'function')
diff --git a/test/builtins.test.ts b/test/builtins.test.ts
@@ -22,3 +22,17 @@ test("Removes 'node:' prefix when using builtinsPrefix='strip'", async t => {
         })
     }
 })
+
+test("Ignores 'node:' prefix when using builtinsPrefix='ignore'", async t => {
+    const { plugin } = await initPlugin({
+        builtinsPrefix: 'ignore'
+    })
+    t.like(await callHook(plugin, 'resolveId', 'node:path'), {
+        id: 'node:path',
+        external: true
+    })
+    t.like(await callHook(plugin, 'resolveId', 'path'), {
+        id: 'path',
+        external: true
+    })
+})
diff --git a/test/fixtures/no-deps.package.json b/test/fixtures/no-deps.package.json
@@ -0,0 +1,3 @@
+{
+  "workspaces": []
+}
diff --git a/test/relative.test.ts b/test/relative.test.ts
diff --git a/test/specifier.test.ts b/test/specifier.test.ts
@@ -0,0 +1,63 @@
+import test from 'ava'
+import { initPlugin, callHook, noDepsAtAllOptions } from './_common'
+
+test("Does NOT filter out relative specifiers by default", async t => {
+    const relativeSpecifiers = [ './sibling.js', '../parent.js' ]
+    const { plugin } = await initPlugin(noDepsAtAllOptions)
+    for (const specifier of relativeSpecifiers) {
+        t.is(await callHook(plugin, 'resolveId', specifier), null, `Failed id: ${specifier}`)
+    }
+})
+
+test("Does NOT filter out relative specifiers, even when asked to", async t => {
+    const relativeSpecifiers = [ './sibling.js', '../parent.js' ]
+    const { plugin } = await initPlugin({
+        ...noDepsAtAllOptions,
+        include: relativeSpecifiers
+    })
+    for (const specifier of relativeSpecifiers) {
+        t.is(await callHook(plugin, 'resolveId', specifier), null, `Failed id: ${specifier}`)
+    }
+})
+
+test("Does NOT filter out absolute specifiers by default", async t => {
+    const absoluteSpecifiers = [ '/root.js' ]
+    if (process.platform === 'win32')
+        absoluteSpecifiers.push('\\root.js', 'C:\\root.js')
+    const { plugin } = await initPlugin(noDepsAtAllOptions)
+    for (const specifier of absoluteSpecifiers) {
+        t.is(await callHook(plugin, 'resolveId', specifier), null, `Failed id: ${specifier}`)
+    }
+})
+
+test("Does NOT filter out absolute specifiers, even when asked to", async t => {
+    const absoluteSpecifiers = [ '/root.js' ]
+    if (process.platform === 'win32')
+        absoluteSpecifiers.push('\\root.js', 'C:\\root.js')
+    const { plugin } = await initPlugin({
+        ...noDepsAtAllOptions,
+        include: absoluteSpecifiers
+    })
+    for (const specifier of absoluteSpecifiers) {
+        t.is(await callHook(plugin, 'resolveId', specifier), null, `Failed id: ${specifier}`)
+    }
+})
+
+test("Does NOT filter out bare specifiers by default", async t => {
+    const bareSpecifiers = [ 'dependency' ]
+    const { plugin } = await initPlugin(noDepsAtAllOptions)
+    for (const specifier of bareSpecifiers) {
+        t.is(await callHook(plugin, 'resolveId', specifier), null, `Failed id: ${specifier}`)
+    }
+})
+
+test("Filters out bare specifiers when asked to", async t => {
+    const bareSpecifiers = [ 'bare' ]
+    const { plugin } = await initPlugin({
+        ...noDepsAtAllOptions,
+        include: bareSpecifiers
+    })
+    for (const specifier of bareSpecifiers) {
+        t.is(await callHook(plugin, 'resolveId', specifier), false, `Failed id: ${specifier}`)
+    }
+})
