rolldown-license-plugin 1.1.0 → 1.3.0

package/README.md

@@ -2,7 +2,7 @@
 
 [![](https://img.shields.io/npm/v/rolldown-license-plugin.svg?style=flat)](https://www.npmjs.org/package/rolldown-license-plugin) [![](https://img.shields.io/npm/dm/rolldown-license-plugin.svg)](https://www.npmjs.org/package/rolldown-license-plugin)
 
-Rolldown plugin to extract dependency licenses from bundled `node_modules`. Zero dependencies, and will always stay that way.
+Rolldown plugin to extract dependency licenses from bundled `node_modules` with zero dependencies.
 
 ## Installation
 
@@ -46,6 +46,12 @@ Default: `/^((UN)?LICEN(S|C)E|COPYING).*$/i`
 
 Regex to match license filenames in package directories.
 
+#### `opts.wrapText`
+
+Type: `number`
+
+When set, word-wrap `licenseText` to this column width.
+
 ### `LicenseInfo`
 
 ```typescript

package/dist/index.d.ts

@@ -5730,19 +5730,26 @@ interface InputOptions {
 //#region src/types/rolldown-options.d.ts
 //#endregion
 //#region index.d.ts
+/** License information for a single bundled dependency */
 type LicenseInfo = {
-  name: string;
-  version: string;
-  license: string;
+  /** Package name from package.json */name: string; /** Package version from package.json */
+  version: string; /** SPDX license identifier from package.json */
+  license: string; /** Contents of the LICENSE/COPYING file, or empty string if not found */
   licenseText: string;
 };
+/** Options for {@link licensePlugin} */
 type RolldownLicensePluginOpts = {
-  onDone: (licenses: LicenseInfo[]) => void;
-  match?: RegExp;
+  /** Called during `generateBundle` with the collected license data, sorted by name */onDone: (licenses: LicenseInfo[]) => void; /** Regex to match license filenames. Default: `/^((UN)?LICEN(S|C)E|COPYING).*$/i` */
+  match?: RegExp; /** When set, word-wrap `licenseText` to this column width */
+  wrapText?: number;
 };
+/** Word-wrap plain text to a specified column width */
+declare function wrap(text: string, width: number): string;
+/** Rolldown plugin that extracts license information from bundled dependencies */
 declare const licensePlugin: ({
   onDone,
-  match
+  match,
+  wrapText
 }: RolldownLicensePluginOpts) => Plugin;
 //#endregion
-export { LicenseInfo, RolldownLicensePluginOpts, licensePlugin };
+export { LicenseInfo, RolldownLicensePluginOpts, licensePlugin, wrap };

package/dist/index.js

@@ -4,13 +4,43 @@ import { dirname, join } from "node:path";
 
 //#region index.ts
 const defaultMatch = /^((UN)?LICEN(S|C)E|COPYING).*$/i;
+/** Word-wrap plain text to a specified column width */
+function wrap(text, width) {
+	const lines = [];
+	for (const rawLine of text.replace(/\r/g, "").split("\n")) {
+		const trimmed = rawLine.replace(/\t/g, (_, offset) => " ".repeat(8 - offset % 8)).trim();
+		if (trimmed.length <= width) {
+			lines.push(trimmed);
+			continue;
+		}
+		let pos = 0;
+		while (pos < trimmed.length) {
+			if (pos + width >= trimmed.length) {
+				lines.push(trimmed.slice(pos).trim());
+				break;
+			}
+			let breakAt = trimmed.lastIndexOf(" ", pos + width);
+			if (breakAt <= pos) {
+				breakAt = trimmed.indexOf(" ", pos + width);
+				if (breakAt === -1) {
+					lines.push(trimmed.slice(pos).trim());
+					break;
+				}
+			}
+			lines.push(trimmed.slice(pos, breakAt).trimEnd());
+			pos = breakAt + 1;
+		}
+	}
+	return lines.join("\n");
+}
 function parseLicense(pkgJson) {
 	if (typeof pkgJson.license === "string") return pkgJson.license;
 	if (pkgJson.license?.type) return pkgJson.license.type;
 	if (Array.isArray(pkgJson.licenses)) return pkgJson.licenses.map((entry) => typeof entry === "string" ? entry : entry?.type ?? "").filter(Boolean).join(" OR ");
 	return "";
 }
-const licensePlugin = ({ onDone, match = defaultMatch }) => ({
+/** Rolldown plugin that extracts license information from bundled dependencies */
+const licensePlugin = ({ onDone, match = defaultMatch, wrapText }) => ({
 	name: "rolldown-license-plugin",
 	async generateBundle(_opts, bundle) {
 		const pkgJsonCache = /* @__PURE__ */ new Map();
@@ -63,7 +93,10 @@ const licensePlugin = ({ onDone, match = defaultMatch }) => ({
 			let licenseText = "";
 			try {
 				const licenseFile = (await readdir(dir)).find((entry) => match.test(entry));
-				if (licenseFile) licenseText = await readFile(join(dir, licenseFile), "utf8");
+				if (licenseFile) {
+					licenseText = await readFile(join(dir, licenseFile), "utf8");
+					if (wrapText) licenseText = wrap(licenseText, wrapText).trim();
+				}
 			} catch {}
 			return {
 				name: pkgJson.name,
@@ -78,4 +111,4 @@ const licensePlugin = ({ onDone, match = defaultMatch }) => ({
 });
 
 //#endregion
-export { licensePlugin };
+export { licensePlugin, wrap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rolldown-license-plugin",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Rolldown plugin to extract dependency licenses",
   "author": "silverwind <me@silverwind.io>",
   "repository": "silverwind/rolldown-license-plugin",