plugin

package

v0.0.1 Latest Latest Go to latest Published: May 18, 2019 License: BSD-3-Clause Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Gofmt(src []byte) ([]byte, error)

Gofmt formats Go source code.

func GofmtReadWriter(rw io.ReadWriter) (io.ReadWriter, error)

GofmtReadWriter formats an io.ReadWriter, such as an *os.File.

type Func func(d *collector.Data) error

Func is a function which defines plugin behavior, and is provided a pointer to collector.Data.

type Plugin struct {
	// contains filtered or unexported fields
}

func New(name string) *Plugin

New returns a Plugin instance for a Plugin to be initialized.

func (p *Plugin) Init(fn Func)

Init is called by Plugin code and is provided a PluginFunc from the caller to handle the input Data (read from stdin).

func (p *Plugin) OutputTemplate(dst io.Writer, templatePath string, data interface{}) error

OutputTemplate executes a text template using the provided data and writes it to the destination io.Writer.

func (p *Plugin) OutputTemplateHTML(dst io.Writer, templatePath string, data interface{}) error

OutputTemplateHTML executes an HTML template using the provided data and writes it to the destination io.Writer.