Registry / serialization / esbuild-plugin-emit-decorator-metadata

esbuild-plugin-emit-decorator-metadata

library0.2.3jsnpmunverified

An esbuild plugin that enables TypeScript's `emitDecoratorMetadata` option for decorators, generating metadata for `reflect-metadata`. Current version 0.2.3 requires esbuild ^0.14.29 to ^0.25.0. It rewrites and improves upon the original esbuild-decorators package, fixing broken source maps and adding worker-thread support for parallel transpilation. Supports both ESM and CommonJS, ships TypeScript types. Key differentiators: correct source map handling, optional workers for performance, and support for `.tsx` files. Best alternative to using `tsc` for decorator metadata in esbuild.

serialization

npm install esbuild-plugin-emit-decorator-metadata

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-EMI

esbuild-plugin-emit-decorator-metadata

serializationjavascriptv0.2.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.

esbuildEmitDecoratorMetadata

✓ import { esbuildEmitDecoratorMetadata } from 'esbuild-plugin-emit-decorator-metadata'

✗ const esbuildEmitDecoratorMetadata = require('esbuild-plugin-emit-decorator-metadata')

The package exports both ESM and CJS; named import works in both environments.

esbuildEmitDecoratorMetadata

✓ const { esbuildEmitDecoratorMetadata } = require('esbuild-plugin-emit-decorator-metadata')

✗ const plugin = require('esbuild-plugin-emit-decorator-metadata').default

CJS users must destructure; default export does not exist.

PluginOptions

✓ import type { esbuildEmitDecoratorMetadata } from 'esbuild-plugin-emit-decorator-metadata'

✗ import { PluginOptions } from 'esbuild-plugin-emit-decorator-metadata'

PluginOptions is not exported; only the function is exported. Use ReturnType<typeof esbuildEmitDecoratorMetadata> or inline type.

Shows basic esbuild build configuration using the plugin with automatic worker threads.

import { esbuildEmitDecoratorMetadata } from 'esbuild-plugin-emit-decorator-metadata'; import { resolve } from 'node:path'; import esbuild from 'esbuild'; await esbuild.build({ entryPoints: ['./src/index.ts'], outfile: './dist/bundle.js', bundle: true, platform: 'node', tsconfig: resolve('tsconfig.json'), plugins: [ esbuildEmitDecoratorMetadata({ tsconfig: resolve('tsconfig.json'), workers: 'auto', }), ], }); console.log('Build complete');

Debug

Known issues

gotchaUsing `esbuildEmitDecoratorMetadata` will significantly slow down builds because each file is transpiled by TypeScript separately. For large projects, consider using workers or incremental builds.

fix

Enable workers option: `workers: 'auto'` or `workers: true`. Also ensure `tsconfig` path is correct to avoid repeated resolution.

affects: >=0.1.0

gotchaThe plugin does not support `.tsx` files by default; you must pass `tsx: true` in options.

fix

Add `tsx: true` to the plugin options: `{ tsconfig: '...', tsx: true }`.

affects: >=0.1.0

deprecatedThe `force` option (transpile all `.ts` files) may be deprecated in future versions because it ignores esbuild's caching.

fix

Use it only for debugging; prefer letting esbuild handle caching.

affects: >=0.2.0

gotchaSource maps may be incorrect if `sourceRoot` is not set correctly. The plugin expects `sourceRoot` to be absolute path to source directory.

fix

Set `sourceRoot: resolve(process.cwd(), 'src')` in esbuild config.

affects: >=0.1.0

breakingVersion 0.2.0 changed the internal worker pool behavior: previously default was no workers, now default is `workers: 'auto'`.

fix

If you want to disable workers, explicitly set `workers: false`.

affects: >=0.2.0

Errors

Common errors & fixes

Error: Cannot find module 'esbuild-plugin-emit-decorator-metadata'

The package is not installed or not in the current project's dependencies.

fix

npm install -D esbuild-plugin-emit-decorator-metadata

TypeError: esbuildEmitDecoratorMetadata is not a function

Incorrect import style (e.g., default import instead of named import).

fix

Use named import: import { esbuildEmitDecoratorMetadata } from 'esbuild-plugin-emit-decorator-metadata'

Error: tsconfig file not found at /path/to/tsconfig.json

The `tsconfig` option path is incorrect or file does not exist.

fix

Ensure tsconfig path is absolute and valid: esbuildEmitDecoratorMetadata({ tsconfig: resolve(__dirname, 'tsconfig.json') })

Error: Decorator metadata emission is only supported when 'experimentalDecorators' and 'emitDecoratorMetadata' are enabled in tsconfig

The tsconfig.json does not have these options enabled.

fix

Add to tsconfig.json: { "compilerOptions": { "experimentalDecorators": true, "emitDecoratorMetadata": true } }

Upgrade

Version history

0.2.3latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency; plugin hooks into esbuild's build process

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/YevheniiYusenkov/esbuild-plugin-emit-decorator-metadata ↗

packagehttps://www.npmjs.com/package/esbuild-plugin-emit-decorator-metadata ↗