esbuild-plugin-summary

0.0.2 verified Fri May 01 auth: no javascript

esbuild plugin that outputs build summary information (time and file sizes) when using the JavaScript API, mirroring the CLI's built-in summary display. Current stable version is 0.0.2. It is a lightweight, zero-dependency plugin (aside from esbuild peer dependency >=0.19.2) that provides quick feedback during development. Unlike other build-time plugins, it focuses solely on simple timing and size reporting, making it easy to integrate into esbuild-based workflows.

Common errors

error Error: esbuild-plugin-summary requires esbuild version >=0.19.2 ↓

cause installed esbuild version is too old

fix

npm install esbuild@latest

error TypeError: summaryPlugin is not a function ↓

cause default import used instead of named import

fix

import { summaryPlugin } from 'esbuild-plugin-summary'

Warnings

breaking requires esbuild >=0.19.2; older versions are incompatible ↓

fix upgrade esbuild to 0.19.2 or later

Install

npm install esbuild-plugin-summary

yarn add esbuild-plugin-summary

pnpm add esbuild-plugin-summary

Imports

summaryPlugin

wrong

import summaryPlugin from 'esbuild-plugin-summary'

correct

import { summaryPlugin } from 'esbuild-plugin-summary'

ESM only; named export, not default. Requires esbuild >=0.19.2.

SummaryPluginOptions

wrong

import { SummaryPluginOptions } from 'esbuild-plugin-summary'

correct

import type { SummaryPluginOptions } from 'esbuild-plugin-summary'

TypeScript type import only; do not import at runtime.

Quickstart

Shows how to use esbuild-plugin-summary with esbuild to display build time and file sizes.

import * as esbuild from 'esbuild';
import { summaryPlugin } from 'esbuild-plugin-summary';

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