dev: remove unused ctx parameter from Printer

alexandear · alexandear · commit 53a3b233e232 · 2023-04-03T11:44:36.000+03:00
Also, enable revive `unused-parameter` rule for detecting this.
And fix occurred issues in other files.
diff --git a/.golangci.yml b/.golangci.yml
@@ -67,6 +67,7 @@ linters-settings:
     rules:
       - name: unexported-return
         disabled: true
+      - name: unused-parameter
 
 linters:
   disable-all: true
diff --git a/pkg/commands/run.go b/pkg/commands/run.go
@@ -411,7 +411,7 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {
 			out = append(out, "")
 		}
 
-		err := e.printReports(ctx, issues, out[1], out[0])
+		err := e.printReports(issues, out[1], out[0])
 		if err != nil {
 			return err
 		}
@@ -424,7 +424,7 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {
 	return nil
 }
 
-func (e *Executor) printReports(ctx context.Context, issues []result.Issue, path, format string) error {
+func (e *Executor) printReports(issues []result.Issue, path, format string) error {
 	w, shouldClose, err := e.createWriter(path)
 	if err != nil {
 		return fmt.Errorf("can't create output for %s: %w", path, err)
@@ -438,7 +438,7 @@ func (e *Executor) printReports(ctx context.Context, issues []result.Issue, path
 		return err
 	}
 
-	if err = p.Print(ctx, issues); err != nil {
+	if err = p.Print(issues); err != nil {
 		if file, ok := w.(io.Closer); shouldClose && ok {
 			_ = file.Close()
 		}
diff --git a/pkg/golinters/gocritic_test.go b/pkg/golinters/gocritic_test.go
@@ -56,6 +56,6 @@ func (l *tLog) Infof(format string, args ...any) {
 	log.Printf(format, args...)
 }
 
-func (l *tLog) Child(name string) logutils.Log { return nil }
+func (l *tLog) Child(_ string) logutils.Log { return nil }
 
-func (l *tLog) SetLevel(level logutils.LogLevel) {}
+func (l *tLog) SetLevel(_ logutils.LogLevel) {}
diff --git a/pkg/logutils/logutils.go b/pkg/logutils/logutils.go
@@ -79,7 +79,7 @@ var enabledDebugs = getEnabledDebugs()
 
 type DebugFunc func(format string, args ...any)
 
-func nopDebugf(format string, args ...any) {}
+func nopDebugf(_ string, _ ...any) {}
 
 func Debug(tag string) DebugFunc {
 	if !enabledDebugs[tag] {
diff --git a/pkg/printers/checkstyle.go b/pkg/printers/checkstyle.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"encoding/xml"
 	"fmt"
 	"io"
@@ -41,7 +40,7 @@ func NewCheckstyle(w io.Writer) *Checkstyle {
 	return &Checkstyle{w: w}
 }
 
-func (p Checkstyle) Print(ctx context.Context, issues []result.Issue) error {
+func (p Checkstyle) Print(issues []result.Issue) error {
 	out := checkstyleOutput{
 		Version: "5.0",
 	}
diff --git a/pkg/printers/checkstyle_test.go b/pkg/printers/checkstyle_test.go
@@ -2,7 +2,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"strings"
 	"testing"
@@ -47,7 +46,7 @@ func TestCheckstyle_Print(t *testing.T) {
 	buf := new(bytes.Buffer)
 	printer := NewCheckstyle(buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	//nolint:lll
diff --git a/pkg/printers/codeclimate.go b/pkg/printers/codeclimate.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -35,7 +34,7 @@ func NewCodeClimate(w io.Writer) *CodeClimate {
 	return &CodeClimate{w: w}
 }
 
-func (p CodeClimate) Print(ctx context.Context, issues []result.Issue) error {
+func (p CodeClimate) Print(issues []result.Issue) error {
 	codeClimateIssues := make([]CodeClimateIssue, 0, len(issues))
 	for i := range issues {
 		issue := &issues[i]
diff --git a/pkg/printers/codeclimate_test.go b/pkg/printers/codeclimate_test.go
@@ -2,7 +2,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -61,7 +60,7 @@ func TestCodeClimate_Print(t *testing.T) {
 	buf := new(bytes.Buffer)
 	printer := NewCodeClimate(buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	//nolint:lll
diff --git a/pkg/printers/github.go b/pkg/printers/github.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"fmt"
 	"io"
 
@@ -36,7 +35,7 @@ func formatIssueAsGithub(issue *result.Issue) string {
 	return ret
 }
 
-func (p *github) Print(_ context.Context, issues []result.Issue) error {
+func (p *github) Print(issues []result.Issue) error {
 	for ind := range issues {
 		_, err := fmt.Fprintln(p.w, formatIssueAsGithub(&issues[ind]))
 		if err != nil {
diff --git a/pkg/printers/github_test.go b/pkg/printers/github_test.go
@@ -3,7 +3,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -47,7 +46,7 @@ func TestGithub_Print(t *testing.T) {
 	buf := new(bytes.Buffer)
 	printer := NewGithub(buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	expected := `::warning file=path/to/filea.go,line=10,col=4::some issue (linter-a)
diff --git a/pkg/printers/html.go b/pkg/printers/html.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"fmt"
 	"html/template"
 	"io"
@@ -131,7 +130,7 @@ func NewHTML(w io.Writer) *HTML {
 	return &HTML{w: w}
 }
 
-func (p HTML) Print(_ context.Context, issues []result.Issue) error {
+func (p HTML) Print(issues []result.Issue) error {
 	var htmlIssues []htmlIssue
 
 	for i := range issues {
diff --git a/pkg/printers/html_test.go b/pkg/printers/html_test.go
@@ -2,7 +2,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -153,7 +152,7 @@ func TestHTML_Print(t *testing.T) {
 	buf := new(bytes.Buffer)
 	printer := NewHTML(buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	assert.Equal(t, expectedHTML, buf.String())
diff --git a/pkg/printers/json.go b/pkg/printers/json.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"encoding/json"
 	"io"
 
@@ -26,7 +25,7 @@ type JSONResult struct {
 	Report *report.Data
 }
 
-func (p JSON) Print(ctx context.Context, issues []result.Issue) error {
+func (p JSON) Print(issues []result.Issue) error {
 	res := JSONResult{
 		Issues: issues,
 		Report: p.rd,
diff --git a/pkg/printers/json_test.go b/pkg/printers/json_test.go
@@ -2,7 +2,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -47,7 +46,7 @@ func TestJSON_Print(t *testing.T) {
 
 	printer := NewJSON(nil, buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	//nolint:lll
diff --git a/pkg/printers/junitxml.go b/pkg/printers/junitxml.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"encoding/xml"
 	"fmt"
 	"io"
@@ -45,7 +44,7 @@ func NewJunitXML(w io.Writer) *JunitXML {
 	return &JunitXML{w: w}
 }
 
-func (p JunitXML) Print(ctx context.Context, issues []result.Issue) error {
+func (p JunitXML) Print(issues []result.Issue) error {
 	suites := make(map[string]testSuiteXML) // use a map to group by file
 
 	for ind := range issues {
diff --git a/pkg/printers/junitxml_test.go b/pkg/printers/junitxml_test.go
@@ -3,7 +3,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -47,7 +46,7 @@ func TestJunitXML_Print(t *testing.T) {
 	buf := new(bytes.Buffer)
 	printer := NewJunitXML(buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	expected := `<testsuites>
diff --git a/pkg/printers/printer.go b/pkg/printers/printer.go
@@ -1,11 +1,9 @@
 package printers
 
 import (
-	"context"
-
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
 type Printer interface {
-	Print(ctx context.Context, issues []result.Issue) error
+	Print(issues []result.Issue) error
 }
diff --git a/pkg/printers/tab.go b/pkg/printers/tab.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"fmt"
 	"io"
 	"text/tabwriter"
@@ -31,7 +30,7 @@ func (p *Tab) SprintfColored(ca color.Attribute, format string, args ...any) str
 	return c.Sprintf(format, args...)
 }
 
-func (p *Tab) Print(ctx context.Context, issues []result.Issue) error {
+func (p *Tab) Print(issues []result.Issue) error {
 	w := tabwriter.NewWriter(p.w, 0, 0, 2, ' ', 0)
 
 	for i := range issues {
diff --git a/pkg/printers/tab_test.go b/pkg/printers/tab_test.go
@@ -2,7 +2,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -48,7 +47,7 @@ func TestTab_Print(t *testing.T) {
 
 	printer := NewTab(true, logutils.NewStderrLog(logutils.DebugKeyEmpty), buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	expected := `path/to/filea.go:10:4   linter-a  some issue
diff --git a/pkg/printers/teamcity.go b/pkg/printers/teamcity.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"fmt"
 	"io"
 	"strings"
@@ -38,7 +37,7 @@ func NewTeamCity(w io.Writer) *TeamCity {
 	}
 }
 
-func (p *TeamCity) Print(_ context.Context, issues []result.Issue) error {
+func (p *TeamCity) Print(issues []result.Issue) error {
 	uniqLinters := map[string]struct{}{}
 
 	for i := range issues {
diff --git a/pkg/printers/teamcity_test.go b/pkg/printers/teamcity_test.go
@@ -2,7 +2,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -54,7 +53,7 @@ func TestTeamCity_Print(t *testing.T) {
 	buf := new(bytes.Buffer)
 	printer := NewTeamCity(buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	expected := `##teamcity[InspectionType id='linter-a' name='linter-a' description='linter-a' category='Golangci-lint reports']
diff --git a/pkg/printers/text.go b/pkg/printers/text.go
@@ -1,7 +1,6 @@
 package printers
 
 import (
-	"context"
 	"fmt"
 	"io"
 	"strings"
@@ -40,7 +39,7 @@ func (p *Text) SprintfColored(ca color.Attribute, format string, args ...any) st
 	return c.Sprintf(format, args...)
 }
 
-func (p *Text) Print(ctx context.Context, issues []result.Issue) error {
+func (p *Text) Print(issues []result.Issue) error {
 	for i := range issues {
 		p.printIssue(&issues[i])
 
diff --git a/pkg/printers/text_test.go b/pkg/printers/text_test.go
@@ -2,7 +2,6 @@ package printers
 
 import (
 	"bytes"
-	"context"
 	"go/token"
 	"testing"
 
@@ -48,7 +47,7 @@ func TestText_Print(t *testing.T) {
 
 	printer := NewText(true, false, true, logutils.NewStderrLog(logutils.DebugKeyEmpty), buf)
 
-	err := printer.Print(context.Background(), issues)
+	err := printer.Print(issues)
 	require.NoError(t, err)
 
 	expected := `path/to/filea.go:10:4: some issue (linter-a)

Original file line number	Diff line number	Diff line change
`@@ -411,7 +411,7 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {`
`411`	`411`	`out = append(out, "")`
`412`	`412`	`}`
`413`	`413`
`414`		`- err := e.printReports(ctx, issues, out[1], out[0])`
	`414`	`+ err := e.printReports(issues, out[1], out[0])`
`415`	`415`	`if err != nil {`
`416`	`416`	`return err`
`417`	`417`	`}`
`@@ -424,7 +424,7 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {`
`424`	`424`	`return nil`
`425`	`425`	`}`
`426`	`426`
`427`		`-func (e *Executor) printReports(ctx context.Context, issues []result.Issue, path, format string) error {`
	`427`	`+func (e *Executor) printReports(issues []result.Issue, path, format string) error {`
`428`	`428`	`w, shouldClose, err := e.createWriter(path)`
`429`	`429`	`if err != nil {`
`430`	`430`	`return fmt.Errorf("can't create output for %s: %w", path, err)`
`@@ -438,7 +438,7 @@ func (e *Executor) printReports(ctx context.Context, issues []result.Issue, path`
`438`	`438`	`return err`
`439`	`439`	`}`
`440`	`440`
`441`		`- if err = p.Print(ctx, issues); err != nil {`
	`441`	`+ if err = p.Print(issues); err != nil {`
`442`	`442`	`if file, ok := w.(io.Closer); shouldClose && ok {`
`443`	`443`	`_ = file.Close()`
`444`	`444`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,6 @@ func (l *tLog) Infof(format string, args ...any) {`
`56`	`56`	`log.Printf(format, args...)`
`57`	`57`	`}`
`58`	`58`
`59`		`-func (l *tLog) Child(name string) logutils.Log { return nil }`
	`59`	`+func (l *tLog) Child(_ string) logutils.Log { return nil }`
`60`	`60`
`61`		`-func (l *tLog) SetLevel(level logutils.LogLevel) {}`
	`61`	`+func (l *tLog) SetLevel(_ logutils.LogLevel) {}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`package printers`
`2`	`2`
`3`	`3`	`import (`
`4`		`- "context"`
`5`	`4`	`"encoding/xml"`
`6`	`5`	`"fmt"`
`7`	`6`	`"io"`
`@@ -41,7 +40,7 @@ func NewCheckstyle(w io.Writer) *Checkstyle {`
`41`	`40`	`return &Checkstyle{w: w}`
`42`	`41`	`}`
`43`	`42`
`44`		`-func (p Checkstyle) Print(ctx context.Context, issues []result.Issue) error {`
	`43`	`+func (p Checkstyle) Print(issues []result.Issue) error {`
`45`	`44`	`out := checkstyleOutput{`
`46`	`45`	`Version: "5.0",`
`47`	`46`	`}`