Registry / devops / esbuild-metadata-report

esbuild-metadata-report

library1.0.3jsnpmunverified

A tool to generate an HTML report from esbuild's metafile output, visualizing bundle metadata such as file sizes, dependencies, and timings. Version 1.0.3, stable. Designed for esbuild, it works as a plugin or standalone function. Differentiable by its interactive, self-contained HTML report that aids debugging and optimization of esbuild builds. Supports CommonJS only.

devops

npm install esbuild-metadata-report

package ↗

INSTALL

IMPORT

SIG · ESBUILD-METADATA-R

esbuild-metadata-report

devopsjavascriptv1.0.3

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.

metadataReport

✓ const metadataReport = require('esbuild-metadata-report')

✗ import metadataReport from 'esbuild-metadata-report'

This package is CJS-only; ES import will fail.

metadataReport

✓ const metadataReport = require('esbuild-metadata-report')

Default export is the function/plugin factory.

metadataReport

✓ const metadataReport = require('esbuild-metadata-report')

✗ import { metadataReport } from 'esbuild-metadata-report'

Named export not available; the package exports a single default function.

Demonstrates using esbuild-metadata-report as an esbuild plugin to generate an HTML report from the build metafile.

const esbuild = require('esbuild'); const metadataReport = require('esbuild-metadata-report'); esbuild.build({ entryPoints: ['app.js'], bundle: true, outfile: 'out.js', metafile: true, plugins: [ metadataReport({ name: 'My Report', outputFile: 'report.html' }) ] }).catch(() => process.exit(1));

esbuild-metadata-report --version

Debug

Known issues

gotchaPackage does not provide TypeScript types despite having 'Ships TypeScript types: yes' in metadata. Actual types are missing.

fix

Install @types/esbuild-metadata-report if available, or create custom declarations.

affects: *

gotchaThe plugin requires metafile: true in esbuild options; otherwise, the report will be empty or error.

fix

Ensure metafile: true is set in esbuild.build options.

affects: *

deprecatedVersion 1.0.3 uses require; no ESM support. Future versions may drop CJS.

fix

Use dynamic import() in ESM projects if needed, but prefer require for now.

affects: 1.0.x

Errors

Common errors & fixes

Error: Cannot find module 'esbuild-metadata-report'

Package not installed or missing from node_modules.

fix

npm install esbuild-metadata-report

TypeError: metadataReport is not a function

Using ES import syntax (import) when package is CJS-only.

fix

Use const metadataReport = require('esbuild-metadata-report')

Error: metafile is required if using as a function

Using function form without passing metafile property.

fix

Pass metafile: result.metafile in options object.

Upgrade

Version history

1.0.3latest on npm

Audit

Dependencies

esbuildoptionalpeer dependency; the report is built from esbuild's metafile output

Agent activity

5 hits · last 30 days

node

Bingbot

Resources

packagehttps://www.npmjs.com/package/esbuild-metadata-report ↗