Update tests

Author: Septh

README.md

@@ -3,11 +3,17 @@ A Rollup plugin that automatically declares NodeJS built-in modules as `external
 
 Works in monorepos too!
 
-> ## Breaking changes in version 5
-> - In previous versions, the `devDeps` option (see below) defaulted to `true`.<br>This was practical, but often wrong: devDependencies are ment just for that: being used when developping. Therefore, the `devDeps` option now defaults to `false`, meaning Rollup will include them in your bundle.
+> ### Breaking changes in version 5
+> - In previous versions, the `devDeps` option (see below) defaulted to `true`.<br>This was practical, but often wrong: devDependencies are meant just for that: being used when developping. Therefore, the `devDeps` option now defaults to `false`, meaning Rollup will include them in your bundle.
 >- As anticipated since v4, the `builtinsPrefix` option now defaults to `'add'`.
 >- The deprecated `prefixedBuiltins` option has been removed.
-> - `rollup-plugin-node-externals` no longer depends on the Find Up package. While this is not a breaking change per se, it can be in some edge situations.
+> - `rollup-plugin-node-externals` no longer depends on the Find-Up package (while this is not a breaking change per se, it can be in some edge situations).
+> - Now has a _peer dependency_ on `rollup ^2.60.0 || ^3.0.0`.
+
+> ### Breaking changes in version 4
+> - In previous versions, the `deps` option (see below) defaulted to `false`.<br>This was practical, but often wrong: when bundling for distribution, you want your own dependencies to be installed by the package manager alongside your package, so they should not be bundled in the code. Therefore, the `deps` option now defaults to `true`.
+> - Now requires Node 14 (up from Node 12 for previous versions).
+> - Now has a _peer dependency_ on `rollup ^2.60.0`.
 
 ## Why you need this
 <details><summary>(click to expand)</summary>
@@ -101,9 +107,9 @@ Set the `builtins` option to `false` if you'd like to use some shims/polyfills f
 
 #### builtinsPrefix?: 'add' | 'strip' = 'add'
 How to handle the `node:` scheme used in recent versions of Node (i.e., `import path from 'node:path'`).<br>
-_Note that prefix handling is independant of the `builtins` options being enabled or disabled._
 - 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.
+> _Note that prefix handling is independant of the `builtins` options being enabled or disabled._
 
 #### packagePath?: string | string[] = []
 If you're working with monorepos, the `packagePath` option is made for you. It can take a path, or an array of paths, to your package.json file(s). If not specified, the default is to start with the current directory's package.json then go up scan for all package.json files in parent directories recursively until either the root git directory is reached or until no other package.json can be found.

package-lock.json

@@ -1,18 +1,13 @@
 // @ts-check
-import { builtinModules } from 'node:module'
-import { fileURLToPath } from 'node:url'
+import { createRequire, builtinModules } from 'node:module'
 import path from 'node:path'
-import fs from 'node:fs/promises'
 import nodeResolve from '@rollup/plugin-node-resolve'
 import commonjs from '@rollup/plugin-commonjs'
 import typescript from 'rollup-plugin-ts'
 import { defineConfig } from 'rollup'
 
-const __filename = fileURLToPath(import.meta.url)
-const __dirname  = path.dirname(__filename)
-
 /** @type { import('./package.json') } */
-const pkg = JSON.parse(await fs.readFile(path.resolve(__dirname, './package.json'), 'utf-8'))
+const pkg = createRequire(import.meta.url)('./package.json')
 
 const builtins = new Set(builtinModules)
 
@@ -39,8 +34,7 @@ const sharedOutputOptions = {
         preset: 'es2015',
         symbols: false,
     },
-    esModule: false,
-    exports: 'named',
+    freeze: false,
     sourcemap: true,
     plugins: [
         packageType()
@@ -54,10 +48,16 @@ export default defineConfig({
             format: 'commonjs',
             file: pkg.exports.require,
             interop: id => id && (id.startsWith('node:') || builtins.has(id)) ? 'default' : 'auto',
-            ...sharedOutputOptions
+            esModule: false,
+            exports: 'named',
+            ...sharedOutputOptions,
+
+            // Using the same technique as rollup/plugins
+            // (see https://github.com/rollup/plugins/blob/a87282241be1ab5059ed8cffae24d01660fae07d/shared/rollup.config.mjs#L28)
+            footer: 'module.exports = Object.assign(exports.default, exports);',
         },
         {
-            format: 'module',
+            format: 'esm',
             file: pkg.exports.import,
             ...sharedOutputOptions
         }
@@ -67,7 +67,7 @@ export default defineConfig({
         commonjs(),
         typescript({
             hook: {
-                outputPath: (_path, kind) => kind === 'declaration' ? path.normalize(pkg.exports.types) : undefined
+                outputPath: (_, kind) => kind === 'declaration' ? path.normalize(pkg.exports.types) : undefined
             }
         })
     ]

rollup.config.mjs

@@ -74,26 +74,38 @@ export interface ExternalsOptions {
 
 // Listing only fields of interest in package.json
 interface PackageJson {
-    dependencies?:         Record<string, string>
-    devDependencies?:      Record<string, string>
-    peerDependencies?:     Record<string, string>
+    dependencies?: Record<string, string>
+    devDependencies?: Record<string, string>
+    peerDependencies?: Record<string, string>
     optionalDependencies?: Record<string, string>
+    workspaces?: string[]
+    packages?: string[]
 }
 
 // Prepare node built-in modules lists.
+const nodePrefix = 'node:'
 const nodePrefixRx = /^node:/
 const builtins = {
-    all: new Set([
-        ...builtinModules,
-        ...builtinModules.map(mod => 'node:' + mod.replace(nodePrefixRx, ''))
-    ]),
+    all: new Set(builtinModules),
     alwaysPrefixed: new Set(
         builtinModules.filter(mod => nodePrefixRx.test(mod))
     )
 }
 
+const workspaceRootFiles = new Set([
+    'pnpm-workspace.yaml',  // pnpm
+    'lerna.json',           // Lerna
+    'workspace.jsonc',      // Bit
+    'nx.json',              // Nx
+    'rush.json',            // Rush
+])
+
 // Our defaults
-const defaults: Required<ExternalsOptions> = {
+type Config = Required<ExternalsOptions> & {
+    invalid?: boolean
+}
+
+const defaults: Config = {
     builtins: true,
     builtinsPrefix: 'add',
     packagePath: [],
@@ -114,11 +126,11 @@ const isString = (str: unknown): str is string =>
  */
 function externals(options: ExternalsOptions = {}): Plugin {
 
-    // This will store all eventual warnings until we can display them.
-    const warnings: string[] = []
+    // This will store all eventual warnings/errors until we can display them.
+    const messages: string[] = []
 
     // Consolidate options
-    const config: typeof defaults = Object.assign(Object.create(defaults), options)
+    const config: Config = Object.assign(Object.create(null), defaults, options)
 
     // Map the include and exclude options to arrays of regexes.
     const [ include, exclude ] = [ 'include', 'exclude' ].map(option =>
@@ -130,7 +142,7 @@ function externals(options: ExternalsOptions = {}): Plugin {
                 else if (typeof entry === 'string')
                     result.push(new RegExp('^' + entry.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '$'))
                 else if (entry) {
-                    warnings.push(`Ignoring wrong entry type #${index} in '${option}' option: ${JSON.stringify(entry)}`)
+                    messages.push(`Ignoring wrong entry type #${index} in '${option}' option: ${JSON.stringify(entry)}`)
                 }
                 return result
             }, [] as RegExp[])
