Skip to content
/ nf3 Public

Trace and copy only the node_modules that are actually required at runtime for your built output

License

Notifications You must be signed in to change notification settings

unjs/nf3

Repository files navigation

📦 nf3

npm version npm downloads install size codecov

This plugin traces and copies only the node_modules that are actually required at runtime for your built output — powered by @vercel/nft.

Bundling external dependencies can sometimes fail or cause issues, especially when modules rely on relative paths, native bindings, or dynamic imports.

To solve this, the plugin analyzes your build output, traces its runtime dependencies, and copies a tree-shaken, deduplicated, and runtime-only subset of node_modules into dist/node_modules. The result is a minimal, self-contained distribution directory that just works.

Originally extracted from Nitro and used for optimizing nf3 package dist itself!

Usage

Rollup/Rolldown plugin

import { rollupNodeFileTrace } from "nf3";

export default {
  plugins: [
    rollupNodeFileTrace({
      // rootDir: process.cwd(),
      // outDir: "dist",
      // exportConditions: ["node", "import", "default"],
      // traceAlias: {},
      // chmod: true, // or 0o755
      // noTrace: false,
      // inline: [/^@my-scope\//],
      // external: ["fsevents"],
      // moduleDirectories: ["node_modules"],
      // traceInclude: ["some-lib"],
      // writePackageJson: true,
      // traceOptions: { /* see https://github.com/vercel/nft#options */ }
    }),
  ],
};

API

import { traceNodeModules } from "nf3";

await traceNodeModules(["./index.mjs"], {
  /* options */
});

Development

local development
  • Clone this repository
  • Install latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run interactive tests using pnpm dev

License

Published under the MIT license.

About

Trace and copy only the node_modules that are actually required at runtime for your built output

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •