thundra-es-plugin

Installation

npm install --save-dev @thundra/esbuild-plugin

Usage

esbuild.js

/* eslint-disable @typescript-eslint/no-var-requires */
const { ThundraEsbuildPlugin } = require('@thundra/esbuild-plugin');

module.exports = {
  ...
  plugins: [
    ThundraEsbuildPlugin({
      traceableConfigs: [
        'src.*.*[traceLineByLine=true]', // activate line by line tracing for all files under src folder
      ]
    })
  ]
};

And then, in your Function definition in your stack, add the file above to your bundle configuration.

// ...
bundle: {
  esbuildConfig: {
    plugins: "esbuild.js",
  },
},
// ...

To use the plugin, 'ThundraEsbuildPlugin' must be used. Method will create a plugin for esbuild. This method takes argument like below.

| Name | Requirement | Description | --- | --- | --- | traceableConfigs | Required | Array of instrumentation defination string

Instrumentation definition strings must be in the <file-def>.<function-def>[parameter1=value1,parameter2=value2,...] format where the parameter definitions are optional. Asterisk character (*) in the <file-def> and <function-def> is supported.

Optional parameters that are specified between the brackets can be used to trace arguments and return values or to enable line by line tracing: traceArgs, traceReturnValue and traceLineByLine. You can use these parameters by setting them to true or false. By default all these parameters are set to false.

For example the value of a instrumentation definition string could be:

• To trace for all functions in js or ts files under ./src: src.*.*
• To trace all functions in js or ts files under ./src/service folder with arguments: src.service.*.*[traceArgs=true]
• To trace functions which start with get in the js or ts files under ./src/service folder with arguments and return value: src.service.*.get*[traceArgs=true,traceReturnValue=true]
• To enable TTD (Time Travel Debugging) for all functions in userService module (js or ts file) under ./src/service: src.service.userService.*[traceLineByLine=true]