plugin

Documentation

Index

• type List
  • func Discover() (*List, error)
  • func (l *List) All() []*pluginsdk.Client
  • func (l *List) Clean()
  • func (l *List) Get(name string) (*pluginsdk.Client, bool)

Types

type List

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

List is an object caching discovered plugins and their corresponding clients. Basically, it is a wrapper for go-plugin and provides an API to handle them collectively.

func Discover

func Discover() (*List, error)

Discover plugins and registers them. The lookup priority of plugins is as follow:

1. `TFDOCS_PLUGIN_DIR` environment variable (if it's set) 2. Current directory (./.tfdocs.d/plugins) 3. Home directory (~/.tfdocs.d/plugins)

Files under these directories that satisfy the "tfdocs-format-*" naming convention are treated as plugins.

func (*List) All

func (l *List) All() []*pluginsdk.Client

All returns all registered plugins.

func (*List) Clean

func (l *List) Clean()

Clean is a helper for ending plugin processes.

func (*List) Get

func (l *List) Get(name string) (*pluginsdk.Client, bool)

Get plugin by its name.