Skip to content

Commit 808c06d

Browse files
alexandearalexandear
authored
dev: rename function parameter i to issue (#4460)
1 parent f18e6c3 commit 808c06d

23 files changed

+145
-145
lines changed

‎pkg/golinters/goanalysis/issue.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ type Issue struct {
1313
Pass *analysis.Pass
1414
}
1515

16-
func NewIssue(i *result.Issue, pass *analysis.Pass) Issue {
16+
func NewIssue(issue *result.Issue, pass *analysis.Pass) Issue {
1717
return Issue{
18-
Issue: *i,
18+
Issue: *issue,
1919
Pass: pass,
2020
}
2121
}

‎pkg/golinters/nolintlint/nolintlint.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@ func (i UnusedCandidate) Details() string {
107107

108108
func (i UnusedCandidate) String() string { return toString(i) }
109109

110-
func toString(i Issue) string {
111-
return fmt.Sprintf("%s at %s", i.Details(), i.Position())
110+
func toString(issue Issue) string {
111+
return fmt.Sprintf("%s at %s", issue.Details(), issue.Position())
112112
}
113113

114114
type Issue interface {

‎pkg/printers/tab.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ func (p *Tab) Print(issues []result.Issue) error {
5252
return nil
5353
}
5454

55-
func (p *Tab) printIssue(i *result.Issue, w io.Writer) {
56-
text := p.SprintfColored(color.FgRed, "%s", i.Text)
55+
func (p *Tab) printIssue(issue *result.Issue, w io.Writer) {
56+
text := p.SprintfColored(color.FgRed, "%s", issue.Text)
5757
if p.printLinterName {
58-
text = fmt.Sprintf("%s\t%s", i.FromLinter, text)
58+
text = fmt.Sprintf("%s\t%s", issue.FromLinter, text)
5959
}
6060

61-
pos := p.SprintfColored(color.Bold, "%s:%d", i.FilePath(), i.Line())
62-
if i.Pos.Column != 0 {
63-
pos += fmt.Sprintf(":%d", i.Pos.Column)
61+
pos := p.SprintfColored(color.Bold, "%s:%d", issue.FilePath(), issue.Line())
62+
if issue.Pos.Column != 0 {
63+
pos += fmt.Sprintf(":%d", issue.Pos.Column)
6464
}
6565

6666
fmt.Fprintf(w, "%s\t%s\n", pos, text)

‎pkg/printers/text.go‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,32 +55,32 @@ func (p *Text) Print(issues []result.Issue) error {
5555
return nil
5656
}
5757

58-
func (p *Text) printIssue(i *result.Issue) {
59-
text := p.SprintfColored(color.FgRed, "%s", strings.TrimSpace(i.Text))
58+
func (p *Text) printIssue(issue *result.Issue) {
59+
text := p.SprintfColored(color.FgRed, "%s", strings.TrimSpace(issue.Text))
6060
if p.printLinterName {
61-
text += fmt.Sprintf(" (%s)", i.FromLinter)
61+
text += fmt.Sprintf(" (%s)", issue.FromLinter)
6262
}
63-
pos := p.SprintfColored(color.Bold, "%s:%d", i.FilePath(), i.Line())
64-
if i.Pos.Column != 0 {
65-
pos += fmt.Sprintf(":%d", i.Pos.Column)
63+
pos := p.SprintfColored(color.Bold, "%s:%d", issue.FilePath(), issue.Line())
64+
if issue.Pos.Column != 0 {
65+
pos += fmt.Sprintf(":%d", issue.Pos.Column)
6666
}
6767
fmt.Fprintf(p.w, "%s: %s\n", pos, text)
6868
}
6969

70-
func (p *Text) printSourceCode(i *result.Issue) {
71-
for _, line := range i.SourceLines {
70+
func (p *Text) printSourceCode(issue *result.Issue) {
71+
for _, line := range issue.SourceLines {
7272
fmt.Fprintln(p.w, line)
7373
}
7474
}
7575

76-
func (p *Text) printUnderLinePointer(i *result.Issue) {
76+
func (p *Text) printUnderLinePointer(issue *result.Issue) {
7777
// if column == 0 it means column is unknown (e.g. for gosec)
78-
if len(i.SourceLines) != 1 || i.Pos.Column == 0 {
78+
if len(issue.SourceLines) != 1 || issue.Pos.Column == 0 {
7979
return
8080
}
8181

82-
col0 := i.Pos.Column - 1
83-
line := i.SourceLines[0]
82+
col0 := issue.Pos.Column - 1
83+
line := issue.SourceLines[0]
8484
prefixRunes := make([]rune, 0, len(line))
8585
for j := 0; j < len(line) && j < col0; j++ {
8686
if line[j] == '\t' {

‎pkg/result/processors/autogenerated_exclude.go‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,21 +46,21 @@ func isSpecialAutogeneratedFile(filePath string) bool {
4646
return filepath.Ext(fileName) != ".go"
4747
}
4848

49-
func (p *AutogeneratedExclude) shouldPassIssue(i *result.Issue) (bool, error) {
50-
if i.FromLinter == "typecheck" {
49+
func (p *AutogeneratedExclude) shouldPassIssue(issue *result.Issue) (bool, error) {
50+
if issue.FromLinter == "typecheck" {
5151
// don't hide typechecking errors in generated files: users expect to see why the project isn't compiling
5252
return true, nil
5353
}
5454

55-
if filepath.Base(i.FilePath()) == "go.mod" {
55+
if filepath.Base(issue.FilePath()) == "go.mod" {
5656
return true, nil
5757
}
5858

59-
if isSpecialAutogeneratedFile(i.FilePath()) {
59+
if isSpecialAutogeneratedFile(issue.FilePath()) {
6060
return false, nil
6161
}
6262

63-
fs, err := p.getOrCreateFileSummary(i)
63+
fs, err := p.getOrCreateFileSummary(issue)
6464
if err != nil {
6565
return false, err
6666
}
@@ -92,26 +92,26 @@ func isGeneratedFileByComment(doc string) bool {
9292
return false
9393
}
9494

95-
func (p *AutogeneratedExclude) getOrCreateFileSummary(i *result.Issue) (*ageFileSummary, error) {
96-
fs := p.fileSummaryCache[i.FilePath()]
95+
func (p *AutogeneratedExclude) getOrCreateFileSummary(issue *result.Issue) (*ageFileSummary, error) {
96+
fs := p.fileSummaryCache[issue.FilePath()]
9797
if fs != nil {
9898
return fs, nil
9999
}
100100

101101
fs = &ageFileSummary{}
102-
p.fileSummaryCache[i.FilePath()] = fs
102+
p.fileSummaryCache[issue.FilePath()] = fs
103103

104-
if i.FilePath() == "" {
104+
if issue.FilePath() == "" {
105105
return nil, errors.New("no file path for issue")
106106
}
107107

108-
doc, err := getDoc(i.FilePath())
108+
doc, err := getDoc(issue.FilePath())
109109
if err != nil {
110-
return nil, fmt.Errorf("failed to get doc of file %s: %w", i.FilePath(), err)
110+
return nil, fmt.Errorf("failed to get doc of file %s: %w", issue.FilePath(), err)
111111
}
112112

113113
fs.isGenerated = isGeneratedFileByComment(doc)
114-
autogenDebugf("file %q is generated: %t", i.FilePath(), fs.isGenerated)
114+
autogenDebugf("file %q is generated: %t", issue.FilePath(), fs.isGenerated)
115115
return fs, nil
116116
}
117117

‎pkg/result/processors/cgo.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ func (p Cgo) Name() string {
2626
}
2727

2828
func (p Cgo) Process(issues []result.Issue) ([]result.Issue, error) {
29-
return filterIssuesErr(issues, func(i *result.Issue) (bool, error) {
29+
return filterIssuesErr(issues, func(issue *result.Issue) (bool, error) {
3030
// some linters (e.g. gosec, deadcode) return incorrect filepaths for cgo issues,
3131
// also cgo files have strange issues looking like false positives.
3232

3333
// cache dir contains all preprocessed files including cgo files
3434

35-
issueFilePath := i.FilePath()
36-
if !filepath.IsAbs(i.FilePath()) {
37-
absPath, err := filepath.Abs(i.FilePath())
35+
issueFilePath := issue.FilePath()
36+
if !filepath.IsAbs(issue.FilePath()) {
37+
absPath, err := filepath.Abs(issue.FilePath())
3838
if err != nil {
39-
return false, fmt.Errorf("failed to build abs path for %q: %w", i.FilePath(), err)
39+
return false, fmt.Errorf("failed to build abs path for %q: %w", issue.FilePath(), err)
4040
}
4141
issueFilePath = absPath
4242
}
@@ -45,7 +45,7 @@ func (p Cgo) Process(issues []result.Issue) ([]result.Issue, error) {
4545
return false, nil
4646
}
4747

48-
if filepath.Base(i.FilePath()) == "_cgo_gotypes.go" {
48+
if filepath.Base(issue.FilePath()) == "_cgo_gotypes.go" {
4949
// skip cgo warning for go1.10
5050
return false, nil
5151
}

‎pkg/result/processors/diff.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,15 @@ func (p Diff) Process(issues []result.Issue) ([]result.Issue, error) {
6363
return nil, fmt.Errorf("can't prepare diff by revgrep: %w", err)
6464
}
6565

66-
return transformIssues(issues, func(i *result.Issue) *result.Issue {
67-
hunkPos, isNew := c.IsNewIssue(i)
66+
return transformIssues(issues, func(issue *result.Issue) *result.Issue {
67+
hunkPos, isNew := c.IsNewIssue(issue)
6868
if !isNew {
6969
return nil
7070
}
7171

72-
newI := *i
73-
newI.HunkPos = hunkPos
74-
return &newI
72+
newIssue := *issue
73+
newIssue.HunkPos = hunkPos
74+
return &newIssue
7575
}), nil
7676
}
7777

‎pkg/result/processors/exclude.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ func (p Exclude) Process(issues []result.Issue) ([]result.Issue, error) {
4444
return issues, nil
4545
}
4646

47-
return filterIssues(issues, func(i *result.Issue) bool {
48-
return !p.pattern.MatchString(i.Text)
47+
return filterIssues(issues, func(issue *result.Issue) bool {
48+
return !p.pattern.MatchString(issue.Text)
4949
}), nil
5050
}
5151

‎pkg/result/processors/exclude_rules.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ func (p ExcludeRules) Process(issues []result.Issue) ([]result.Issue, error) {
5454
if len(p.rules) == 0 {
5555
return issues, nil
5656
}
57-
return filterIssues(issues, func(i *result.Issue) bool {
57+
return filterIssues(issues, func(issue *result.Issue) bool {
5858
for _, rule := range p.rules {
5959
rule := rule
60-
if rule.match(i, p.files, p.log) {
60+
if rule.match(issue, p.files, p.log) {
6161
return false
6262
}
6363
}

‎pkg/result/processors/filename_unadjuster.go‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -102,29 +102,29 @@ func (p *FilenameUnadjuster) Name() string {
102102
}
103103

104104
func (p *FilenameUnadjuster) Process(issues []result.Issue) ([]result.Issue, error) {
105-
return transformIssues(issues, func(i *result.Issue) *result.Issue {
106-
issueFilePath := i.FilePath()
107-
if !filepath.IsAbs(i.FilePath()) {
108-
absPath, err := filepath.Abs(i.FilePath())
105+
return transformIssues(issues, func(issue *result.Issue) *result.Issue {
106+
issueFilePath := issue.FilePath()
107+
if !filepath.IsAbs(issue.FilePath()) {
108+
absPath, err := filepath.Abs(issue.FilePath())
109109
if err != nil {
110-
p.log.Warnf("failed to build abs path for %q: %s", i.FilePath(), err)
111-
return i
110+
p.log.Warnf("failed to build abs path for %q: %s", issue.FilePath(), err)
111+
return issue
112112
}
113113
issueFilePath = absPath
114114
}
115115

116116
mapper := p.m[issueFilePath]
117117
if mapper == nil {
118-
return i
118+
return issue
119119
}
120120

121-
newI := *i
122-
newI.Pos = mapper(i.Pos)
123-
if !p.loggedUnadjustments[i.Pos.Filename] {
124-
p.log.Infof("Unadjusted from %v to %v", i.Pos, newI.Pos)
125-
p.loggedUnadjustments[i.Pos.Filename] = true
121+
newIssue := *issue
122+
newIssue.Pos = mapper(issue.Pos)
123+
if !p.loggedUnadjustments[issue.Pos.Filename] {
124+
p.log.Infof("Unadjusted from %v to %v", issue.Pos, newIssue.Pos)
125+
p.loggedUnadjustments[issue.Pos.Filename] = true
126126
}
127-
return &newI
127+
return &newIssue
128128
}), nil
129129
}
130130

0 commit comments

Comments
 (0)