tflint-plugin-sdk

TFLint plugin SDK

TFLint plugin SDK for building custom rules.

NOTE: This plugin system is experimental. This means that API compatibility is frequently broken.

Requirements

• TFLint v0.14+
• Go v1.13

Usage

Please refer to tflint-ruleset-template for an example plugin implementation using this SDK.

Architecture

This plugin system uses go-plugin. TFLint launches the plugin as a sub-process and communicates with the plugin over RPC. The plugin acts as a server, while TFLint acts as a client that sends inspection requests to the plugin.

On the other hand, the plugin sends various requests to a server (TFLint) to get detailed runtime contexts (e.g. variables and expressions). This means that TFLint and plugins can act as both a server and a client.