Skip to content

dev: linter log consistency #5327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 15, 2025
Merged

dev: linter log consistency #5327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe72773
dev log consistency
ldez Jan 15, 2025
44f1f95
chore isolate debug logs
ldez Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions pkg/golinters/gocritic/gocritic.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ func (w *goCriticWrapper) buildEnabledCheckers(linterCtx *gocriticlinter.Context
if err != nil {
return nil, err
}

enabledCheckers = append(enabledCheckers, c)
}

Expand Down Expand Up @@ -294,6 +295,7 @@ func (s *settingsWrapper) InferEnabledChecks() {
s.debugChecksInitialState()

enabledByDefaultChecks, disabledByDefaultChecks := s.buildEnabledAndDisabledByDefaultChecks()

debugChecksListf(enabledByDefaultChecks, "Enabled by default")
debugChecksListf(disabledByDefaultChecks, "Disabled by default")

Expand All @@ -314,7 +316,8 @@ func (s *settingsWrapper) InferEnabledChecks() {

if len(s.EnabledTags) != 0 {
enabledFromTags := s.expandTagsToChecks(s.EnabledTags)
debugChecksListf(enabledFromTags, "Enabled by config tags %s", sprintSortedStrings(s.EnabledTags))

debugChecksListf(enabledFromTags, "Enabled by config tags %s", s.EnabledTags)

for _, check := range enabledFromTags {
enabledChecks[check] = struct{}{}
Expand All @@ -335,7 +338,8 @@ func (s *settingsWrapper) InferEnabledChecks() {

if len(s.DisabledTags) != 0 {
disabledFromTags := s.expandTagsToChecks(s.DisabledTags)
debugChecksListf(disabledFromTags, "Disabled by config tags %s", sprintSortedStrings(s.DisabledTags))

debugChecksListf(disabledFromTags, "Disabled by config tags %s", s.DisabledTags)

for _, check := range disabledFromTags {
delete(enabledChecks, check)
Expand All @@ -356,6 +360,7 @@ func (s *settingsWrapper) InferEnabledChecks() {

s.inferredEnabledChecks = enabledChecks
s.inferredEnabledChecksLowerCased = normalizeMap(s.inferredEnabledChecks)

s.debugChecksFinalState()
}

Expand Down Expand Up @@ -549,10 +554,8 @@ func debugChecksListf(checks []string, format string, args ...any) {
return
}

debugf("%s checks (%d): %s", fmt.Sprintf(format, args...), len(checks), sprintSortedStrings(checks))
}
v := slices.Clone(checks)
slices.Sort(v)

func sprintSortedStrings(v []string) string {
sort.Strings(slices.Clone(v))
return fmt.Sprint(v)
debugf("%s checks (%d): %s", fmt.Sprintf(format, args...), len(checks), strings.Join(v, ", "))
}
14 changes: 7 additions & 7 deletions pkg/golinters/govet/govet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package govet

import (
"slices"
"sort"
"strings"

"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/appends"
Expand Down Expand Up @@ -164,8 +164,8 @@ func New(settings *config.GovetSettings) *goanalysis.Linter {
}

func analyzersFromConfig(settings *config.GovetSettings) []*analysis.Analyzer {
debugAnalyzersListf(allAnalyzers, "All available analyzers")
debugAnalyzersListf(defaultAnalyzers, "Default analyzers")
logAnalyzers("All available analyzers", allAnalyzers)
logAnalyzers("Default analyzers", defaultAnalyzers)

if settings == nil {
return defaultAnalyzers
Expand All @@ -178,7 +178,7 @@ func analyzersFromConfig(settings *config.GovetSettings) []*analysis.Analyzer {
}
}

debugAnalyzersListf(enabledAnalyzers, "Enabled by config analyzers")
logAnalyzers("Enabled by config analyzers", enabledAnalyzers)

return enabledAnalyzers
}
Expand Down Expand Up @@ -212,7 +212,7 @@ func isAnalyzerEnabled(name string, cfg *config.GovetSettings, defaultAnalyzers
}
}

func debugAnalyzersListf(analyzers []*analysis.Analyzer, message string) {
func logAnalyzers(message string, analyzers []*analysis.Analyzer) {
if !isDebug {
return
}
Expand All @@ -222,7 +222,7 @@ func debugAnalyzersListf(analyzers []*analysis.Analyzer, message string) {
analyzerNames = append(analyzerNames, a.Name)
}

sort.Strings(analyzerNames)
slices.Sort(analyzerNames)

debugf("%s (%d): %s", message, len(analyzerNames), analyzerNames)
debugf("%s (%d): %s", message, len(analyzerNames), strings.Join(analyzerNames, ", "))
}
Loading