config

Documentation

Overview

Package config contains functions and structs related to config

Index

• Variables
• type Config
  • func NewConfig(configPath string) (*Config, error)
  • func (c Config) GetAsString() string
  • func (c Config) GetExcludesAsRegularExpression() string
  • func (c *Config) Merge(config Config)
  • func (c *Config) Parse() error
  • func (c Config) Save(version string) error
• type DisabledChecks

Variables

var DefaultExcludes = strings.Join(defaultExcludes, "|")

DefaultExcludes is the regular expression for ignored files

Types

type Config

type Config struct {
	// CLI
	ShowVersion bool
	Help        bool
	DryRun      bool
	Path        string

	// CONFIG FILE
	Version             string
	Verbose             bool
	Debug               bool
	IgnoreDefaults      bool
	SpacesAftertabs     bool
	NoColor             bool
	Exclude             []string
	AllowedContentTypes []string
	PassedFiles         []string
	Disable             DisabledChecks

	// MISC
	Logger             logger.Logger
	EditorconfigConfig *editorconfig.Config
}

Config struct, contains everything a config can contain

func NewConfig

func NewConfig(configPath string) (*Config, error)

NewConfig initializes a new config

func (Config) GetAsString

func (c Config) GetAsString() string

GetAsString returns the config in a readable form

func (Config) GetExcludesAsRegularExpression

func (c Config) GetExcludesAsRegularExpression() string

GetExcludesAsRegularExpression returns the excludes as a combined regular expression

func (*Config) Merge

func (c *Config) Merge(config Config)

Merge merges a provided config with a config

func (*Config) Parse

func (c *Config) Parse() error

Parse parses a config at a given path

func (Config) Save

func (c Config) Save(version string) error

Save saves the config to it's Path

type DisabledChecks

type DisabledChecks struct {
	EndOfLine              bool
	Indentation            bool
	InsertFinalNewline     bool
	TrimTrailingWhitespace bool
	IndentSize             bool
	MaxLineLength          bool
}

DisabledChecks is a Struct which represents disabled checks