BannerPlugin#

new rspack.BannerPlugin(options);

Adds a banner to the top or bottom of each generated chunk.

• options

  • Type:

  type BannerContent = string;
  type BannerRules = string | RegExp | Array<string | RegExp>;
  type BannerPluginOptions = {
    banner: BannerContent;
    entryOnly?: boolean;
    footer?: boolean;
    raw?: boolean;
    test?: BannerRules;
    include?: BannerRules;
    exclude?: BannerRules;
  };
  export type BannerPluginArgument = BannerContent | BannerPluginOptions;
  • Default: undefined

  Name	Type	Default	Description
  banner	string	undefined	Specifies the banner, it will be wrapped in a comment.
  entryOnly	boolean|undefined	undefined	If true, the banner will only be added to the entry chunks.
  footer	boolean|undefined	undefined	If true, banner will be placed at the end of the output.
  raw	boolean|undefined	undefined	If true, banner will not be wrapped in a comment.
  test	BannerRules|undefined	undefined	Include all modules that pass test assertion.
  include	BannerRules|undefined	undefined	Include all modules matching any of these conditions.
  exclude	BannerRules|undefined	undefined	Exclude all modules matching any of these conditions.

Add a banner to the top or bottom of each chunk file.

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