@anatine/esbuild-decorators
TypeScript icon, indicating that this package has built-in type declarations

0.2.19 • Public • Published

esbuild-decorators

Testing/Build Known Vulnerabilities

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
npm install -D @anatine/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: https://github.com/evanw/esbuild/issues/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 Thomas Schaaf as this was his shared code that lead me here. Original Source

Thanks to the npm package strip-comments that was stripped down to cover only typescript comments and string removals

Package Sidebar

Install

npm i @anatine/esbuild-decorators

Weekly Downloads

20,962

Version

0.2.19

License

MIT

Unpacked Size

22.3 kB

Total Files

12

Last publish

Collaborators

  • anatidae