Registry / devops / esbuild-codegen-plugin

esbuild-codegen-plugin

library2.1.0jsnpmunverified

An esbuild plugin (v2.1.0) for generating modules at bundle time, allowing dynamic code injection during builds. Part of the codegen-js monorepo, it provides a core library (`codegen-lib`) and loaders for esbuild, webpack, parcel, and bun. Supports both ESM and CJS output. Key differentiator: code generation at bundle time rather than pre-build scripts, enabling type-safe dynamic imports and real-time code generation based on build context. Released monthly with active maintenance.

devops

npm install esbuild-codegen-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-CODEGEN-PL

esbuild-codegen-plugin

devopsjavascriptv2.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.

esbuildCodegenPlugin

✓ import { esbuildCodegenPlugin } from 'esbuild-codegen-plugin'

✗ const esbuildCodegenPlugin = require('esbuild-codegen-plugin')

ESM-only since v2.0.0; CommonJS require will fail.

default

✓ import esbuildCodegenPlugin from 'esbuild-codegen-plugin'

✗ import { default as esbuildCodegenPlugin } from 'esbuild-codegen-plugin'

Default export is same as named export; both work but named is idiomatic.

PluginConfig

✓ import type { PluginConfig } from 'esbuild-codegen-plugin'

✗ import { PluginConfig } from 'esbuild-codegen-plugin'

PluginConfig is a TypeScript type; runtime import will be undefined.

Shows how to use esbuild-codegen-plugin to inject a generated module (build-time constant) during esbuild bundling.

import { build } from 'esbuild'; import { esbuildCodegenPlugin } from 'esbuild-codegen-plugin'; import { fileURLToPath } from 'url'; const __dirname = fileURLToPath(new URL('.', import.meta.url)); await build({ entryPoints: ['./src/app.ts'], bundle: true, outfile: './dist/bundle.js', plugins: [ esbuildCodegenPlugin({ // Generate a module that exports current build time './build-time.ts': `export const buildTime = ${JSON.stringify(Date.now())};`, }), ], });

Debug

Known issues

breakingv2.0.0 dropped CommonJS support — require() now throws.

fix

Switch to ESM imports: import { esbuildCodegenPlugin } from 'esbuild-codegen-plugin'.

affects: >=2.0.0

gotchaGenerated module paths must be relative to project root, not absolute.

fix

Use paths like './my-module.ts' instead of '/absolute/path/my-module.ts'.

affects: >=1.0.0

gotchaPlugin runs during build but before resolve — ensure generated modules don't conflict with existing files.

fix

Use unique paths or namespaced prefixes for generated modules.

affects: >=1.0.0

deprecatedThe 'generate' function from v1.x is removed; use the plugin constructor directly.

fix

Replace generate(config)(esbuildConfig) with esbuildCodegenPlugin(config) in plugin array.

affects: >=2.0.0

Errors

Common errors & fixes

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

Package not installed or resolution failure.

fix

Run npm install esbuild-codegen-plugin --save-dev

TypeError: esbuildCodegenPlugin is not a function

Using default import destructured incorrectly or using require with v2+.

fix

Use import { esbuildCodegenPlugin } from 'esbuild-codegen-plugin' (ESM only).

Error: Plugin must be an object with name and setup, got function

Passing the plugin function incorrectly (e.g., without calling it).

fix

Call the function: esbuildCodegenPlugin({...}) and pass its return value to plugins array.

Upgrade

Version history

2.1.0latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency: plugin runs on esbuild's plugin system

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/FlorianRappl/codegen-js ↗

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