Registry / devops / esbuild-plugin-extract-helpers

esbuild-plugin-extract-helpers

library0.0.10jsnpmunverified

Esbuild plugin (v0.0.11) that extracts CommonJS helper functions (like those from tslib) into a separate shared file, reducing bundle size when multiple CJS modules are emitted. The plugin hooks into esbuild's build process to deduplicate helper injections that esbuild otherwise inlines into each CJS module. Requires esbuild >=0.19.0 as a peer dependency. Currently a PoC with a focused API surface: configure CJS glob pattern, output directory, and helper filename. Ships TypeScript declarations, targets ESM-only consumption.

devops

npm install esbuild-plugin-extract-helpers

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-EXT

esbuild-plugin-extract-helpers

devopsjavascriptv0.0.10

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.

extractHelpersPlugin

✓ import { extractHelpersPlugin } from 'esbuild-plugin-extract-helpers'

✗ const extractHelpersPlugin = require('esbuild-plugin-extract-helpers')

The package is ESM-only; CommonJS require() will fail. Use dynamic import() if necessary.

PluginOptions

✓ import type { PluginOptions } from 'esbuild-plugin-extract-helpers'

✗ const { PluginOptions } = require('esbuild-plugin-extract-helpers')

PluginOptions is a TypeScript type; it is not exported at runtime. The wrong pattern would cause a runtime error if used as a value.

default export

✓ import extractHelpersPlugin from 'esbuild-plugin-extract-helpers'

✗ import extractHelpersPlugin, { PluginOptions } from 'esbuild-plugin-extract-helpers'

The package does not have a default export; only named exports are available. Attempting a default import yields undefined at runtime.

Demonstrates basic usage: creates the plugin with custom CJS output directory, file inclusion pattern, and helper filename, then invokes esbuild build with CJS format.

import { build } from 'esbuild' import { extractHelpersPlugin } from 'esbuild-plugin-extract-helpers' const plugin = extractHelpersPlugin({ cwd: 'dist', include: /\.cjs$/, helper: 'helpers.cjs' }) await build({ entryPoints: ['src/index.ts'], outdir: 'dist', format: 'cjs', plugins: [plugin], bundle: true })

Debug

Known issues

breakingThe package is ESM-only. Node.js versions that do not support ESM (Node <12) cannot load it.

fix

Use Node >=12 or upgrade to a version that supports ESM. Alternatively, use dynamic import() from a CommonJS file: import('esbuild-plugin-extract-helpers').then(m => m.extractHelpersPlugin(...))

affects: all

gotchaThe plugin only operates on files that match the `include` regex (default: /./). If your CJS files have a different extension (e.g., .js), they will be ignored.

fix

Adjust the `include` option to match your file patterns. For example, set include: /\.js$/

affects: all

gotchaThe plugin must be added to the esbuild `plugins` array **before** other plugins that may modify output files, otherwise helpers may not be correctly extracted.

fix

Place the extractHelpersPlugin as the first plugin in the plugins array.

affects: all

deprecatedVersion 0.0.8 introduced a fix that removed a redundant variable. If you are on an older version, update to 0.0.11 to get the latest fixes.

fix

Run `npm install esbuild-plugin-extract-helpers@latest`

affects: <0.0.8

Errors

Common errors & fixes

Error: Cannot find module 'esbuild-plugin-extract-helpers'

Package is not installed, or installed in a location not in require.resolve() path.

fix

Run `npm install esbuild-plugin-extract-helpers` in your project.

TypeError: extractHelpersPlugin is not a function

Attempted to use a default import when the package only exports named exports.

fix

Use named import: `import { extractHelpersPlugin } from 'esbuild-plugin-extract-helpers'`

Error: The plugin 'extract-helpers' must be used with format 'cjs'

The plugin is designed for CommonJS output; using it with 'esm' or 'iife' format will trigger an error.

fix

Set `format: 'cjs'` in the esbuild build options.

Upgrade

Version history

0.0.10latest on npm

Audit

Dependencies

esbuildrequiredPeer dependency; plugin hooks into esbuild's build lifecycle.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/antongolub/misc ↗

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