Skip to content

Commit 6709c97

Browse files
alexandearalexandear
authored
dev: refactor .golangci.yml configuration and fix up nolintlint issues (golangci#4537)
1 parent 02ea91d commit 6709c97

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+58
-75
lines changed

‎.golangci.yml‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@ linters-settings:
1717
logger:
1818
deny:
1919
# logging is allowed only by logutils.Log,
20-
# logrus is allowed to use only in logutils package.
2120
- pkg: "github.com/sirupsen/logrus"
2221
desc: logging is allowed only by logutils.Log.
2322
- pkg: "github.com/pkg/errors"
2423
desc: Should be replaced by standard lib errors package.
2524
- pkg: "github.com/instana/testify"
2625
desc: It's a fork of github.com/stretchr/testify.
26+
files:
27+
# logrus is allowed to use only in logutils package.
28+
- "!**/pkg/logutils/**.go"
2729
dupl:
2830
threshold: 100
2931
funlen:
@@ -86,10 +88,12 @@ linters-settings:
8688
line-length: 140
8789
misspell:
8890
locale: US
91+
ignore-words:
92+
- "importas" # linter name
8993
nolintlint:
9094
allow-unused: false # report any unused nolint directives
91-
require-explanation: false # don't require an explanation for nolint directives
92-
require-specific: false # don't require nolint directives to be specific about which linter is being skipped
95+
require-explanation: true # require an explanation for nolint directives
96+
require-specific: true # require nolint directives to be specific about which linter is being skipped
9397
revive:
9498
rules:
9599
- name: unexported-return
@@ -144,7 +148,9 @@ issues:
144148
exclude-rules:
145149
- path: _test\.go
146150
linters:
151+
- dupl
147152
- gomnd
153+
- lll
148154

149155
- path: pkg/golinters/errcheck.go
150156
linters: [staticcheck]
@@ -158,6 +164,10 @@ issues:
158164
- path: pkg/golinters/govet.go
159165
text: "SA1019: cfg.CheckShadowing is deprecated: the linter should be enabled inside `Enable`."
160166

167+
- path: pkg/golinters
168+
linters:
169+
- dupl
170+
161171
- path: pkg/golinters/gofumpt.go
162172
linters: [staticcheck]
163173
text: "SA1019: settings.LangVersion is deprecated: use the global `run.go` instead."

‎pkg/commands/flagsets.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func setupOutputFlagSet(v *viper.Viper, fs *pflag.FlagSet) {
8080
internal.AddFlagAndBind(v, fs, fs.Bool, "show-stats", "output.show-stats", false, color.GreenString("Show statistics per linter"))
8181
}
8282

83-
//nolint:gomnd
83+
//nolint:gomnd // magic numbers here is ok
8484
func setupIssuesFlagSet(v *viper.Viper, fs *pflag.FlagSet) {
8585
internal.AddHackedStringSliceP(fs, "exclude", "e", color.GreenString("Exclude issue by regexp"))
8686
internal.AddFlagAndBind(v, fs, fs.Bool, "exclude-use-default", "issues.exclude-use-default", true,

‎pkg/golinters/dogsled.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ import (
1616

1717
const dogsledName = "dogsled"
1818

19-
//nolint:dupl
2019
func NewDogsled(settings *config.DogsledSettings) *goanalysis.Linter {
2120
var mu sync.Mutex
2221
var resIssues []goanalysis.Issue

‎pkg/golinters/dupl.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import (
1717

1818
const duplName = "dupl"
1919

20-
//nolint:dupl
2120
func NewDupl(settings *config.DuplSettings) *goanalysis.Linter {
2221
var mu sync.Mutex
2322
var resIssues []goanalysis.Issue

‎pkg/golinters/forbidigo.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ import (
1616

1717
const forbidigoName = "forbidigo"
1818

19-
//nolint:dupl
2019
func NewForbidigo(settings *config.ForbidigoSettings) *goanalysis.Linter {
2120
var mu sync.Mutex
2221
var resIssues []goanalysis.Issue

‎pkg/golinters/funlen.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ import (
1616

1717
const funlenName = "funlen"
1818

19-
//nolint:dupl
2019
func NewFunlen(settings *config.FunlenSettings) *goanalysis.Linter {
2120
var mu sync.Mutex
2221
var resIssues []goanalysis.Issue

‎pkg/golinters/goanalysis/runner.go‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -177,10 +177,9 @@ func (r *runner) buildActionFactDeps(act *action, a *analysis.Analyzer, pkg *pac
177177
}
178178
}
179179

180-
//nolint:gocritic
181180
func (r *runner) prepareAnalysis(pkgs []*packages.Package,
182181
analyzers []*analysis.Analyzer,
183-
) (map[*packages.Package]bool, []*action, []*action) {
182+
) (initialPkgs map[*packages.Package]bool, allActions, roots []*action) {
184183
// Construct the action graph.
185184

186185
// Each graph node (action) is one unit of analysis.
@@ -200,13 +199,13 @@ func (r *runner) prepareAnalysis(pkgs []*packages.Package,
200199
actions := make(map[actKey]*action, totalActionsCount)
201200
actAlloc := newActionAllocator(totalActionsCount)
202201

203-
initialPkgs := make(map[*packages.Package]bool, len(pkgs))
202+
initialPkgs = make(map[*packages.Package]bool, len(pkgs))
204203
for _, pkg := range pkgs {
205204
initialPkgs[pkg] = true
206205
}
207206

208207
// Build nodes for initial packages.
209-
roots := make([]*action, 0, len(pkgs)*len(analyzers))
208+
roots = make([]*action, 0, len(pkgs)*len(analyzers))
210209
for _, a := range analyzers {
211210
for _, pkg := range pkgs {
212211
root := r.makeAction(a, pkg, initialPkgs, actions, actAlloc)
@@ -215,7 +214,7 @@ func (r *runner) prepareAnalysis(pkgs []*packages.Package,
215214
}
216215
}
217216

218-
allActions := maps.Values(actions)
217+
allActions = maps.Values(actions)
219218

220219
debugf("Built %d actions", len(actions))
221220

@@ -281,7 +280,6 @@ func (r *runner) analyze(pkgs []*packages.Package, analyzers []*analysis.Analyze
281280
return rootActions
282281
}
283282

284-
//nolint:nakedret
285283
func extractDiagnostics(roots []*action) (retDiags []Diagnostic, retErrors []error) {
286284
extracted := make(map[*action]bool)
287285
var extract func(*action)
@@ -338,5 +336,5 @@ func extractDiagnostics(roots []*action) (retDiags []Diagnostic, retErrors []err
338336
}
339337
}
340338
visitAll(roots)
341-
return
339+
return retDiags, retErrors
342340
}

‎pkg/golinters/goanalysis/runners.go‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,9 @@ func saveIssuesToCache(allPkgs []*packages.Package, pkgsFromCache map[*packages.
184184
issuesCacheDebugf("Saved %d issues from %d packages to cache in %s", savedIssuesCount, len(allPkgs), time.Since(startedAt))
185185
}
186186

187-
//nolint:gocritic
188187
func loadIssuesFromCache(pkgs []*packages.Package, lintCtx *linter.Context,
189188
analyzers []*analysis.Analyzer,
190-
) ([]result.Issue, map[*packages.Package]bool) {
189+
) (issuesFromCache []result.Issue, pkgsFromCache map[*packages.Package]bool) {
191190
startedAt := time.Now()
192191

193192
lintResKey := getIssuesCacheKey(analyzers)
@@ -221,17 +220,18 @@ func loadIssuesFromCache(pkgs []*packages.Package, lintCtx *linter.Context,
221220
}
222221

223222
issues := make([]result.Issue, 0, len(pkgIssues))
224-
for _, i := range pkgIssues {
223+
for i := range pkgIssues {
224+
issue := &pkgIssues[i]
225225
issues = append(issues, result.Issue{
226-
FromLinter: i.FromLinter,
227-
Text: i.Text,
228-
Severity: i.Severity,
229-
Pos: i.Pos,
230-
LineRange: i.LineRange,
231-
Replacement: i.Replacement,
226+
FromLinter: issue.FromLinter,
227+
Text: issue.Text,
228+
Severity: issue.Severity,
229+
Pos: issue.Pos,
230+
LineRange: issue.LineRange,
231+
Replacement: issue.Replacement,
232232
Pkg: pkg,
233-
ExpectNoLint: i.ExpectNoLint,
234-
ExpectedNoLintLinter: i.ExpectedNoLintLinter,
233+
ExpectNoLint: issue.ExpectNoLint,
234+
ExpectedNoLintLinter: issue.ExpectedNoLintLinter,
235235
})
236236
}
237237
cacheRes.issues = issues
@@ -246,21 +246,20 @@ func loadIssuesFromCache(pkgs []*packages.Package, lintCtx *linter.Context,
246246
wg.Wait()
247247

248248
loadedIssuesCount := 0
249-
var issues []result.Issue
250-
pkgsFromCache := map[*packages.Package]bool{}
249+
pkgsFromCache = map[*packages.Package]bool{}
251250
for pkg, cacheRes := range pkgToCacheRes {
252251
if cacheRes.loadErr == nil {
253252
loadedIssuesCount += len(cacheRes.issues)
254253
pkgsFromCache[pkg] = true
255-
issues = append(issues, cacheRes.issues...)
254+
issuesFromCache = append(issuesFromCache, cacheRes.issues...)
256255
issuesCacheDebugf("Loaded package %s issues (%d) from cache", pkg, len(cacheRes.issues))
257256
} else {
258257
issuesCacheDebugf("Didn't load package %s issues from cache: %s", pkg, cacheRes.loadErr)
259258
}
260259
}
261260
issuesCacheDebugf("Loaded %d issues from cache in %s, analyzing %d/%d packages",
262261
loadedIssuesCount, time.Since(startedAt), len(pkgs)-len(pkgsFromCache), len(pkgs))
263-
return issues, pkgsFromCache
262+
return issuesFromCache, pkgsFromCache
264263
}
265264

266265
func analyzersHashID(analyzers []*analysis.Analyzer) string {

‎pkg/golinters/gocognit.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ import (
1616

1717
const gocognitName = "gocognit"
1818

19-
//nolint:dupl
2019
func NewGocognit(settings *config.GocognitSettings) *goanalysis.Linter {
2120
var mu sync.Mutex
2221
var resIssues []goanalysis.Issue

‎pkg/golinters/goconst.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import (
1515

1616
const goconstName = "goconst"
1717

18-
//nolint:dupl
1918
func NewGoconst(settings *config.GoConstSettings) *goanalysis.Linter {
2019
var mu sync.Mutex
2120
var resIssues []goanalysis.Issue

0 commit comments

Comments
 (0)