rolldown-license-plugin 1.3.0 → 1.4.0

package/README.md

@@ -1,14 +1,8 @@
 # rolldown-license-plugin
 
-[![](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)
+[![](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) [![](https://depx.co/api/badge/rolldown-license-plugin)](https://depx.co/pkg/rolldown-license-plugin)
 
-Rolldown plugin to extract dependency licenses from bundled `node_modules` with zero dependencies.
-
-## Installation
-
-```console
-npm i rolldown-license-plugin
-```
+Rolldown plugin to extract dependency licenses.
 
 ## Usage
 
@@ -19,8 +13,8 @@ export default {
   plugins: [
     licensePlugin({
       onDone(licenses) {
-        // licenses is an array of {name, version, license, licenseText}
         console.info(licenses);
+        // => [{name, version, license, licenseText}]
       },
     }),
   ],
@@ -31,7 +25,7 @@ export default {
 
 ### `licensePlugin(opts)`
 
-Returns a Rolldown plugin.
+Returns the plugin.
 
 #### `opts.onDone`
 
@@ -52,6 +46,12 @@ Type: `number`
 
 When set, word-wrap `licenseText` to this column width.
 
+#### `opts.allow`
+
+Type: `(license: LicenseInfo) => boolean`
+
+Validate each dependency's license. Return `false` to throw a build error.
+
 ### `LicenseInfo`
 
 ```typescript
@@ -63,6 +63,10 @@ type LicenseInfo = {
 };
 ```
 
+### `wrap(length)`
+
+Function to word-wrap text to a certain column width.
+
 ## License
 
 © [silverwind](https://github.com/silverwind), distributed under BSD-2-Clause.

package/dist/index.d.ts

@@ -5741,7 +5741,8 @@ type LicenseInfo = {
 type RolldownLicensePluginOpts = {
   /** 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;
+  wrapText?: number; /** Validate each dependency's license. Return `false` to throw a build error */
+  allow?: (license: LicenseInfo) => boolean;
 };
 /** Word-wrap plain text to a specified column width */
 declare function wrap(text: string, width: number): string;
@@ -5749,7 +5750,8 @@ declare function wrap(text: string, width: number): string;
 declare const licensePlugin: ({
   onDone,
   match,
-  wrapText
+  wrapText,
+  allow
 }: RolldownLicensePluginOpts) => Plugin;
 //#endregion
 export { LicenseInfo, RolldownLicensePluginOpts, licensePlugin, wrap };

package/dist/index.js

@@ -40,7 +40,7 @@ function parseLicense(pkgJson) {
 	return "";
 }
 /** Rolldown plugin that extracts license information from bundled dependencies */
-const licensePlugin = ({ onDone, match = defaultMatch, wrapText }) => ({
+const licensePlugin = ({ onDone, match = defaultMatch, wrapText, allow }) => ({
 	name: "rolldown-license-plugin",
 	async generateBundle(_opts, bundle) {
 		const pkgJsonCache = /* @__PURE__ */ new Map();
@@ -106,6 +106,10 @@ const licensePlugin = ({ onDone, match = defaultMatch, wrapText }) => ({
 			};
 		}));
 		licenses.sort((a, b) => a.name.localeCompare(b.name));
+		if (allow) {
+			const violations = licenses.filter((entry) => !allow(entry));
+			if (violations.length) throw new Error(`License violation in: ${violations.map((entry) => `${entry.name}@${entry.version} (${entry.license || "unlicensed"})`).join(", ")}`);
+		}
 		onDone(licenses);
 	}
 });

package/package.json

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