dev: reference all the debug keys and env vars

internal/cache/default.go

@@ -5,14 +5,15 @@
 package cache
 
 import (
- "errors"
  "fmt"
  "log"
  "os"
  "path/filepath"
  "sync"
 )
 
+const envGolangciLintCache = "GOLANGCI_LINT_CACHE"
+
 // Default returns the default cache to use.
 func Default() (*Cache, error) {
  defaultOnce.Do(initDefaultCache)
@@ -65,19 +66,19 @@ func DefaultDir() string {
  // otherwise distinguish between an explicit "off" and a UserCacheDir error.
 
  defaultDirOnce.Do(func() {
- defaultDir = os.Getenv("GOLANGCI_LINT_CACHE")
+ defaultDir = os.Getenv(envGolangciLintCache)
  if filepath.IsAbs(defaultDir) {
  return
  }
  if defaultDir != "" {
- defaultDirErr = errors.New("GOLANGCI_LINT_CACHE is not an absolute path")
+ defaultDirErr = fmt.Errorf("%s is not an absolute path", envGolangciLintCache)
  return
  }
 
  // Compute default location.
  dir, err := os.UserCacheDir()
  if err != nil {
- defaultDirErr = fmt.Errorf("GOLANGCI_LINT_CACHE is not defined and %v", err)
+ defaultDirErr = fmt.Errorf("%s is not defined and %w", envGolangciLintCache, err)
  return
  }
  defaultDir = filepath.Join(dir, "golangci-lint")

pkg/commands/executor.go

@@ -64,11 +64,11 @@ func NewExecutor(version, commit, date string) *Executor {
  commit: commit,
  date: date,
  DBManager: lintersdb.NewManager(nil, nil),
- debugf: logutils.Debug("exec"),
+ debugf: logutils.Debug(logutils.DebugKeyExec),
  }
 
  e.debugf("Starting execution...")
- e.log = report.NewLogWrapper(logutils.NewStderrLog(""), &e.reportData)
+ e.log = report.NewLogWrapper(logutils.NewStderrLog(logutils.DebugKeyEmpty), &e.reportData)
 
  // to setup log level early we need to parse config from command line extra time to
  // find `-v` option
@@ -105,7 +105,7 @@ func NewExecutor(version, commit, date string) *Executor {
  // like the default ones. It will overwrite them only if the same option
  // is found in command-line: it's ok, command-line has higher priority.
 
- r := config.NewFileReader(e.cfg, commandLineCfg, e.log.Child("config_reader"))
+ r := config.NewFileReader(e.cfg, commandLineCfg, e.log.Child(logutils.DebugKeyConfigReader))
  if err = r.Read(); err != nil {
  e.log.Fatalf("Can't read config: %s", err)
  }
@@ -122,18 +122,18 @@ func NewExecutor(version, commit, date string) *Executor {
  fixSlicesFlags(e.lintersCmd.Flags())
 
  e.EnabledLintersSet = lintersdb.NewEnabledSet(e.DBManager,
- lintersdb.NewValidator(e.DBManager), e.log.Child("lintersdb"), e.cfg)
- e.goenv = goutil.NewEnv(e.log.Child("goenv"))
+ lintersdb.NewValidator(e.DBManager), e.log.Child(logutils.DebugKeyLintersDB), e.cfg)
+ e.goenv = goutil.NewEnv(e.log.Child(logutils.DebugKeyGoEnv))
  e.fileCache = fsutils.NewFileCache()
  e.lineCache = fsutils.NewLineCache(e.fileCache)
 
- e.sw = timeutils.NewStopwatch("pkgcache", e.log.Child("stopwatch"))
- e.pkgCache, err = pkgcache.NewCache(e.sw, e.log.Child("pkgcache"))
+ e.sw = timeutils.NewStopwatch("pkgcache", e.log.Child(logutils.DebugKeyStopwatch))
+ e.pkgCache, err = pkgcache.NewCache(e.sw, e.log.Child(logutils.DebugKeyPkgCache))
  if err != nil {
  e.log.Fatalf("Failed to build packages cache: %s", err)
  }
  e.loadGuard = load.NewGuard()
- e.contextLoader = lint.NewContextLoader(e.cfg, e.log.Child("loader"), e.goenv,
+ e.contextLoader = lint.NewContextLoader(e.cfg, e.log.Child(logutils.DebugKeyLoader), e.goenv,
  e.lineCache, e.fileCache, e.pkgCache, e.loadGuard)
  if err = e.initHashSalt(version); err != nil {
  e.log.Fatalf("Failed to init hash salt: %s", err)
@@ -169,7 +169,7 @@ func computeBinarySalt(version string) ([]byte, error) {
  return []byte(version), nil
  }
 
- if logutils.HaveDebugTag("bin_salt") {
+ if logutils.HaveDebugTag(logutils.DebugKeyBinSalt) {
  return []byte("debug"), nil
  }
 

pkg/commands/root.go

@@ -16,6 +16,12 @@ import (
  "github.com/golangci/golangci-lint/pkg/logutils"
 )
 
+const (
+ // envHelpRun value: "1".
+ envHelpRun = "HELP_RUN"
+ envMemProfileRate = "GL_MEM_PROFILE_RATE"
+)
+
 func (e *Executor) persistentPreRun(_ *cobra.Command, _ []string) error {
  if e.cfg.Run.PrintVersion {
  _, _ = fmt.Fprintf(logutils.StdOut, "golangci-lint has version %s built from %s on %s\n", e.version, e.commit, e.date)
@@ -35,7 +41,7 @@ func (e *Executor) persistentPreRun(_ *cobra.Command, _ []string) error {
  }
 
  if e.cfg.Run.MemProfilePath != "" {
- if rate := os.Getenv("GL_MEMPROFILE_RATE"); rate != "" {
+ if rate := os.Getenv(envMemProfileRate); rate != "" {
  runtime.MemProfileRate, _ = strconv.Atoi(rate)
  }
  }
@@ -112,7 +118,7 @@ func formatMemory(memBytes uint64) string {
 }
 
 func getDefaultConcurrency() int {
- if os.Getenv("HELP_RUN") == "1" {
+ if os.Getenv(envHelpRun) == "1" {
  // Make stable concurrency for README help generating builds.
  const prettyConcurrency = 8
  return prettyConcurrency

pkg/commands/run.go

@@ -28,6 +28,13 @@ import (
 
 const defaultFileMode = 0644
 
+const (
+ // envFailOnWarnings value: "1"
+ envFailOnWarnings = "FAIL_ON_WARNINGS"
+ // envMemLogEvery value: "1"
+ envMemLogEvery = "GL_MEM_LOG_EVERY"
+)
+
 func getDefaultIssueExcludeHelp() string {
  parts := []string{"Use or not use default excludes:"}
  for _, ep := range config.DefaultExcludePatterns {
@@ -350,9 +357,9 @@ func (e *Executor) runAnalysis(ctx context.Context, args []string) ([]result.Iss
  if err != nil {
  return nil, errors.Wrap(err, "context loading failed")
  }
- lintCtx.Log = e.log.Child("linters context")
+ lintCtx.Log = e.log.Child(logutils.DebugKeyLintersContext)
 
- runner, err := lint.NewRunner(e.cfg, e.log.Child("runner"),
+ runner, err := lint.NewRunner(e.cfg, e.log.Child(logutils.DebugKeyRunner),
  e.goenv, e.EnabledLintersSet, e.lineCache, e.DBManager, lintCtx.Packages)
  if err != nil {
  return nil, err
@@ -390,7 +397,7 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {
  e.log.Warnf("Failed to discover go env: %s", err)
  }
 
- if !logutils.HaveDebugTag("linters_output") {
+ if !logutils.HaveDebugTag(logutils.DebugKeyLintersOutput) {
  // Don't allow linters and loader to print anything
  log.SetOutput(io.Discard)
  savedStdout, savedStderr := e.setOutputToDevNull()
@@ -474,9 +481,9 @@ func (e *Executor) createPrinter(format string, w io.Writer) (printers.Printer,
  case config.OutFormatColoredLineNumber, config.OutFormatLineNumber:
  p = printers.NewText(e.cfg.Output.PrintIssuedLine,
  format == config.OutFormatColoredLineNumber, e.cfg.Output.PrintLinterName,
- e.log.Child("text_printer"), w)
+ e.log.Child(logutils.DebugKeyTextPrinter), w)
  case config.OutFormatTab:
- p = printers.NewTab(e.cfg.Output.PrintLinterName, e.log.Child("tab_printer"), w)
+ p = printers.NewTab(e.cfg.Output.PrintLinterName, e.log.Child(logutils.DebugKeyTabPrinter), w)
  case config.OutFormatCheckstyle:
  p = printers.NewCheckstyle(w)
  case config.OutFormatCodeClimate:
@@ -545,7 +552,7 @@ func (e *Executor) setupExitCode(ctx context.Context) {
  return
  }
 
- needFailOnWarnings := os.Getenv("GL_TEST_RUN") == "1" || os.Getenv("FAIL_ON_WARNINGS") == "1"
+ needFailOnWarnings := os.Getenv(lintersdb.EnvTestRun) == "1" || os.Getenv(envFailOnWarnings) == "1"
  if needFailOnWarnings && len(e.reportData.Warnings) != 0 {
  e.exitCode = exitcodes.WarningInTest
  return
@@ -569,7 +576,7 @@ func watchResources(ctx context.Context, done chan struct{}, logger logutils.Log
  ticker := time.NewTicker(intervalMS * time.Millisecond)
  defer ticker.Stop()
 
- logEveryRecord := os.Getenv("GL_MEM_LOG_EVERY") == "1"
+ logEveryRecord := os.Getenv(envMemLogEvery) == "1"
  const MB = 1024 * 1024
 
  track := func() {

pkg/golinters/commons.go

@@ -3,4 +3,4 @@ package golinters
 import "github.com/golangci/golangci-lint/pkg/logutils"
 
 // linterLogger must be use only when the context logger is not available.
-var linterLogger = logutils.NewStderrLog("linter")
+var linterLogger = logutils.NewStderrLog(logutils.DebugKeyLinter)

pkg/golinters/goanalysis/runner.go

@@ -28,17 +28,17 @@ import (
 )
 
 var (
- debugf = logutils.Debug("goanalysis")
+ debugf = logutils.Debug(logutils.DebugKeyGoAnalysis)
 
- analyzeDebugf = logutils.Debug("goanalysis/analyze")
- isMemoryDebug = logutils.HaveDebugTag("goanalysis/memory")
- issuesCacheDebugf = logutils.Debug("goanalysis/issues/cache")
+ analyzeDebugf = logutils.Debug(logutils.DebugKeyGoAnalysisAnalyze)
+ isMemoryDebug = logutils.HaveDebugTag(logutils.DebugKeyGoAnalysisMemory)
+ issuesCacheDebugf = logutils.Debug(logutils.DebugKeyGoAnalysisIssuesCache)
 
- factsDebugf = logutils.Debug("goanalysis/facts")
- factsCacheDebugf = logutils.Debug("goanalysis/facts/cache")
- factsInheritDebugf = logutils.Debug("goanalysis/facts/inherit")
- factsExportDebugf = logutils.Debug("goanalysis/facts")
- isFactsExportDebug = logutils.HaveDebugTag("goanalysis/facts/export")
+ factsDebugf = logutils.Debug(logutils.DebugKeyGoAnalysisFacts)
+ factsCacheDebugf = logutils.Debug(logutils.DebugKeyGoAnalysisFactsCache)
+ factsInheritDebugf = logutils.Debug(logutils.DebugKeyGoAnalysisFactsInherit)
+ factsExportDebugf = logutils.Debug(logutils.DebugKeyGoAnalysisFacts)
+ isFactsExportDebug = logutils.HaveDebugTag(logutils.DebugKeyGoAnalysisFactsExport)
 )
 
 type Diagnostic struct {

pkg/golinters/goanalysis/runners.go

@@ -14,6 +14,7 @@ import (
 
  "github.com/golangci/golangci-lint/internal/pkgcache"
  "github.com/golangci/golangci-lint/pkg/lint/linter"
+ "github.com/golangci/golangci-lint/pkg/logutils"
  "github.com/golangci/golangci-lint/pkg/result"
  "github.com/golangci/golangci-lint/pkg/timeutils"
 )
@@ -28,7 +29,7 @@ type runAnalyzersConfig interface {
 }
 
 func runAnalyzers(cfg runAnalyzersConfig, lintCtx *linter.Context) ([]result.Issue, error) {
- log := lintCtx.Log.Child("goanalysis")
+ log := lintCtx.Log.Child(logutils.DebugKeyGoAnalysis)
  sw := timeutils.NewStopwatch("analyzers", log)
 
  const stagesToPrint = 10

pkg/golinters/gocritic.go

@@ -26,8 +26,8 @@ import (
 const goCriticName = "gocritic"
 
 var (
- goCriticDebugf = logutils.Debug(goCriticName)
- isGoCriticDebug = logutils.HaveDebugTag(goCriticName)
+ goCriticDebugf = logutils.Debug(logutils.DebugKeyGoCritic)
+ isGoCriticDebug = logutils.HaveDebugTag(logutils.DebugKeyGoCritic)
 )
 
 func NewGoCritic(settings *config.GoCriticSettings, cfg *config.Config) *goanalysis.Linter {

pkg/golinters/revive.go

@@ -25,7 +25,7 @@ import (
 
 const reviveName = "revive"
 
-var reviveDebugf = logutils.Debug("revive")
+var reviveDebugf = logutils.Debug(logutils.DebugKeyRevive)
 
 // jsonObject defines a JSON object of a failure
 type jsonObject struct {

pkg/golinters/staticcheck_common.go

@@ -12,7 +12,7 @@ import (
  "github.com/golangci/golangci-lint/pkg/logutils"
 )
 
-var debugf = logutils.Debug("megacheck")
+var debugf = logutils.Debug(logutils.DebugKeyMegacheck)
 
 func getGoVersion(settings *config.StaticCheckSettings) string {
  var goVersion string

pkg/goutil/env.go

@@ -30,7 +30,7 @@ func NewEnv(log logutils.Log) *Env {
  return &Env{
  vars: map[string]string{},
  log: log,
- debugf: logutils.Debug("env"),
+ debugf: logutils.Debug(logutils.DebugKeyEnv),
  }
 }
 

pkg/lint/lintersdb/enabled_set.go

@@ -10,6 +10,9 @@ import (
  "github.com/golangci/golangci-lint/pkg/logutils"
 )
 
+// EnvTestRun value: "1"
+const EnvTestRun = "GL_TEST_RUN"
+
 type EnabledSet struct {
  m *Manager
  v *Validator
@@ -24,7 +27,7 @@ func NewEnabledSet(m *Manager, v *Validator, log logutils.Log, cfg *config.Confi
  v: v,
  log: log,
  cfg: cfg,
- debugf: logutils.Debug("enabled_linters"),
+ debugf: logutils.Debug(logutils.DebugKeyEnabledLinters),
  }
 }
 
@@ -84,7 +87,7 @@ func (es EnabledSet) GetEnabledLintersMap() (map[string]*linter.Config, error) {
  }
 
  enabledLinters := es.build(&es.cfg.Linters, es.m.GetAllEnabledByDefaultLinters())
- if os.Getenv("GL_TEST_RUN") == "1" {
+ if os.Getenv(EnvTestRun) == "1" {
  es.verbosePrintLintersStatus(enabledLinters)
  }
  return enabledLinters, nil

pkg/lint/lintersdb/manager.go

@@ -38,7 +38,7 @@ func NewManager(cfg *config.Config, log logutils.Log) *Manager {
 // WithCustomLinters loads private linters that are specified in the golangci config file.
 func (m *Manager) WithCustomLinters() *Manager {
  if m.log == nil {
- m.log = report.NewLogWrapper(logutils.NewStderrLog(""), &report.Data{})
+ m.log = report.NewLogWrapper(logutils.NewStderrLog(logutils.DebugKeyEmpty), &report.Data{})
  }
  if m.cfg != nil {
  for name, settings := range m.cfg.LintersSettings.Custom {

pkg/lint/load.go

@@ -41,7 +41,7 @@ func NewContextLoader(cfg *config.Config, log logutils.Log, goenv *goutil.Env,
  return &ContextLoader{
  cfg: cfg,
  log: log,
- debugf: logutils.Debug("loader"),
+ debugf: logutils.Debug(logutils.DebugKeyLoader),
  goenv: goenv,
  pkgTestIDRe: regexp.MustCompile(`^(.*) \[(.*)\.test\]`),
  lineCache: lineCache,
@@ -59,7 +59,7 @@ func (cl *ContextLoader) prepareBuildContext() {
  return
  }
 
- os.Setenv("GOROOT", goroot)
+ os.Setenv(string(goutil.EnvGoRoot), goroot)
  build.Default.GOROOT = goroot
  build.Default.BuildTags = cl.cfg.Run.BuildTags
 }