rules

Documentation

Index

• Variables
• func CheckRuleNames(ruleNames []string) error
• type Rule
  • func NewRules(c *tflint.Config) []Rule
• type RuleSet
  • func (r *RuleSet) RuleNames() ([]string, error)
  • func (r *RuleSet) RuleSetName() (string, error)
  • func (r *RuleSet) RuleSetVersion() (string, error)

Variables

var DefaultRules = append(manualDefaultRules, modelRules...)

DefaultRules is rules by default

Functions

func CheckRuleNames

func CheckRuleNames(ruleNames []string) error

CheckRuleNames returns map of rules indexed by name

Types

type Rule

type Rule interface {
	Name() string
	Enabled() bool
	Check(runner *tflint.Runner) error
}

Rule is an implementation that receives a Runner and inspects for resources and modules.

func NewRules

func NewRules(c *tflint.Config) []Rule

NewRules returns rules according to configuration

type RuleSet

type RuleSet struct{}

RuleSet is a pseudo RuleSet to handle core rules like plugin

func (*RuleSet) RuleNames

func (r *RuleSet) RuleNames() ([]string, error)

RuleNames is a list of rule names provided by the plugin.

func (*RuleSet) RuleSetName

func (r *RuleSet) RuleSetName() (string, error)

RuleSetName is the name of the rule set.

func (*RuleSet) RuleSetVersion

func (r *RuleSet) RuleSetVersion() (string, error)

RuleSetVersion is the version of the plugin.