rolldown-plugin-dts 0.16.4 → 0.16.5

package/README.md

@@ -99,6 +99,14 @@ If set to `true`, and you are only exporting a single item using `export default
 the output will use `export = ...` instead of the standard ES module syntax.
 This is useful for compatibility with CommonJS.
 
+#### `banner`
+
+Content to be added at the top of each generated `.d.ts` file.
+
+#### `footer`
+
+Content to be added at the bottom of each generated `.d.ts` file.
+
 ### `tsc` Options
 
 > [!NOTE]

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { RE_CSS, RE_DTS, RE_DTS_MAP, RE_JS, RE_NODE_MODULES, RE_TS, RE_VUE } from "./filename-BDKLOOY5.js";
 import { IsolatedDeclarationsOptions } from "rolldown/experimental";
 import { TsConfigJson } from "get-tsconfig";
-import { Plugin } from "rolldown";
+import { AddonFunction, Plugin } from "rolldown";
 
 //#region src/options.d.ts
 interface GeneralOptions {
@@ -144,6 +144,14 @@ interface TscOptions {
   * `false`.
   */
   emitJs?: boolean;
+  /**
+  * Content to be added at the top of each generated `.d.ts` file.
+  */
+  banner?: string | Promise<string> | AddonFunction;
+  /**
+  * Content to be added at the bottom of each generated `.d.ts` file.
+  */
+  footer?: string | Promise<string> | AddonFunction;
 }
 interface Options extends GeneralOptions, TscOptions {
   /**
@@ -164,8 +172,9 @@ interface Options extends GeneralOptions, TscOptions {
   tsgo?: boolean;
 }
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
-type OptionsResolved = Overwrite<Required<Omit<Options, "compilerOptions">>, {
-  tsconfig: string | undefined;
+type MarkPartial<T, K extends keyof T> = Omit<Required<T>, K> & Partial<Pick<T, K>>;
+type OptionsResolved = Overwrite<MarkPartial<Omit<Options, "compilerOptions">, "banner" | "footer">, {
+  tsconfig?: string;
   oxc: IsolatedDeclarationsOptions | false;
   tsconfigRaw: TsConfigJson;
 }>;
@@ -179,6 +188,8 @@ declare function resolveOptions({
   sourcemap,
   resolve,
   cjsDefault,
+  banner,
+  footer,
   build,
   incremental,
   vue,

package/dist/index.js

@@ -1,6 +1,7 @@
 import { RE_CSS, RE_DTS, RE_DTS_MAP, RE_JS, RE_NODE_MODULES, RE_TS, RE_VUE, filename_dts_to, filename_js_to_dts, filename_to_dts, replaceTemplateName, resolveTemplateFn } from "./filename-Dd76wOJT.js";
 import { createContext, globalContext, invalidateContextFile } from "./context-Digr9tkU.js";
 import Debug from "debug";
+import MagicString from "magic-string";
 import _generate from "@babel/generator";
 import { parse } from "@babel/parser";
 import * as t from "@babel/types";
@@ -15,6 +16,36 @@ import process from "node:process";
 import { getTsconfig, parseTsconfig } from "get-tsconfig";
 import { createResolver } from "dts-resolver";
 
+//#region src/banner.ts
+function createBannerPlugin({ banner, footer }) {
+	return {
+		name: "rolldown-plugin-dts:banner",
+		async renderChunk(code, chunk) {
+			if (!RE_DTS.test(chunk.fileName)) return;
+			const s = new MagicString(code);
+			if (banner) {
+				const code$1 = await (typeof banner === "function" ? banner(chunk) : banner);
+				if (code$1) s.prepend(`${code$1}\n`);
+			}
+			if (footer) {
+				const code$1 = await (typeof footer === "function" ? footer(chunk) : footer);
+				if (code$1) s.append(`\n${code$1}`);
+			}
+			return {
+				code: s.toString(),
+				get map() {
+					return s.generateMap({
+						source: chunk.fileName,
+						includeContent: true,
+						hires: "boundary"
+					});
+				}
+			};
+		}
+	};
+}
+
+//#endregion
 //#region src/dts-input.ts
 function createDtsInputPlugin() {
 	return {
@@ -865,7 +896,7 @@ async function runTsgo(root, tsconfig) {
 //#endregion
 //#region src/options.ts
 let warnedTsgo = false;
-function resolveOptions({ cwd = process.cwd(), dtsInput = false, emitDtsOnly = false, tsconfig, tsconfigRaw: overriddenTsconfigRaw = {}, compilerOptions = {}, sourcemap, resolve = false, cjsDefault = false, build = false, incremental = false, vue = false, tsMacro = false, parallel = false, eager = false, newContext = false, emitJs, oxc, tsgo = false }) {
+function resolveOptions({ cwd = process.cwd(), dtsInput = false, emitDtsOnly = false, tsconfig, tsconfigRaw: overriddenTsconfigRaw = {}, compilerOptions = {}, sourcemap, resolve = false, cjsDefault = false, banner, footer, build = false, incremental = false, vue = false, tsMacro = false, parallel = false, eager = false, newContext = false, emitJs, oxc, tsgo = false }) {
 	let resolvedTsconfig;
 	if (tsconfig === true || tsconfig == null) {
 		const { config, path: path$1 } = getTsconfig(cwd) || {};
@@ -914,6 +945,8 @@ function resolveOptions({ cwd = process.cwd(), dtsInput = false, emitDtsOnly = f
 		sourcemap,
 		resolve,
 		cjsDefault,
+		banner,
+		footer,
 		build,
 		incremental,
 		vue,
@@ -986,6 +1019,7 @@ function dts(options = {}) {
 	if (options.dtsInput) plugins.push(createDtsInputPlugin());
 	else plugins.push(createGeneratePlugin(resolved));
 	plugins.push(createDtsResolvePlugin(resolved), createFakeJsPlugin(resolved));
+	if (options.banner || options.footer) plugins.push(createBannerPlugin(resolved));
 	return plugins;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rolldown-plugin-dts",
-  "version": "0.16.4",
+  "version": "0.16.5",
   "description": "A Rolldown plugin to generate and bundle dts files.",
   "type": "module",
   "keywords": [
@@ -68,7 +68,8 @@
     "birpc": "^2.5.0",
     "debug": "^4.4.1",
     "dts-resolver": "^2.1.2",
-    "get-tsconfig": "^4.10.1"
+    "get-tsconfig": "^4.10.1",
+    "magic-string": "^0.30.19"
   },
   "devDependencies": {
     "@sxzz/eslint-config": "^7.1.4",