Rsbuild Plugin HTML Minifier Terser

1.1.3 verified Fri May 01 auth: no javascript

An Rsbuild plugin that integrates html-minifier-terser to minify HTML outputs during the build process. Current stable version is 1.1.3. Released under MIT license. It provides a seamless way to optimize HTML files generated by Rsbuild, supporting customization of minification options either as an object or a callback function. Unlike other HTML minification plugins, it respects Rsbuild's JavaScript minification settings. It requires @rsbuild/core v1 or v2 (peer dependency) and ships TypeScript type definitions.

Common errors

error Cannot find module 'rsbuild-plugin-html-minifier-terser' ↓

cause Package not installed or incorrect import path

fix

npm add rsbuild-plugin-html-minifier-terser -D

error TypeError: pluginHtmlMinifierTerser is not a function ↓

cause Using default import instead of named import

fix

Use import { pluginHtmlMinifierTerser } from 'rsbuild-plugin-html-minifier-terser'

error Error: Cannot find module '@rsbuild/core' ↓

cause Missing peer dependency

fix

npm add @rsbuild/core -D (ensure version ^1.0.0 || ^2.0.0-0)

Warnings

breaking Requires @rsbuild/core v1 or v2 as peer dependency; incompatible with other versions. ↓

fix Ensure your project uses @rsbuild/core@^1.0.0 || ^2.0.0-0

gotcha The plugin accepts an options object or callback; passing a non-function object is fine, but if you need to modify default options, you must use a function. ↓

fix Use a callback to customize options based on defaults: pluginHtmlMinifierTerser((options) => { options.minifyCSS = false; return options; })

gotcha This plugin only minifies HTML; JavaScript and CSS minification inside HTML is controlled by Rsbuild's built-in minifiers unless specified via html-minifier-terser options. ↓

fix If you need full control, pass minifyJS, minifyCSS options to the plugin.

deprecated No deprecations yet; plugin is actively maintained. ↓

fix N/A

Install

npm install rsbuild-plugin-html-minifier-terser

yarn add rsbuild-plugin-html-minifier-terser

pnpm add rsbuild-plugin-html-minifier-terser

Imports

pluginHtmlMinifierTerser

wrong

import pluginHtmlMinifierTerser from 'rsbuild-plugin-html-minifier-terser'

correct

import { pluginHtmlMinifierTerser } from 'rsbuild-plugin-html-minifier-terser'

The package exports a named function, not a default export. TypeScript types are included.

pluginHtmlMinifierTerser

wrong

const pluginHtmlMinifierTerser = require('rsbuild-plugin-html-minifier-terser')

correct

const { pluginHtmlMinifierTerser } = require('rsbuild-plugin-html-minifier-terser')

CJS requires destructuring; direct require returns an object.

pluginHtmlMinifierTerser

wrong

import { pluginHtmlMinifierTerser } from 'rsbuild-plugin-html-minifier-terser/plugin'

correct

import { pluginHtmlMinifierTerser } from 'rsbuild-plugin-html-minifier-terser'

No subpath exports; always import from the package root.

Quickstart

Add the plugin to Rsbuild config. HTML output will be minified with default html-minifier-terser options.

// rsbuild.config.ts
import { pluginHtmlMinifierTerser } from 'rsbuild-plugin-html-minifier-terser';

export default {
  plugins: [
    pluginHtmlMinifierTerser(),
  ],
};