esbuild-plugin-minify-html-literals

3.0.0 verified Mon Apr 27 auth: no javascript

ESBuild plugin to minify HTML syntax in JavaScript tagged-template literals, wrapping the `minify-html-literals` library. Version 3.0.0, peer dependency on esbuild >=0.16.17 || ^0.25.0, ships TypeScript types. Key differentiator: specifically designed for Lit, hybrids, FAST, htm, etc., enabling production builds with minified template literals reducing bundle size.

Common errors

error Error [ERR_REQUIRE_ESM]: require() of ES Module ... from ... not supported. ↓

cause Using CommonJS require() on an ESM-only package.

fix

Change to import statement or use dynamic import().

error TypeError: minifyHTMLLiteralsPlugin is not a function ↓

cause Importing the wrong symbol; maybe using default import.

fix

Use named import: import { minifyHTMLLiteralsPlugin } from 'esbuild-plugin-minify-html-literals'

error error: Cannot find module 'esbuild-plugin-minify-html-literals' ↓

cause Package not installed or incorrect import path.

fix

Run npm install esbuild-plugin-minify-html-literals and check import statement.

Warnings

gotcha Plugin only minifies .js/.ts files by default; for other extensions, set `filter` option. ↓

fix Use `minifyHTMLLiteralsPlugin({ filter: /\.html$/ })` or adjust regex.

gotcha Cannot use with CommonJS require; package is ESM-only. ↓

fix Switch to ESM imports or use dynamic import().

gotcha Plugin may not work with esbuild versions below 0.16.17; check peer dependency. ↓

fix Install esbuild >=0.16.17 or ^0.25.0.

Install

npm install esbuild-plugin-minify-html-literals

yarn add esbuild-plugin-minify-html-literals

pnpm add esbuild-plugin-minify-html-literals

Imports

minifyHTMLLiteralsPlugin

wrong

const minifyHTMLLiteralsPlugin = require('esbuild-plugin-minify-html-literals')

correct

import { minifyHTMLLiteralsPlugin } from 'esbuild-plugin-minify-html-literals'

ESM-only package; CommonJS require is not supported.

Quickstart

Shows ESBuild build with the plugin to minify HTML tagged templates in production bundles.

import esbuild from 'esbuild';
import { minifyHTMLLiteralsPlugin } from 'esbuild-plugin-minify-html-literals';

await esbuild.build({
  entryPoints: ['src/index.js'],
  bundle: true,
  outfile: 'dist/bundle.js',
  plugins: [
    minifyHTMLLiteralsPlugin(),
  ],
});

console.log('Build complete with minified HTML literals!');