feat: add inlineOnly option

Author: sxzz

src/features/external.ts

@@ -1,65 +1,105 @@
 import { builtinModules } from 'node:module'
+import path from 'node:path'
+import { blue, underline } from 'ansis'
 import Debug from 'debug'
+import { RE_DTS, RE_NODE_MODULES } from 'rolldown-plugin-dts/filename'
 import { shimFile } from '../index'
-import { toArray } from '../utils/general'
+import { matchPattern } from '../utils/general'
 import type { ResolvedOptions } from '../options'
 import type { PackageJson } from 'pkg-types'
-import type { Plugin } from 'rolldown'
+import type { Plugin, PluginContext, ResolveIdExtraOptions } from 'rolldown'
 
 const debug = Debug('tsdown:external')
 
-export function ExternalPlugin(options: ResolvedOptions): Plugin {
-  const deps = options.pkg && Array.from(getProductionDeps(options.pkg))
+export function ExternalPlugin({
+  pkg,
+  noExternal,
+  inlineOnly,
+  skipNodeModulesBundle,
+}: ResolvedOptions): Plugin {
+  const deps = pkg && Array.from(getProductionDeps(pkg))
+
   return {
     name: 'tsdown:external',
     async resolveId(id, importer, extraOptions) {
-      if (extraOptions.isEntry) return
-      if (id === shimFile) return
+      if (extraOptions.isEntry || !importer) return
 
-      const { noExternal } = options
-      if (typeof noExternal === 'function' && noExternal(id, importer)) {
-        return
-      }
-      if (noExternal) {
-        const noExternalPatterns = toArray(noExternal)
-        if (
-          noExternalPatterns.some((pattern) => {
-            if (pattern instanceof RegExp) {
-              pattern.lastIndex = 0
-              return pattern.test(id)
-            }
-            return id === pattern
-          })
-        )
-          return
-      }
+      const shouldExternal = await externalStrategy(
+        this,
+        id,
+        importer,
+        extraOptions,
+      )
+      const nodeBuiltinModule =
+        id.startsWith('node:') || builtinModules.includes(id)
 
-      let shouldExternal: boolean | 'absolute' = false
-      if (options.skipNodeModulesBundle) {
-        const resolved = await this.resolve(id, importer, extraOptions)
-        if (!resolved) return resolved
-        shouldExternal =
-          resolved.external || /[\\/]node_modules[\\/]/.test(resolved.id)
-      }
-      if (deps) {
-        shouldExternal ||= deps.some(
-          (dep) => id === dep || id.startsWith(`${dep}/`),
-        )
-      }
+      debug('shouldExternal: %s = %s', id, shouldExternal)
 
-      if (shouldExternal) {
-        debug('External dependency:', id)
+      if (shouldExternal === true || shouldExternal === 'absolute') {
         return {
           id,
           external: shouldExternal,
-          moduleSideEffects:
-            id.startsWith('node:') || builtinModules.includes(id)
-              ? false
-              : undefined,
+          moduleSideEffects: nodeBuiltinModule ? false : undefined,
+        }
+      }
+
+      if (
+        inlineOnly &&
+        !RE_DTS.test(importer) && // skip dts files
+        !nodeBuiltinModule && // skip node built-in modules
+        id[0] !== '.' && // skip relative imports
+        !path.isAbsolute(id) // skip absolute imports
+      ) {
+        const shouldInline =
+          shouldExternal === 'no-external' || // force inline
+          matchPattern(id, inlineOnly)
+        debug('shouldInline: %s = %s', id, shouldInline)
+        if (shouldInline) return
+
+        const resolved = await this.resolve(id, importer, extraOptions)
+        if (!resolved) return
+
+        if (RE_NODE_MODULES.test(resolved.id)) {
+          throw new Error(
+            `${underline(id)} is located in node_modules but is not included in ${blue`inlineOnly`} option.
+To fix this, either add it to ${blue`inlineOnly`}, declare it as a production or peer dependency in your package.json, or externalize it manually.
+Imported by ${underline(importer)}`,
+          )
         }
       }
     },
   }
+
+  /**
+   * - `true`: always external
+   * - `false`: skip, let other plugins handle it
+   * - `'absolute'`: external as absolute path
+   * - `'no-external'`: skip, but mark as non-external for inlineOnly check
+   */
+  async function externalStrategy(
+    context: PluginContext,
+    id: string,
+    importer: string | undefined,
+    extraOptions: ResolveIdExtraOptions,
+  ): Promise<boolean | 'absolute' | 'no-external'> {
+    if (id === shimFile) return false
+
+    if (noExternal?.(id, importer)) {
+      return 'no-external'
+    }
+
+    if (skipNodeModulesBundle) {
+      const resolved = await context.resolve(id, importer, extraOptions)
+      if (!resolved) return false
+      return resolved.external || RE_NODE_MODULES.test(resolved.id)
+    }
+
+    if (deps) {
+      return deps.some((dep) => id === dep || id.startsWith(`${dep}/`))
+    }
+
+    return false
+  }
 }
 
 /*

src/features/watch.ts

@@ -1,4 +1,5 @@
 import { blue } from 'ansis'
+import { RE_NODE_MODULES } from 'rolldown-plugin-dts/filename'
 import {
   globalContext,
   invalidateContextFile,
@@ -38,7 +39,7 @@ export async function watchBuild(
     ignorePermissionErrors: true,
     ignored: [
       /[\\/]\.git[\\/]/,
-      /[\\/]node_modules[\\/]/,
+      RE_NODE_MODULES,
       options.outDir,
       ...options.ignoreWatch,
     ],

src/options/index.ts

@@ -8,7 +8,7 @@ import { resolveEntry } from '../features/entry'
 import { hasExportsTypes } from '../features/exports'
 import { resolveTarget } from '../features/target'
 import { resolveTsconfig } from '../features/tsconfig'
-import { resolveRegex, slash, toArray } from '../utils/general'
+import { matchPattern, resolveRegex, slash, toArray } from '../utils/general'
 import { createLogger } from '../utils/logger'
 import { normalizeFormat, readPackageJson } from '../utils/package'
 import type { Awaitable } from '../utils/types'
@@ -182,7 +182,7 @@ async function resolveConfig(
     dts,
     unused = false,
     watch = false,
-    ignoreWatch = [],
+    ignoreWatch,
     shims = false,
     skipNodeModulesBundle = false,
     publint = false,
@@ -208,6 +208,7 @@ async function resolveConfig(
     nodeProtocol,
     cjsDefault = true,
     globImport = true,
+    inlineOnly,
   } = userConfig
 
   const logger = createLogger(logLevel, { customLogger, failOnWarn })
@@ -296,6 +297,14 @@ async function resolveConfig(
     return ignore
   })
 
+  if (noExternal != null && typeof noExternal !== 'function') {
+    const noExternalPatterns = toArray(noExternal)
+    noExternal = (id) => matchPattern(id, noExternalPatterns)
+  }
+  if (inlineOnly != null) {
+    inlineOnly = toArray(inlineOnly)
+  }
+
   const config: ResolvedOptions = {
     ...userConfig,
     entry,
@@ -332,6 +341,7 @@ async function resolveConfig(
     nodeProtocol,
     cjsDefault,
     globImport,
+    inlineOnly,
   }
 
   return config

src/options/types.ts

@@ -84,6 +84,11 @@ export interface Workspace {
   config?: boolean | string
 }
 
+export type NoExternalFn = (
+  id: string,
+  importer: string | undefined,
+) => boolean | null | undefined | void
+
 /**
  * Options for tsdown.
  */
@@ -95,12 +100,13 @@ export interface Options {
   entry?: InputOption
 
   external?: ExternalOption
-  noExternal?:
-    | Arrayable<string | RegExp>
-    | ((
-        id: string,
-        importer: string | undefined,
-      ) => boolean | null | undefined | void)
+  noExternal?: Arrayable<string | RegExp> | NoExternalFn
+  /**
+   * Bundle only the dependencies listed here; throw an error if any others are missing.
+   *
+   * Note: Be sure to include all required sub-dependencies as well.
+   */
+  inlineOnly?: Arrayable<string | RegExp>
   /**
    * Skip bundling `node_modules`.
    * @default false
@@ -486,7 +492,6 @@ export type ResolvedOptions = Omit<
       | 'define'
       | 'alias'
       | 'external'
-      | 'noExternal'
       | 'onSuccess'
       | 'fixedExtension'
       | 'outExtensions'
@@ -511,6 +516,8 @@ export type ResolvedOptions = Omit<
       nodeProtocol: 'strip' | boolean
       logger: Logger
       ignoreWatch: Array<string | RegExp>
+      noExternal?: NoExternalFn
+      inlineOnly?: Array<string | RegExp>
     }
   >,
   'config' | 'fromVite'

src/utils/general.ts

@@ -47,3 +47,16 @@ export function slash(string: string): string {
 }
 
 export const noop = <T>(v: T): T => v
+
+export function matchPattern(
+  id: string,
+  patterns: (string | RegExp)[],
+): boolean {
+  return patterns.some((pattern) => {
+    if (pattern instanceof RegExp) {
+      pattern.lastIndex = 0
+      return pattern.test(id)
+    }
+    return id === pattern
+  })
+}

tests/__snapshots__/inlineOnly/work.snap.md

@@ -0,0 +1,13 @@
+## index.js
+
+```js
+//#region ../../../../node_modules/.pnpm/cac@6.7.14/node_modules/cac/dist/index.mjs
+const cac = 42;
+
+//#endregion
+//#region ../../../../node_modules/.pnpm/bumpp@10.2.3/node_modules/bumpp/dist/index.mjs
+const bumpp = 42;
+
+//#endregion
+export { bumpp, cac };
+```

tests/index.test.ts

@@ -1,14 +1,28 @@
 import path from 'node:path'
-import { beforeEach, expect, test, vi } from 'vitest'
+import { RE_NODE_MODULES } from 'rolldown-plugin-dts'
+import { beforeEach, describe, expect, test, vi } from 'vitest'
 import { resolveOptions, type Options } from '../src/options'
 import { fsRemove } from '../src/utils/fs'
+import { slash } from '../src/utils/general'
 import { chdir, getTestDir, testBuild, writeFixtures } from './utils'
+import type { Plugin } from 'rolldown'
 
 beforeEach(async (context) => {
   const dir = getTestDir(context.task)
   await fsRemove(dir)
 })
 
+const pluginMockDepCode: Plugin = {
+  name: 'mock-dep-code',
+  load: {
+    filter: { id: RE_NODE_MODULES },
+    handler(id) {
+      const name = slash(id).split('/node_modules/').at(-1)!.split('/')[0]
+      return `export const ${name} = 42`
+    },
+  },
+}
+
 test('basic', async (context) => {
   const content = `console.log("Hello, world!")`
   const { snapshot } = await testBuild({
@@ -167,6 +181,41 @@ test('noExternal', async (context) => {
   })
 })
 
+describe('inlineOnly', () => {
+  test('work', async (context) => {
+    const files = {
+      'index.ts': `export * from 'cac'; export * from 'bumpp'`,
+    }
+    await testBuild({
+      context,
+      files,
+      options: {
+        noExternal: ['cac'],
+        inlineOnly: ['bumpp'],
+        plugins: [pluginMockDepCode],
+      },
+    })
+  })
+
+  test('throw error', async (context) => {
+    const files = {
+      'index.ts': `export * from 'bumpp'`,
+    }
+    await expect(() =>
+      testBuild({
+        context,
+        files,
+        options: {
+          inlineOnly: [],
+          plugins: [pluginMockDepCode],
+        },
+      }),
+    ).rejects.toThrow(
+      'declare it as a production or peer dependency in your package.json',
+    )
+  })
+})
+
 test('fromVite', async (context) => {
   const files = {
     'index.ts': `export default 10`,

tsdown.config.ts

@@ -3,6 +3,7 @@ import { defineConfig } from './src/config.ts'
 
 export default defineConfig({
   entry: ['./src/{index,run,plugins,config}.ts'],
+  inlineOnly: [],
   platform: 'node',
   dts: true,
   fixedExtension: true,