tfeditor

Documentation

Index

• func NewFileFilter(filter BlockFilter) editor.Filter
• type BlockFilter
  • func NewMultiBlockFilter(filters []BlockFilter) BlockFilter
• type BlockFilterFunc
  • func (f BlockFilterFunc) BlockFilter(inFile *tfwrite.File, block tfwrite.Block) (*tfwrite.File, error)
• type DataSourceFilterFunc
• type FileFilter
  • func (f *FileFilter) Filter(inFile *hclwrite.File) (*hclwrite.File, error)
• type MultiBlockFilter
  • func (f *MultiBlockFilter) BlockFilter(inFile *tfwrite.File, block tfwrite.Block) (*tfwrite.File, error)
• type ProviderFilterFunc
• type ResourceFilterFunc
• type VerticalFormatterBlockFilter
  • func NewVerticalFormatterBlockFilter(blockType string, schemaType string) *VerticalFormatterBlockFilter
  • func (f *VerticalFormatterBlockFilter) BlockFilter(inFile *tfwrite.File, block tfwrite.Block) (*tfwrite.File, error)

Functions

func NewFileFilter

func NewFileFilter(filter BlockFilter) editor.Filter

NewFileFilter creates a new instance of NewFileFilter.

Types

type BlockFilter

type BlockFilter interface {
	// BlockFilter reads Terraform configuration and rewrite a given block,
	// and writes Terraform configuration.
	BlockFilter(*tfwrite.File, tfwrite.Block) (*tfwrite.File, error)
}

BlockFilter is an interface which reads Terraform configuration and rewrite a given block, and writes Terraform configuration.

func NewMultiBlockFilter

func NewMultiBlockFilter(filters []BlockFilter) BlockFilter

NewMultiBlockFilter creates a new instance of MultiBlockFilter.

type BlockFilterFunc

type BlockFilterFunc func(*tfwrite.File, tfwrite.Block) (*tfwrite.File, error)

BlockFilterFunc is a helper method for implementing a BlockFilter interface.

func (BlockFilterFunc) BlockFilter

func (f BlockFilterFunc) BlockFilter(inFile *tfwrite.File, block tfwrite.Block) (*tfwrite.File, error)

BlockFilter reads Terraform configuration and rewrite a given block, and writes Terraform configuration.

type DataSourceFilterFunc

type DataSourceFilterFunc = anyBlockFilterFunc[*tfwrite.DataSource]

DataSourceFilterFunc is a helper method for implementing a BlockFilter interface for DataSource.

type FileFilter

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

FileFilter is a Filter implementation for applying a filter to all blocks in a given file.

func (*FileFilter) Filter

func (f *FileFilter) Filter(inFile *hclwrite.File) (*hclwrite.File, error)

Filter applies a filter to all blocks in a given file.

type MultiBlockFilter

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

MultiBlockFilter is a BlockFilter implementation which applies multiple block filters to a given block in sequence.

func (*MultiBlockFilter) BlockFilter

func (f *MultiBlockFilter) BlockFilter(inFile *tfwrite.File, block tfwrite.Block) (*tfwrite.File, error)

BlockFilter applies multiple filters to a given block in sequence.

type ProviderFilterFunc

type ProviderFilterFunc = anyBlockFilterFunc[*tfwrite.Provider]

ProviderFilterFunc is a helper method for implementing a BlockFilter interface for Provider.

type ResourceFilterFunc

type ResourceFilterFunc = anyBlockFilterFunc[*tfwrite.Resource]

ResourceFilterFunc is a helper method for implementing a BlockFilter interface for Resource.

type VerticalFormatterBlockFilter

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

VerticalFormatterBlockFilter is a BlockFilter implementation to format HCL in vertical. At time of writing, the default hcl formatter does not support vertical formatting. However, it's useful in some cases such as removing a block because leading and trailing newline tokens don't belong to a block, so deleting a block leaves extra newline tokens.

func NewVerticalFormatterBlockFilter

func NewVerticalFormatterBlockFilter(blockType string, schemaType string) *VerticalFormatterBlockFilter

NewVerticalFormatterBlockFilter returns a new instance of VerticalFormatterBlockFilter.

func (*VerticalFormatterBlockFilter) BlockFilter

func (f *VerticalFormatterBlockFilter) BlockFilter(inFile *tfwrite.File, block tfwrite.Block) (*tfwrite.File, error)

BlockFilter reads Terraform configuration and rewrite a given block, and writes Terraform configuration. When block type or schema type is set, format a block only if matching.