Registry / devops / esbuild-html-plugin

esbuild-html-plugin

library1.1.0jsnpmunverified

An esbuild plugin that generates an HTML file with output URLs of bundled assets. Version 1.1.0, released as stable. It provides fine-grained control over HTML head and body elements through callback functions, allowing dynamic injection of CSS and JS references. Unlike alternative HTML plugins for esbuild, this one is minimalistic and avoids bundling HTML templates, focusing solely on generating a simple HTML file with asset URLs. No HTML minification is included since v1.1.0. The package is ESM-only, small, and has no runtime dependencies.

devops

npm install esbuild-html-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-HTML-PLUGI

esbuild-html-plugin

devopsjavascriptv1.1.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

htmlPlugin

✓ import { htmlPlugin } from 'esbuild-html-plugin'

✗ const htmlPlugin = require('esbuild-html-plugin')

Package is ESM-only; require() will fail.

htmlPlugin

✓ import { htmlPlugin } from 'esbuild-html-plugin'

✗ import htmlPlugin from 'esbuild-html-plugin'

Named export, not default. v1.0.1 added types to package.json, so TypeScript works.

HtmlPluginOptions

✓ import type { HtmlPluginOptions } from 'esbuild-html-plugin'

Available as a type export for TypeScript users.

Builds an esbuild bundle and generates an index.html with script tags for JS outputs.

import * as esbuild from 'esbuild'; import { htmlPlugin } from 'esbuild-html-plugin'; await esbuild.build({ entryPoints: ['app.ts'], bundle: true, outdir: 'dist', publicPath: '/static', plugins: [ htmlPlugin({ outfile: 'index.html', createHeadElements: () => [ `<meta charset="utf-8" />`, `<meta name="viewport" content="width=device-width, initial-scale=1" />`, `<title>Example</title>`, ], createBodyElements: (outputUrls) => outputUrls .filter((url) => url.endsWith('.js')) .map((url) => `<script src="${url}"></script>`), }), ], });

Debug

Known issues

breakingHTML minification feature removed in v1.1.0

fix

Remove any minification options. If needed, use a separate minification step.

affects: <=1.0.1

deprecatedDefault export removed; use named export htmlPlugin

fix

Change import to named export.

affects: <1.0.0

gotchaoutfile must be provided; outdir or esbuild's outfile must be set or the HTML won't be generated

fix

Ensure outfile is set and esbuild's outdir or outfile is configured.

affects: >=1.0.0

gotchacreateHeadElements and createBodyElements receive output URLs; they may be absolute or relative depending on publicPath

fix

Handle URLs as provided; use publicPath to control prefix.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'esbuild-html-plugin'

Missing installation or ESM-only package used with require()

fix

Run 'npm install esbuild-html-plugin' and use 'import' syntax.

TypeError: htmlPlugin is not a function

Default import used instead of named import

fix

Change to 'import { htmlPlugin } from 'esbuild-html-plugin''.

Error: The plugin "html-plugin" must be an object with a "name" and "setup" function

Misconfigured plugin parameter; likely passed undefined or wrong shape

fix

Ensure htmlPlugin is called: htmlPlugin({ outfile: 'index.html' }).

Upgrade

Version history

1.1.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/clebert/esbuild-html-plugin ↗

packagehttps://www.npmjs.com/package/esbuild-html-plugin ↗