terraformlinter

Documentation

Overview

Package terraformlinter contains a linter implementation that verifies terraform files against our internal style guide and reports on all violations.

Index

• Constants
• type Config
• type Finding
  • func (f *Finding) String() string
• type Linter
  • func New(c *Config) (*Linter, error)
  • func (l *Linter) AddFinding(r *rules.Rule, lines [][]byte, t hclsyntax.Token)
  • func (l *Linter) Findings() []*Finding
  • func (l *Linter) Run(ctx context.Context, paths []string) error

Constants

const (
	None tokenPosition = iota
	LeadingStart
	LeadingEnd
	ProviderStart
	ProviderCenter
	ProviderEnd
	Ignored
	Trailing
)

Types

type Config

type Config struct {
	ExcludePaths []string
	IgnoreRules  []string
}

Config is the input to creating a new linter.

type Finding

type Finding struct {
	// contains filtered or unexported fields
}

func (*Finding) String

func (f *Finding) String() string

String reports a human-friendly version of the finding in the format:

<path>:<line>:<column>: <rule-id>: <message>
<snippet>
^

For example:

folder/file.tf:37:8: TF001: Things are broken
resource "foo" "bar-baz" {
                   ^

type Linter

type Linter struct {
	// contains filtered or unexported fields
}

Linter is an instance of a linter type.

func New

func New(c *Config) (*Linter, error)

New creates a new instance of a linter with the given config.

func (*Linter) AddFinding

func (l *Linter) AddFinding(r *rules.Rule, lines [][]byte, t hclsyntax.Token)

AddFinding adds a finding to the linter, skipping any ignored rules. It is safe for calling concurrently.

func (*Linter) Findings

func (l *Linter) Findings() []*Finding

Findings returns a all the findings, sorted by filename and then Rule ID.

func (*Linter) Run

func (l *Linter) Run(ctx context.Context, paths []string) error

Run executes the specified linter for a set of files.