简体中文

BannerPlugin

new rspack.BannerPlugin(options);

在每个生成的 chunk 顶部或尾部添加一段指定的内容。

选项

类型：

type BannerFunction = (args: {
  hash: string;
  chunk: JsChunk;
  filename: string;
}) => string;
type BannerContent = string | BannerFunction;
type BannerRules = string | RegExp | Array<string | RegExp>;
type BannerPluginOptions = {
  banner: BannerContent;
  entryOnly?: boolean;
  footer?: boolean;
  raw?: boolean;
  stage?: number;
  test?: BannerRules;
  include?: BannerRules;
  exclude?: BannerRules;
};
type BannerPluginArgument = BannerContent | BannerPluginOptions;

默认值： undefined

名称	类型	默认值	描述
`banner`	`BannerFunction\|string`	undefined	指定 banner 内容（会被包裹成注释）
`entryOnly`	`boolean\|undefined`	undefined	如果值为 true，将只在入口 chunks 文件中添加
`footer`	`boolean\|undefined`	undefined	如果值为 true，banner 将会位于编译结果的最下方
`raw`	`boolean\|undefined`	undefined	如果值为 true，将直接输出，不会被作为注释
`stage`	`number\|undefined`	`PROCESS_ASSETS_STAGE_ADDITIONS`(-100)	Banner 应在哪个编译阶段注入
`test`	`BannerRules\|undefined`	undefined	包含所有匹配的模块
`include`	`BannerRules\|undefined`	undefined	根据条件匹配指定的模块
`exclude`	`BannerRules\|undefined`	undefined	根据条件排除指定的模块

示例

在每个 chunk 文件底部添加 banner。

rspack.config.js

module.exports = {
  plugins: [
    new rspack.BannerPlugin({
      banner: 'hello world',
      footer: true,
    }),
  ],
};

ON THIS PAGE

BannerPlugin#

选项#

示例#

BannerPlugin

选项

示例