plugin

package

v0.23.0 Latest Latest Go to latest Published: Sep 27, 2025 License: MPL-2.0 Imports: 2 Imported by: 65

Documentation ¶

Package plugin contains the implementations needed to make the built binary act as a plugin.

A plugin is implemented as an gRPC server and the host acts as the client, sending analysis requests to the plugin.

See internal/host2plugin for implementation details.

View Source

const SDKVersion = host2plugin.SDKVersion

SDKVersion is the SDK version.

View Source

var Serve = host2plugin.Serve

Serve is a wrapper of plugin.Serve. This is entrypoint of all plugins.

This section is empty.

type ServeOpts = host2plugin.ServeOpts

ServeOpts is an option for serving a plugin. Each plugin can pass a RuleSet that represents its own functionality.

Path	Synopsis
host2plugin Package host2plugin exposes a gRPC client for use on a host (TFLint).	Package host2plugin exposes a gRPC client for use on a host (TFLint).
internal
fromproto Package fromproto contains an implementation to decode a structure generated from *.proto into a real Go structure.	Package fromproto contains an implementation to decode a structure generated from *.proto into a real Go structure.
host2plugin Package host2plugin contains a gRPC server (plugin) and client (host).	Package host2plugin contains a gRPC server (plugin) and client (host).
interceptor Package interceptor contains gRPC interceptors.	Package interceptor contains gRPC interceptors.
plugin2host Package plugin2host contains a gRPC server (host) and client (plugin).	Package plugin2host contains a gRPC server (host) and client (plugin).
proto Package proto contains generated protocol buffers structures.	Package proto contains generated protocol buffers structures.
toproto Package toproto contains an implementation to encode a Go structure into a structure generated from *.proto.	Package toproto contains an implementation to encode a Go structure into a structure generated from *.proto.
plugin2host Package plugin2host exposes a gRPC server for use on a host (TFLint).	Package plugin2host exposes a gRPC server for use on a host (TFLint).