lang

type Attribute ¶

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

func (a *Attribute) IsComputedOnly() bool

func (a *Attribute) IsDeclared() bool

func (a *Attribute) Range() hcl.Range

func (a *Attribute) Schema() *tfjson.SchemaAttribute

type Block ¶

type Block interface {
	BlockAtPos(pos hcl.Pos) (Block, bool)
	Range() hcl.Range
	PosInBody(pos hcl.Pos) bool
	PosInAttribute(pos hcl.Pos) bool
	PosInAttributeValue(pos hcl.Pos) bool
	Attributes() map[string]*Attribute
	BlockTypes() map[string]*BlockType
}

Block represents a decoded HCL block (by a Parser) which keeps track of the related schema

func ParseBlock(tBlock ihcl.TokenizedBlock, schema *tfjson.SchemaBlock) Block

type BlockType ¶

type BlockType struct {
	BlockList []Block
	// contains filtered or unexported fields
}

func (b *BlockType) BlockAtPos(pos hcl.Pos) (Block, bool)

func (b *BlockType) PosInAttribute(pos hcl.Pos) bool

func (b *BlockType) PosInAttributeValue(pos hcl.Pos) bool

func (b *BlockType) ReachedMaxItems() bool

func (b *BlockType) Schema() *tfjson.SchemaBlockType

type BlockTypes ¶

type BlockTypes map[string]*BlockType

func (bt BlockTypes) AddBlock(name string, block *hclsyntax.Block, typeSchema *tfjson.SchemaBlockType)

type CompletionCandidate ¶ added in v0.2.0

type CompletionCandidate interface {
	Label() string
	Detail() string
	Documentation() MarkupContent
	Snippet() TextEdit
	PlainText() TextEdit
}

CompletionCandidate represents a candidate for completion loosely reflecting lsp.CompletionItem

type CompletionCandidates ¶ added in v0.2.0

type CompletionCandidates interface {
	List() []CompletionCandidate
	Len() int
	IsComplete() bool
}

CompletionCandidates represents a list of candidates for completion loosely reflecting lsp.CompletionList

type ConfigBlock ¶

type ConfigBlock interface {
	CompletionCandidatesAtPos(pos hcl.Pos) (CompletionCandidates, error)
	Name() string
	BlockType() string
	Labels() []*ParsedLabel
}

ConfigBlock implements an abstraction above HCL block which provides any LSP capabilities (e.g. completion)

type Label ¶ added in v0.2.0

type Label struct {
	Name          string
	IsCompletable bool
}

type LabelSchema ¶ added in v0.2.0

type LabelSchema []Label

type Markdown ¶ added in v0.3.0

type Markdown string

Markdown represents markdown formatted markup content for the LSP.

func (m Markdown) Value() string

type MarkupContent ¶ added in v0.3.0

type MarkupContent interface {
	// TODO: eventually will need to propapate Kind here once the LSP
	// protocol types we use support it
	Value() string
}

MarkupContent reflects lsp.MarkupContent

type ParsedLabel ¶ added in v0.3.0

type ParsedLabel struct {
	Name  string
	Value string
	Range hcl.Range
}

func LabelAtPos(labels []*ParsedLabel, pos hcl.Pos) (*ParsedLabel, bool)

func ParseLabels(tBlock ihcl.TokenizedBlock, schema LabelSchema) []*ParsedLabel

type Parser ¶

type Parser interface {
	SetLogger(*log.Logger)
	SetSchemaReader(schema.Reader)
	SetProviderReferences(addrs.ProviderReferences)
	BlockTypeCandidates(ihcl.TokenizedFile, hcl.Pos) CompletionCandidates
	CompletionCandidatesAtPos(ihcl.TokenizedFile, hcl.Pos) (CompletionCandidates, error)
}

Parser implements a parser which can turn raw HCL block into ConfigBlock with the help of a schema reader

func FindCompatibleParser(v string) (Parser, error)

type PlainText ¶ added in v0.3.0

type PlainText string

PlainText represents plain text markup content for the LSP.

func (m PlainText) Value() string

type TextEdit ¶ added in v0.3.0

type TextEdit interface {
	Range() *hcl.Range
	NewText() string
}

type TokenAtPosLooker ¶ added in v0.3.0

type TokenAtPosLooker interface {
	TokenAtPosition(hcl.Pos) (hclsyntax.Token, error)
}

type UnknownProviderErr ¶ added in v0.6.0

type UnknownProviderErr struct{}

func (e *UnknownProviderErr) Error() string