rules

Documentation

Index

• Variables
• type Rule

Variables

var (
	// Naming.
	HyphenInName = &Rule{"TF001", `Resource name must not contain a "-". Prefer underscores ("_") instead.`}

	// Ordering.
	ProviderNewline  = &Rule{"TF050", `Provider-specific attributes must have an additional newline separating them from the next section.`}
	MetaBlockNewline = &Rule{"TF051", `Meta block must have an additional newline separating it from the next section.`}

	// Ordering.
	LeadingMetaBlockAttribute  = &Rule{"TF100", `Attribute must be in the meta block at the top of the definition.`}
	ProviderAttributes         = &Rule{"TF101", `Attribute must be below any meta attributes (e.g. "for_each", "count") but above all other attributes. Attributes must be ordered organization > folder > project.`}
	TrailingMetaBlockAttribute = &Rule{"TF199", `Attribute must be at the bottom of the resource definition and in the order "depends_on" then "lifecycle."`}
)

Types

type Rule

type Rule struct {
	// ID is the unique identifier for the rule, used in ignore clauses.
	ID string

	// Description is the human-friendly description of the rule.
	Description string
}

Rule represents a single rule entry.