mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 21:08:41 +07:00
54fc067bf4
Plugin can be developed on top of terraform-docs/plugin-sdk and made available to terraform-docs core project in: - ~/.tfdocs.d/plugins/ or - ./.tfdocs.d/plugins/ (this takes precedence if exists) Refer to the following for more details and examples: - https://github.com/terraform-docs/plugin-sdk - https://github.com/terraform-docs/tfdocs-format-template Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
47 lines
1.3 KiB
Go
47 lines
1.3 KiB
Go
package plugin
|
|
|
|
import (
|
|
goplugin "github.com/hashicorp/go-plugin"
|
|
|
|
pluginsdk "github.com/terraform-docs/plugin-sdk/plugin"
|
|
)
|
|
|
|
// namePrefix is the mandatory prefix for name of the plugin file. What
|
|
// comes after this is considered to be identifier of the plugin and in
|
|
// the overall ecosystem should be unique (as much as possible.)
|
|
const namePrefix = "tfdocs-format-"
|
|
|
|
// homePluginsRoot is the root directory of the plugins
|
|
var homePluginsRoot = "~/.tfdocs.d/plugins"
|
|
var localPluginsRoot = "./.tfdocs.d/plugins"
|
|
|
|
// 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.
|
|
type List struct {
|
|
formatters map[string]*pluginsdk.Client
|
|
clients map[string]*goplugin.Client
|
|
}
|
|
|
|
// All returns all registered plugins.
|
|
func (l *List) All() []*pluginsdk.Client {
|
|
all := make([]*pluginsdk.Client, len(l.formatters)-1)
|
|
for _, f := range l.formatters {
|
|
all = append(all, f)
|
|
}
|
|
return all
|
|
}
|
|
|
|
// Get plugin by its name.
|
|
func (l *List) Get(name string) (*pluginsdk.Client, bool) {
|
|
client, ok := l.formatters[name]
|
|
return client, ok
|
|
}
|
|
|
|
// Clean is a helper for ending plugin processes.
|
|
func (l *List) Clean() {
|
|
for _, client := range l.clients {
|
|
client.Kill()
|
|
}
|
|
}
|