tfconfig

Documentation

Index

• type Backend
• type Issue
• type Issues
  • func ModuleShouldHaveLocalBackendOverride(modules []*Module) Issues
  • func ModuleShouldHaveRemoteBackend(modules []*Module) Issues
  • func ModuleShouldHaveUniqueBackend(modules []*Module) Issues
  • func ParseRules(modules []*Module, rules []func([]*Module) Issues) (issues Issues)
• type Module
  • func LoadModules(workingDirs []string) (modules []*Module, diags hcl.Diagnostics)
• type ModuleBackend
• type Severity
  • func (s Severity) String() string

Types

type Backend

type Backend struct {
	Type       string
	Attributes map[string]string

	Range hcl.Range
}

type Issue

type Issue struct {
	Severity   Severity
	Message    string
	ModulePath string
	Range      *hcl.Range
}

type Issues

type Issues []*Issue

Issues is an alias for the map of Issue

func ModuleShouldHaveLocalBackendOverride

func ModuleShouldHaveLocalBackendOverride(modules []*Module) Issues

func ModuleShouldHaveRemoteBackend

func ModuleShouldHaveRemoteBackend(modules []*Module) Issues

func ModuleShouldHaveUniqueBackend

func ModuleShouldHaveUniqueBackend(modules []*Module) Issues

func ParseRules

func ParseRules(modules []*Module, rules []func([]*Module) Issues) (issues Issues)

type Module

type Module struct {
	// Path is the local filesystem directory where the module was loaded from.
	Path string `json:"path"`

	RequiredCore []string `json:"required_core,omitempty"`
	Backends     []*Backend
}

Module is the top-level type representing a parsed and processed Terraform module.

func LoadModules

func LoadModules(workingDirs []string) (modules []*Module, diags hcl.Diagnostics)

type ModuleBackend

type ModuleBackend struct {
	ModulePath string
	Backend    *Backend
}

type Severity

type Severity int32

const (
	// ERROR is possible errors
	ERROR Severity = iota
	// WARNING doesn't cause problem immediately, but not good
	WARNING
	// NOTICE is not important, it's mentioned
	NOTICE
)

func (Severity) String

func (s Severity) String() string

String returns the string representation of the severity.