cli

Documentation

Index

• Variables
• func ReadStdinPipe() ([]byte, error)
• type Configuration
  • func NewConfiguration() *Configuration
  • func (conf *Configuration) GitlabBaseUrlOverwrite() string
  • func (conf *Configuration) Help()
  • func (conf *Configuration) Parse() error

Variables

var AutoDetectValue = "auto-detect"

AutoDetectValue indicates that the value should be detected automatically from a set of sources

var ErrAbort = errors.New("abort")

ErrAbort states that the regular execution should be aborted

Functions

func ReadStdinPipe

func ReadStdinPipe() ([]byte, error)

Types

type Configuration

type Configuration struct {
	GitLabCiFile       string
	GitlabBaseUrl      string
	GitlabToken        string
	Verbose            bool
	Debug              bool
	ShellcheckFlags    string
	OutputFormat       string
	FailSeverity       string
	ExcludedChecks     []string
	NoLintAPICallInCi  bool
	IncludedOPABundles []string
}

Configuration for the CLI

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration creates a new configuration

func (*Configuration) GitlabBaseUrlOverwrite

func (conf *Configuration) GitlabBaseUrlOverwrite() string

GitlabBaseUrlOverwrite returns an empty string in case the value should be automatically detected or otherwise the value of the cli parameter

func (*Configuration) Help

func (conf *Configuration) Help()

func (*Configuration) Parse

func (conf *Configuration) Parse() error

Parse the configuration from cli args