107 lines
3.2 KiB
Go
107 lines
3.2 KiB
Go
package logutils
|
|
|
|
import (
|
|
"os"
|
|
"strings"
|
|
)
|
|
|
|
// envDebug value: one or several debug keys.
|
|
// examples:
|
|
// - Remove output to `/dev/null`: `GL_DEBUG=linters_output ./golangci-lint run`
|
|
// - Show linters configuration: `GL_DEBUG=enabled_linters golangci-lint run`
|
|
// - Some analysis details: `GL_DEBUG=goanalysis/analyze,goanalysis/facts golangci-lint run`
|
|
const envDebug = "GL_DEBUG"
|
|
|
|
const (
|
|
DebugKeyAutogenExclude = "autogen_exclude" // Debugs a filter excluding autogenerated source code.
|
|
DebugKeyBinSalt = "bin_salt"
|
|
DebugKeyConfigReader = "config_reader"
|
|
DebugKeyEmpty = ""
|
|
DebugKeyEnabledLinters = "enabled_linters"
|
|
DebugKeyEnv = "env" // Debugs `go env` command.
|
|
DebugKeyExcludeRules = "exclude_rules"
|
|
DebugKeyExec = "exec"
|
|
DebugKeyFilenameUnadjuster = "filename_unadjuster"
|
|
DebugKeyForbidigo = "forbidigo"
|
|
DebugKeyGoEnv = "goenv"
|
|
DebugKeyLinter = "linter"
|
|
DebugKeyLintersContext = "linters_context"
|
|
DebugKeyLintersDB = "lintersdb"
|
|
DebugKeyLintersOutput = "linters_output"
|
|
DebugKeyLoader = "loader" // Debugs packages loading (including `go/packages` internal debugging).
|
|
DebugKeyMaxFromLinter = "max_from_linter"
|
|
DebugKeyMaxSameIssues = "max_same_issues"
|
|
DebugKeyPkgCache = "pkgcache"
|
|
DebugKeyRunner = "runner"
|
|
DebugKeySeverityRules = "severity_rules"
|
|
DebugKeySkipDirs = "skip_dirs"
|
|
DebugKeySourceCode = "source_code"
|
|
DebugKeyStopwatch = "stopwatch"
|
|
DebugKeyTabPrinter = "tab_printer"
|
|
DebugKeyTest = "test"
|
|
DebugKeyTextPrinter = "text_printer"
|
|
)
|
|
|
|
const (
|
|
DebugKeyGoAnalysis = "goanalysis"
|
|
|
|
DebugKeyGoAnalysisAnalyze = DebugKeyGoAnalysis + "/analyze"
|
|
DebugKeyGoAnalysisIssuesCache = DebugKeyGoAnalysis + "/issues/cache"
|
|
DebugKeyGoAnalysisMemory = DebugKeyGoAnalysis + "/memory"
|
|
|
|
DebugKeyGoAnalysisFacts = DebugKeyGoAnalysis + "/facts"
|
|
DebugKeyGoAnalysisFactsCache = DebugKeyGoAnalysisFacts + "/cache"
|
|
DebugKeyGoAnalysisFactsExport = DebugKeyGoAnalysisFacts + "/export"
|
|
DebugKeyGoAnalysisFactsInherit = DebugKeyGoAnalysisFacts + "/inherit"
|
|
)
|
|
|
|
const (
|
|
DebugKeyGoCritic = "gocritic" // Debugs `go-critic` linter.
|
|
DebugKeyMegacheck = "megacheck" // Debugs `staticcheck` related linters.
|
|
DebugKeyNolint = "nolint" // Debugs a filter excluding issues by `//nolint` comments.
|
|
DebugKeyRevive = "revive" // Debugs `revice` linter.
|
|
)
|
|
|
|
func getEnabledDebugs() map[string]bool {
|
|
ret := map[string]bool{}
|
|
debugVar := os.Getenv(envDebug)
|
|
if debugVar == "" {
|
|
return ret
|
|
}
|
|
|
|
for _, tag := range strings.Split(debugVar, ",") {
|
|
ret[tag] = true
|
|
}
|
|
|
|
return ret
|
|
}
|
|
|
|
var enabledDebugs = getEnabledDebugs()
|
|
|
|
type DebugFunc func(format string, args ...any)
|
|
|
|
func nopDebugf(_ string, _ ...any) {}
|
|
|
|
func Debug(tag string) DebugFunc {
|
|
if !enabledDebugs[tag] {
|
|
return nopDebugf
|
|
}
|
|
|
|
logger := NewStderrLog(tag)
|
|
logger.SetLevel(LogLevelDebug)
|
|
|
|
return func(format string, args ...any) {
|
|
logger.Debugf(format, args...)
|
|
}
|
|
}
|
|
|
|
func HaveDebugTag(tag string) bool {
|
|
return enabledDebugs[tag]
|
|
}
|
|
|
|
func SetupVerboseLog(log Log, isVerbose bool) {
|
|
if isVerbose {
|
|
log.SetLevel(LogLevelInfo)
|
|
}
|
|
}
|