esbuild-decorators

Overview

This is a plugin for esbuild to handle the tsconfig setting "emitDecoratorMetadata": true,

When the decorator flag is set to true, the build process will inspect each .ts file and upon a decorator, will transpile with Typescript.

Usage

Install esbuild and the plugin

npm install -D esbuild esbuild-decorators
# or
pnpm install -D esbuild esbuild-decorators

Set up a build script

import { build } from 'esbuild';
import { esbuildDecorators } from '@anatine/esbuild-decorators'

async function myBuilder(
  tsconfig: string,
  entryPoints: string[],
  outfile: string,
  cwd: string = process.cwd()
) {
  const buildResult = await build({
    platform: 'node',
    target: 'node14',
    bundle: true,
    sourcemap: 'external',
    plugins: [
      esbuildDecorators({
        tsconfig,
        cwd,
      }),
    ],
    tsconfig,
    entryPoints,
    outfile,
    external: [
      // This is likely to be your friend...
    ],
  });
}

Run your builder.

Options

Option	Description
tsconfig	optional : string : The path and filename of the tsconfig.json
cwd	optional : string : The current working directory
force	optional : boolean : Will transpile all `.ts` files to Javascript with tsc
tsx	optional : boolean : Enable `.tsx` file support

Caveats

There is no doubt that this will affect the performance of esbuild. When emitDecoratorMetadata is set, every file will have to be loaded into this plugin.

This simple plugin hangs on the regex string: /((?<![(\s]\s*['"])@\w[.[\]\w\d]*\s*(?![;])[((?=\s)])/

Potentially esbuild could eventually do this regex search and expose positives via another plugin hook for transpiling.

Issue here: evanw/esbuild#991

Decorator Match Testing

Check out the test files and submit any issues or PRs if you see a pattern that should be covered.

Credits

Thanks to the anatine organization who's fork I've forked. This fork has valid peer deps and has an esm module and commonjs module.

reconbot / esbuild-decorators