package config import ( "time" ) type OutFormat string const ( OutFormatJSON = "json" OutFormatLineNumber = "line-number" OutFormatColoredLineNumber = "colored-line-number" ) var OutFormats = []string{OutFormatColoredLineNumber, OutFormatLineNumber, OutFormatJSON} type ExcludePattern struct { Pattern string Linter string Why string } var DefaultExcludePatterns = []ExcludePattern{ { Pattern: "Error return value of .((os\\.)?std(out|err)\\..*|.*Close|os\\.Remove(All)?|.*printf?|os\\.(Un)?Setenv). is not checked", Linter: "errcheck", Why: "Almost all programs ignore errors on these functions and in most cases it's ok", }, { Pattern: "(should have comment|comment on exported method|should have a package comment)", Linter: "golint", Why: "Annoying issue about not having a comment. The rare codebase has such comments", }, { Pattern: "func name will be used as test\\.Test.* by other packages, and that stutters; consider calling this", Linter: "golint", Why: "False positive when tests are defined in package 'test'", }, { Pattern: "Use of unsafe calls should be audited", Linter: "gas", Why: "Too many false-positives on 'unsafe' usage", }, { Pattern: "Subprocess launch(ed with variable|ing should be audited)", Linter: "gas", Why: "Too many false-positives for parametrized shell calls", }, { Pattern: "G104", Linter: "gas", Why: "Duplicated errcheck checks", }, { Pattern: "(Expect directory permissions to be 0750 or less|Expect file permissions to be 0600 or less)", Linter: "gas", Why: "Too many issues in popular repos", }, { Pattern: "Potential file inclusion via variable", Linter: "gas", Why: "False positive is triggered by 'src, err := ioutil.ReadFile(filename)'", }, { Pattern: "(possible misuse of unsafe.Pointer|should have signature)", Linter: "govet", Why: "Common false positives", }, { Pattern: "ineffective break statement. Did you mean to break out of the outer loop", Linter: "megacheck", Why: "Developers tend to write in C-style with an explicit 'break' in a 'switch', so it's ok to ignore", }, } func GetDefaultExcludePatternsStrings() []string { var ret []string for _, p := range DefaultExcludePatterns { ret = append(ret, p.Pattern) } return ret } type Run struct { IsVerbose bool `mapstructure:"verbose"` CPUProfilePath string MemProfilePath string Concurrency int PrintResourcesUsage bool `mapstructure:"print-resources-usage"` Config string NoConfig bool Args []string BuildTags []string `mapstructure:"build-tags"` ExitCodeIfIssuesFound int `mapstructure:"issues-exit-code"` AnalyzeTests bool `mapstructure:"tests"` Deadline time.Duration PrintVersion bool } type LintersSettings struct { Errcheck struct { CheckTypeAssertions bool `mapstructure:"check-type-assertions"` CheckAssignToBlank bool `mapstructure:"check-blank"` } Govet struct { CheckShadowing bool `mapstructure:"check-shadowing"` } Golint struct { MinConfidence float64 `mapstructure:"min-confidence"` } Gofmt struct { Simplify bool } Gocyclo struct { MinComplexity int `mapstructure:"min-complexity"` } Varcheck struct { CheckExportedFields bool `mapstructure:"exported-fields"` } Structcheck struct { CheckExportedFields bool `mapstructure:"exported-fields"` } Maligned struct { SuggestNewOrder bool `mapstructure:"suggest-new"` } Dupl struct { Threshold int } Goconst struct { MinStringLen int `mapstructure:"min-len"` MinOccurrencesCount int `mapstructure:"min-occurrences"` } Depguard struct { ListType string `mapstructure:"list-type"` Packages []string IncludeGoRoot bool `mapstructure:"inlude-go-root"` } } type Linters struct { Enable []string Disable []string EnableAll bool `mapstructure:"enable-all"` DisableAll bool `mapstructure:"disable-all"` Fast bool Presets []string } type Issues struct { ExcludePatterns []string `mapstructure:"exclude"` UseDefaultExcludes bool `mapstructure:"exclude-use-default"` MaxIssuesPerLinter int `mapstructure:"max-issues-per-linter"` MaxSameIssues int `mapstructure:"max-same-issues"` DiffFromRevision string `mapstructure:"new-from-rev"` DiffPatchFilePath string `mapstructure:"new-from-patch"` Diff bool `mapstructure:"new"` } type Config struct { //nolint:maligned Run Run Output struct { Format string PrintIssuedLine bool `mapstructure:"print-issued-lines"` PrintLinterName bool `mapstructure:"print-linter-name"` PrintWelcomeMessage bool `mapstructure:"print-welcome"` } LintersSettings LintersSettings `mapstructure:"linters-settings"` Linters Linters Issues Issues InternalTest bool // Option is used only for testing golangci-lint code, don't use it }