HtmlRspackPlugin#

此插件可以创建与 Rspack 产物关联的 HTML 文件。

new rspack.HtmlRspackPlugin(options);

• options

  • 类型：

  type HtmlRspackPluginOptions = {
    title?: string;
    filename?: string;
    template?: string;
    templateContent?: string;
    templateParameters?: Record<string, string>;
    inject?: 'head' | 'body';
    publicPath?: string;
    scriptLoading?: 'blocking' | 'defer' | 'module';
    chunks?: string[];
    excludedChunks?: string[];
    sri?: 'sha256' | 'sha384' | 'sha512';
    minify?: boolean;
    favicon?: string;
    meta?: Record<string, string | Record<string, string>>;
  };
  • 默认值： {}

  名称	类型	默认值	描述
  title	string|undefined	undefined	构建 HTML 的标题
  filename	string	'index.html'	输出的文件名，可以指定子目录，例如 pages/index.html
  template	string|undefined	undefined	模版文件路径，支持 ejs
  templateContent	string|undefined	undefined	模版文件内容，优先级大于 template
  templateParameters	Record<string, string>	{}	传递给模版的参数
  inject	'head'|'body'|undefined	undefined	产物注入位置
  publicPath	string	''	script 和 link 标签的 publicPath
  scriptLoading	'blocking'|'defer'|'module'	'defer'	现代浏览器支持使用 defer 来异步加载 js，设置为 module 则会添加 type="module" 同时使用 defer
  chunks	string[]|undefined	undefined	配置需要注入的 chunk，默认注入所有 chunk
  excludedChunks	string[]|undefined	undefined	配置需要跳过注入的 chunk
  sri	'sha256'|'sha384'|'sha512'|undefined	undefined	sri hash 算法，默认不开启 sri
  minify	boolean	false	是否启用压缩
  favicon	string|undefined	undefined	配置 HTML 图标
  meta	Record<string, string|Record<string, string>>	{}	配置需要注入 HTML 的 meta