feat: support raw: false option in banner and footer

Author: eunbae0

packages/core/src/config.ts

@@ -327,8 +327,8 @@ export function composeBannerFooterConfig(
   banner: BannerAndFooter,
   footer: BannerAndFooter,
 ): RsbuildConfig {
-  const bannerConfig = pick(banner, ['js', 'css']);
-  const footerConfig = pick(footer, ['js', 'css']);
+  const bannerConfig = pick(banner, ['js', 'css', 'raw']);
+  const footerConfig = pick(footer, ['js', 'css', 'raw']);
 
   if (isEmptyObject(bannerConfig) && isEmptyObject(footerConfig)) {
     return {};
@@ -342,7 +342,7 @@ export function composeBannerFooterConfig(
         new rspack.BannerPlugin({
           banner: bannerConfig.js,
           stage: rspack.Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE + 1,
-          raw: true,
+          raw: bannerConfig?.raw ?? true,
           include: /\.(js|mjs|cjs)$/,
         }),
       );
@@ -352,7 +352,7 @@ export function composeBannerFooterConfig(
         new rspack.BannerPlugin({
           banner: bannerConfig.css,
           stage: rspack.Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE + 1,
-          raw: true,
+          raw: bannerConfig?.raw ?? true,
           include: /\.(css)$/,
         }),
       );
@@ -365,7 +365,7 @@ export function composeBannerFooterConfig(
         new rspack.BannerPlugin({
           banner: footerConfig.js,
           stage: rspack.Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE + 1,
-          raw: true,
+          raw: footerConfig?.raw ?? true,
           footer: true,
           include: /\.(js|mjs|cjs)$/,
         }),
@@ -376,7 +376,7 @@ export function composeBannerFooterConfig(
         new rspack.BannerPlugin({
           banner: footerConfig.css,
           stage: rspack.Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE + 1,
-          raw: true,
+          raw: footerConfig?.raw ?? true,
           footer: true,
           include: /\.(css)$/,
         }),
@@ -934,8 +934,8 @@ const composeDtsConfig = async (
         abortOnError: dts?.abortOnError ?? true,
         dtsExtension: dts?.autoExtension ? dtsExtension : '.d.ts',
         autoExternal,
-        banner: banner?.dts,
-        footer: footer?.dts,
+        banner: { content: banner?.dts, raw: banner?.raw ?? true },
+        footer: { content: footer?.dts, raw: footer?.raw ?? true },
       }),
     ],
   };

packages/core/src/types/config/index.ts

@@ -45,11 +45,13 @@ export type AutoExternal =
       peerDependencies?: boolean;
     };
 
+export type BannerAndFooterOptions = { raw?: boolean };
+
 export type BannerAndFooter = {
   js?: string;
   css?: string;
   dts?: string;
-};
+} & BannerAndFooterOptions;
 
 export type Shims = {
   cjs?: {

packages/plugin-dts/src/apiExtractor.ts

@@ -6,16 +6,16 @@ import {
 } from '@microsoft/api-extractor';
 import { logger } from '@rsbuild/core';
 import color from 'picocolors';
-import type { DtsEntry } from './index';
+import type { BannerAndFooter, DtsEntry } from './index';
 import { addBannerAndFooter, getTimeCost } from './utils';
 
 export type BundleOptions = {
   name: string;
   cwd: string;
   outDir: string;
   dtsExtension: string;
-  banner?: string;
-  footer?: string;
+  banner: BannerAndFooter;
+  footer: BannerAndFooter;
   dtsEntry: DtsEntry;
   tsconfigPath?: string;
   bundledPackages?: string[];

packages/plugin-dts/src/index.ts

@@ -20,10 +20,12 @@ export type PluginDtsOptions = {
         devDependencies?: boolean;
         peerDependencies?: boolean;
       };
-  banner?: string;
-  footer?: string;
+  banner: BannerAndFooter;
+  footer: BannerAndFooter;
 };
 
+export type BannerAndFooter = { content?: string; raw?: boolean };
+
 export type DtsEntry = {
   name?: string;
   path?: string;

packages/plugin-dts/src/tsc.ts

@@ -1,5 +1,6 @@
 import { logger } from '@rsbuild/core';
 import color from 'picocolors';
+import type { BannerAndFooter } from 'src';
 import ts from 'typescript';
 import {
   getFileLoc,
@@ -14,8 +15,8 @@ export type EmitDtsOptions = {
   configPath: string;
   declarationDir: string;
   dtsExtension: string;
-  banner?: string;
-  footer?: string;
+  banner: BannerAndFooter;
+  footer: BannerAndFooter;
 };
 
 export async function emitDts(

packages/plugin-dts/src/utils.ts

@@ -7,7 +7,7 @@ import MagicString from 'magic-string';
 import color from 'picocolors';
 import { convertPathToPattern, glob } from 'tinyglobby';
 import ts from 'typescript';
-import type { DtsEntry } from './index';
+import type { BannerAndFooter, DtsEntry } from './index';
 
 export function loadTsconfig(tsconfigPath: string): ts.ParsedCommandLine {
   const configFile = ts.readConfigFile(tsconfigPath, ts.sys.readFile);
@@ -85,22 +85,34 @@ export function getTimeCost(start: number): string {
 
 export async function addBannerAndFooter(
   file: string,
-  banner?: string,
-  footer?: string,
+  banner: BannerAndFooter,
+  footer: BannerAndFooter,
 ): Promise<void> {
-  if (!banner && !footer) {
+  if (!banner.content && !footer.content) {
     return;
   }
 
   const content = await fsP.readFile(file, 'utf-8');
   const code = new MagicString(content);
 
-  if (banner && !content.trimStart().startsWith(banner.trim())) {
-    code.prepend(`${banner}\n`);
+  if (
+    banner.content &&
+    !content.trimStart().startsWith(banner.content.trim()) &&
+    !content.trimStart().startsWith(`/*! ${banner.content.trim()} */`)
+  ) {
+    code.prepend(
+      banner?.raw ? `${banner.content}\n` : `/*! ${banner.content} */\n`,
+    );
   }
 
-  if (footer && !content.trimEnd().endsWith(footer.trim())) {
-    code.append(`\n${footer}\n`);
+  if (
+    footer.content &&
+    !content.trimEnd().endsWith(footer.content.trim()) &&
+    !content.trimEnd().endsWith(`/*! ${footer.content.trim()} */`)
+  ) {
+    code.append(
+      footer?.raw ? `\n${footer.content}\n` : `\n/*! ${footer.content} */\n`,
+    );
   }
 
   if (code.hasChanged()) {
@@ -112,8 +124,8 @@ export async function processDtsFiles(
   bundle: boolean,
   dir: string,
   dtsExtension: string,
-  banner?: string,
-  footer?: string,
+  banner: BannerAndFooter,
+  footer: BannerAndFooter,
 ): Promise<void> {
   if (bundle) {
     return;