nf3 0.0.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,33 @@
+MIT License
+
+Copyright (c) Pooya Parsa <pooya@pi0.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Bundled with @vercel/nft (https://github.com/vercel/nft)
+
+Copyright 2019 Vercel, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# 📦 nf3
+
+<!-- automd:badges color=yellow codecov packagephobia -->
+
+[![npm version](https://img.shields.io/npm/v/nf3?color=yellow)](https://npmjs.com/package/nf3)
+[![npm downloads](https://img.shields.io/npm/dm/nf3?color=yellow)](https://npm.chart.dev/nf3)
+[![install size](https://badgen.net/packagephobia/install/nf3?color=yellow)](https://packagephobia.com/result?p=nf3)
+[![codecov](https://img.shields.io/codecov/c/gh/unjs/nf3?color=yellow)](https://codecov.io/gh/unjs/nf3)
+
+<!-- /automd -->
+
+This plugin traces and copies only the `node_modules` that are actually required at runtime for your built output — powered by [@vercel/nft](https://github.com/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](https://nitro.build) and used for optimizing `nf3` package dist itself!
+
+## Usage
+
+### Rollup/Rolldown plugin
+
+```js
+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
+
+```js
+import { traceNodeModules } from "nf3";
+
+await traceNodeModules(["./index.mjs"], {
+  /* options */
+});
+```
+
+## Development
+
+<details>
+
+<summary>local development</summary>
+
+- Clone this repository
+- Install latest LTS version of [Node.js](https://nodejs.org/en/)
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `pnpm install`
+- Run interactive tests using `pnpm dev`
+
+</details>
+
+## License
+
+Published under the [MIT](https://github.com/unjs/nf3/blob/main/LICENSE) license.

package/dist/index.d.mts

@@ -0,0 +1,68 @@
+import { NodeFileTraceOptions } from "@vercel/nft";
+import { Plugin } from "rollup";
+
+//#region src/types.d.ts
+interface ExternalsTraceOptions {
+  /**
+   * The root directory to use when resolving files. Defaults to `process.cwd()`.
+   */
+  rootDir?: string;
+  /**
+   * The output directory where traced files will be copied. Defaults to `dist`.
+   */
+  outDir?: string;
+  /**
+   * Options to pass to `@vercel/nft` for file tracing.
+   *
+   * @see https://github.com/vercel/nft#options
+   */
+  traceOptions?: NodeFileTraceOptions;
+  /**
+   * Module resolution conditions to use when resolving packages.
+   *
+   * Defaults to `["node", "import", "default"]`
+   */
+  exportConditions?: string[];
+  /**
+   * Alias for module paths when tracing files.
+   */
+  traceAlias?: Record<string, string>;
+  /**
+   * Preserve file permissions when copying files. If set to `true`, original file permissions are preserved. If set to a number, that value is used as the permission mode (e.g., `0o755`).
+   */
+  chmod?: boolean | number;
+  /**
+   * If `true`, writes a `package.json` file to the output directory (parent) with the traced files as dependencies.
+   */
+  writePackageJson?: boolean;
+}
+interface ExternalsPluginOptions extends ExternalsTraceOptions {
+  /**
+   * If `true`, disables automatic tracing of `node_modules` dependencies and keeps them as absolute external paths.
+   */
+  noTrace?: boolean;
+  /**
+   * Patterns to always include (inline) instead of tracing them as externals.
+   */
+  inline?: Array<string | RegExp | ((id: string, importer?: string) => Promise<boolean> | boolean)>;
+  /**
+   * Patterns to always exclude (trace) instead of inlining them as externals.
+   */
+  external?: Array<string | RegExp | ((id: string, importer?: string) => Promise<boolean> | boolean)>;
+  /**
+   * `node_modules` directories to use when resolving packages. Defaults to `['node_modules']`.
+   */
+  moduleDirectories?: string[];
+  /**
+   * Patterns to always include (trace) even if not resolved.
+   */
+  traceInclude?: string[];
+}
+//#endregion
+//#region src/plugin.d.ts
+declare function rollupNodeFileTrace(opts?: ExternalsPluginOptions): Plugin;
+//#endregion
+//#region src/trace.d.ts
+declare function traceNodeModules(input: string[], opts: ExternalsTraceOptions): Promise<void>;
+//#endregion
+export { type ExternalsPluginOptions, type ExternalsTraceOptions, rollupNodeFileTrace, traceNodeModules };