@@ -145,26 +157,29 @@ function externals(options: ExternalsOptions = {}): Plugin {
                 ? [ config.packagePath ]
                 : []
 
-        // Get all package.json files from cwd up to the root of the git repo
-        // or the root of the volume, whichever comes first.
         if (packagePaths.length === 0) {
-            let cwd = process.cwd()
-            for (;;) {
-                let name = path.join(cwd, 'package.json')
-                if (fs.statSync(name, { throwIfNoEntry: false })?.isFile())
-                    packagePaths.push(name)
-
-                name = path.join(cwd, '.git')
-                if (fs.statSync(name, { throwIfNoEntry: false })?.isDirectory())
-                    break
-
-                const parent = path.dirname(cwd)
-                if (parent === cwd)
+            // Get all package.json files from cwd up to the root of the git repo,
+            // the root of the monorepo, or the root of the volume, whichever comes first.
+            for (
+                let current = process.cwd(), previous: string | null = null;
+                previous !== current;
+                previous = current, current = path.dirname(current)
+            ) {
+                const entries = fs.readdirSync(current, { withFileTypes: true })
+
+                if (entries.some(entry => entry.name === 'package.json' && entry.isFile()))
+                    packagePaths.push(path.join(current, 'package.json'))
+
+                if (entries.some(entry =>
+                    (workspaceRootFiles.has(entry.name) && entry.isFile()) ||
+                    (entry.name === '.git' && entry.isDirectory())
+                )) {
                     break
-                cwd = parent
+                }
             }
         }
 
+        // Gather dependencies names.
         const dependencies: Record<string, string> = {}
         for (const packagePath of packagePaths) {
             let pkg: PackageJson | null = null
@@ -176,12 +191,17 @@ function externals(options: ExternalsOptions = {}): Plugin {
                     config.peerDeps && pkg.peerDependencies,
                     config.optDeps  && pkg.optionalDependencies
                 )
+
+                // Stop here if this is a npm/yarn workspace root
+                if (pkg.workspaces || pkg.packages)
+                    break
             }
             catch {
+                config.invalid = true
                 if (pkg)
-                    warnings.push(`File ${JSON.stringify(packagePath)} does not look like a valid package.json.`)
+                    messages.push(`File ${JSON.stringify(packagePath)} does not look like a valid package.json.`)
                 else if (config.packagePath.length) // string or array
-                    warnings.push(`Cannot read file ${JSON.stringify(packagePath)}`)
+                    messages.push(`Cannot read file ${JSON.stringify(packagePath)}`)
             }
         }
 
@@ -197,10 +217,15 @@ function externals(options: ExternalsOptions = {}): Plugin {
         name: 'node-externals',
 
         async buildStart() {
-
-            // Simply issue the warnings we may have collected earlier.
-            while (warnings.length > 0)
-                this.warn(warnings.shift()!)
+            // Bail out if there was an error.
+            if (config.invalid)
+                this.error(messages[0])
+
+            // Otherwise issue any warnings we may have collected earlier.
+            while (messages.length > 0) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                this.warn(messages.shift()!)
+            }
         },
 
         async resolveId(id) {
@@ -210,13 +235,14 @@ function externals(options: ExternalsOptions = {}): Plugin {
                 return null
 
             // Handle node builtins.
-            if (builtins.all.has(id)) {
+            if (id.startsWith(nodePrefix) || builtins.all.has(id)) {
                 const stripped = id.replace(nodePrefixRx, '')
                 return {
                     id: config.builtinsPrefix === 'add' || builtins.alwaysPrefixed.has(id)
-                        ? 'node:' + stripped
+                        ? nodePrefix + stripped
                         : stripped,
-                    external: config.builtins && !isExcluded(id)
+                    external: config.builtins && !isExcluded(id),
+                    moduleSideEffects: false
                 }
             }
 

src/index.ts

@@ -0,0 +1,26 @@
+import type { Plugin } from 'rollup'
+
+// node-externals only implemented these two hooks
+export type TestedPlugin = {
+    buildStart: Plugin['buildStart']
+    resolveId: Plugin['resolveId']
+}
+
+const fakePluginContext = {
+    error(msg: string) {
+        throw new Error(msg)
+    },
+
+    warn(msg: string) {
+        console.warn(msg)
+    }
+}
+
+export async function call(hook: TestedPlugin[keyof TestedPlugin], ...args: any[]) {
+    if (typeof hook === 'function')
+        return (hook as any).apply(fakePluginContext, args)
+    if (typeof hook === 'object' && 'handler' in hook)
+        return (hook.handler as any).apply(fakePluginContext, args)
+
+    throw new Error('Ooops')
+}

test/_common.ts

@@ -0,0 +1,27 @@
+import test from 'ava'
+import { call, type TestedPlugin } from './_common'
+import externals from '../src/index'
+
+test('Adds "node:" prefix to builtins by default', async t => {
+    const plugin = externals() as TestedPlugin
+
+    for (const builtin of [ 'node:path', 'path' ]) {
+        t.like(await call(plugin.resolveId, builtin), {
+            id: 'node:path',
+            external: true
+        })
+    }
+})
+
+test('Removes "node:" prefix when option "builtinsPrefix" is set to "strip"', async t => {
+    const plugin = externals({
+        builtinsPrefix: 'strip'
+    }) as TestedPlugin
+
+    for (const builtin of [ 'node:path', 'path' ]) {
+        t.like(await call(plugin.resolveId, builtin), {
+            id: 'path',
+            external: true
+        })
+    }
+})

test/builtins.test.ts

@@ -0,0 +1,5 @@
+{
+  "packages": [
+    "one", "two "
+  ]
+}

test/fixtures/workspaces/lerna/lerna.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "chalk": "^4.0.0"
+  }
+}

test/fixtures/workspaces/lerna/one/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "express": "4.17.1"
+  }
+}

test/fixtures/workspaces/lerna/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "lodash": "^4.17.15"
+  }
+}