plugin

package

v0.20.0 Latest Latest Go to latest Published: Apr 4, 2025 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/terraform-docs/terraform-docs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type List ¶

func Discover ¶

func (*List) All ¶

func (*List) Clean ¶

func (*List) Get ¶

Source Files ¶

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.