README.md

mod2blob

This is considered pre-alpha

Overview

This module aims to quickly generate Bloblang functions and methods for use in Benthos Core. The tool, mod2blob, will accept a module argument -module (or env MODULE) that specifies the name of a golang module, such as math or hbollon/go-edlib. The tool will then parse all exported functions and generate bloblang functions and methods from that module.

Dependencies

• Golang (tested with 1.22.2)

Usage

Generate code from go standard library module:

mod2blob -module strings

Generate code from module on github:

mod2blob -module github.com/hbollon/go-edlib

Note: When specifying modules from remote repositories, the module will be cloned into $GOPATH/src. You must have GOPATH set to a location that is writable.

Example

To generate a bloblang plugin from the math module, we would run the following command:

mod2blob -module math

This would generate math.go which can be compiled into Benthos as a bloblang plugin.

For example, here is the auto-generated math.go:

package bloblang

import (
	"math"

	"github.com/benthosdev/benthos/v4/public/bloblang"
)

func init() {
	var err error

	objectAbsSpec := bloblang.NewPluginSpec().Param(bloblang.NewFloat64Param("x"))
	// Abs returns the absolute value of x.
	err = bloblang.RegisterFunctionV2("abs", objectAbsSpec,
		func(args *bloblang.ParsedParams) (bloblang.Function, error) {
			x, err := args.GetFloat64("x")
			if err != nil {
				return nil, err
			}

			xa := float64(x)
			return func() (interface{}, error) {
				return math.Abs(xa), nil
			}, nil
		})
	if err != nil {
		panic(err)
	}

      // ....code clipped
}