compiler

Documentation

Overview

Package compiler implements additional functionality for k6 to compile js code. more specifically wrapping code in CommonJS wrapper or transforming it through esbuild for typescript support. TODO this package name makes little sense now that it only parses and tranforms javascript. Although people do call such transformation - compilation, so maybe it is still fine

Index

• func StripTypes(src, filename string) (code string, srcMap []byte, err error)
• type Compiler
  • func New(logger logrus.FieldLogger) *Compiler
  • func (c *Compiler) Parse(src, filename string, commonJSWrap bool, esm bool) (prg *ast.Program, finalCode string, err error)
  • func (c *Compiler) WithUsage(u *usage.Usage)
• type Options

Functions

func StripTypes

func StripTypes(src, filename string) (code string, srcMap []byte, err error)

StripTypes transpiles the input source string and strip types from it. this is done using esbuild

Types

type Compiler

type Compiler struct {
	Options Options
	// contains filtered or unexported fields
}

A Compiler compiles JavaScript or TypeScript source code into a sobek.Program

func New

func New(logger logrus.FieldLogger) *Compiler

New returns a new Compiler

func (*Compiler) Parse

func (c *Compiler) Parse(
	src, filename string, commonJSWrap bool, esm bool,
) (prg *ast.Program, finalCode string, err error)

Parse parses the provided source. It wraps as the same as CommonJS support. The returned program can be compiled directly by Sobek. Additionally, it returns the end code that has been parsed including any required transformations.

func (*Compiler) WithUsage

func (c *Compiler) WithUsage(u *usage.Usage)

WithUsage allows the compiler to be given usage.Usage to use

type Options

type Options struct {
	CompatibilityMode lib.CompatibilityMode
	SourceMapLoader   func(string) ([]byte, error)
}

Options are options to the compiler