cmd

Documentation

Index

• func Data(ctx context.Context, blocks *parser.DefinedBlocks, caller *parser.Caller, ...) (result plugin.Data, diags diagnostics.Diag)
• func Execute()
• func Lint(ctx context.Context, eval *Evaluator, sourceDir fs.FS, fullLint bool) (diags diagnostics.Diag)
• func Render(ctx context.Context, blocks *parser.DefinedBlocks, pluginCaller *parser.Caller, ...) (results string, diags diagnostics.Diag)
• func UsageTemplate(argsDesc ...[2]string) string
• type Evaluator
  • func NewEvaluator() *Evaluator
  • func (e *Evaluator) Cleanup(diags diagnostics.Diag) error
  • func (e *Evaluator) LoadPluginResolver(includeRemote bool) diagnostics.Diag
  • func (e *Evaluator) LoadPluginRunner(ctx context.Context) diagnostics.Diag
  • func (e *Evaluator) ParseFabricFiles(sourceDir fs.FS) (diags diagnostics.Diag)
  • func (e *Evaluator) PluginCaller() *parser.Caller

Functions

func Data

func Data(ctx context.Context, blocks *parser.DefinedBlocks, caller *parser.Caller, target string) (result plugin.Data, diags diagnostics.Diag)

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func Lint

func Lint(ctx context.Context, eval *Evaluator, sourceDir fs.FS, fullLint bool) (diags diagnostics.Diag)

func Render

func Render(ctx context.Context, blocks *parser.DefinedBlocks, pluginCaller *parser.Caller, docName string) (results string, diags diagnostics.Diag)

func UsageTemplate

func UsageTemplate(argsDesc ...[2]string) string

Default usage template with added section for Args description

Types

type Evaluator

type Evaluator struct {
	Config   *definitions.GlobalConfig
	Blocks   *parser.DefinedBlocks
	Runner   *runner.Runner
	LockFile *resolver.LockFile
	Resolver *resolver.Resolver
	FileMap  map[string]*hcl.File
}

func NewEvaluator

func NewEvaluator() *Evaluator

func (*Evaluator) Cleanup

func (e *Evaluator) Cleanup(diags diagnostics.Diag) error

func (*Evaluator) LoadPluginResolver

func (e *Evaluator) LoadPluginResolver(includeRemote bool) diagnostics.Diag

func (*Evaluator) LoadPluginRunner

func (e *Evaluator) LoadPluginRunner(ctx context.Context) diagnostics.Diag

func (*Evaluator) ParseFabricFiles

func (e *Evaluator) ParseFabricFiles(sourceDir fs.FS) (diags diagnostics.Diag)

func (*Evaluator) PluginCaller

func (e *Evaluator) PluginCaller() *parser.Caller