cmd

Documentation

Index

• Constants
• type CLI
  • func NewCLI(outStream io.Writer, errStream io.Writer) (*CLI, error)
  • func (cli *CLI) Run(args []string) int
• type Options

Constants

const (
	ExitCodeOK int = iota
	ExitCodeError
	ExitCodeIssuesFound
)

Exit codes are int values that represent an exit code for a particular error.

Types

type CLI

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

CLI is the command line object

func NewCLI

func NewCLI(outStream io.Writer, errStream io.Writer) (*CLI, error)

NewCLI returns new CLI initialized by input streams

func (*CLI) Run

func (cli *CLI) Run(args []string) int

Run invokes the CLI with the given arguments.

type Options

type Options struct {
	Version                bool     `short:"v" long:"version" description:"Print TFLint version"`
	Init                   bool     `long:"init" description:"Install plugins"`
	Langserver             bool     `long:"langserver" description:"Start language server"`
	Format                 string   `` /* 149-byte string literal not displayed */
	Config                 string   `short:"c" long:"config" description:"Config file name (default: .tflint.hcl)" value-name:"FILE"`
	IgnoreModules          []string `long:"ignore-module" description:"Ignore module sources" value-name:"SOURCE"`
	EnableRules            []string `long:"enable-rule" description:"Enable rules from the command line" value-name:"RULE_NAME"`
	DisableRules           []string `long:"disable-rule" description:"Disable rules from the command line" value-name:"RULE_NAME"`
	Only                   []string `` /* 133-byte string literal not displayed */
	EnablePlugins          []string `long:"enable-plugin" description:"Enable plugins from the command line" value-name:"PLUGIN_NAME"`
	Varfiles               []string `long:"var-file" description:"Terraform variable file name" value-name:"FILE"`
	Variables              []string `long:"var" description:"Set a Terraform variable" value-name:"'foo=bar'"`
	Module                 *bool    `long:"module" description:"Enable module inspection" hidden:"true"`
	NoModule               *bool    `long:"no-module" description:"Disable module inspection" hidden:"true"`
	CallModuleType         *string  `long:"call-module-type" description:"Types of module to call (default: local)" choice:"all" choice:"local" choice:"none"`
	Chdir                  string   `long:"chdir" description:"Switch to a different working directory before executing the command" value-name:"DIR"`
	Recursive              bool     `long:"recursive" description:"Run command in each directory recursively"`
	Filter                 []string `long:"filter" description:"Filter issues by file names or globs" value-name:"FILE"`
	Force                  *bool    `long:"force" description:"Return zero exit status even if issues found"`
	MinimumFailureSeverity string   `` /* 160-byte string literal not displayed */
	Color                  bool     `long:"color" description:"Enable colorized output"`
	NoColor                bool     `long:"no-color" description:"Disable colorized output"`
	Fix                    bool     `long:"fix" description:"Fix issues automatically"`
	NoParallelRunners      bool     `long:"no-parallel-runners" description:"Disable per-runner parallelism"`
	MaxWorkers             *int     `` /* 127-byte string literal not displayed */
	ActAsBundledPlugin     bool     `long:"act-as-bundled-plugin" hidden:"true"`
	ActAsWorker            bool     `long:"act-as-worker" hidden:"true"`
}

Options is an option specified by arguments.