@sohu-bpd/unplugin-banner

@sohu-bpd/unplugin-banner

Example unplugin-based banner plugin for Vite, Rollup, webpack, Rspack, and Rolldown.

Host Support

The package root exports the unplugin factory object. In app config, prefer the host-specific subpaths:

• @sohu-bpd/unplugin-banner/vite
• @sohu-bpd/unplugin-banner/rollup
• @sohu-bpd/unplugin-banner/webpack
• @sohu-bpd/unplugin-banner/rspack
• @sohu-bpd/unplugin-banner/rolldown

Rsbuild should use the /rspack entry through tools.rspack; there is no separate ./rsbuild export.

Usage

Vite

import { defineConfig } from "vite";
import banner from "@sohu-bpd/unplugin-banner/vite";

export default defineConfig({
  plugins: [banner({ banner: "built with @sohu-bpd/unplugin-banner" })]
});

Rollup

import banner from "@sohu-bpd/unplugin-banner/rollup";

export default {
  plugins: [banner({ banner: "built with @sohu-bpd/unplugin-banner" })]
};

Other Hosts

• Use @sohu-bpd/unplugin-banner/webpack in webpack configs.
• Use @sohu-bpd/unplugin-banner/rspack in Rspack configs and in Rsbuild via tools.rspack.plugins.
• Use @sohu-bpd/unplugin-banner/rolldown in Rolldown configs.

Rsbuild

import banner from "@sohu-bpd/unplugin-banner/rspack";

export default {
  tools: {
    rspack: {
      plugins: [banner({ banner: "built with @sohu-bpd/unplugin-banner" })]
    }
  }
};

Options

• banner: required string prepended as a block comment to transformed script modules