Skip to content

dev: remove unused ctx parameter from Printer #3761

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 1 commit into from
Apr 16, 2023
Merged

dev: remove unused ctx parameter from Printer #3761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ linters-settings:
rules:
- name: unexported-return
disabled: true
- name: unused-parameter

linters:
disable-all: true
Expand Down
6 changes: 3 additions & 3 deletions pkg/commands/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand All @@ -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)
Expand All @@ -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()
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/golinters/gocritic_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {}
2 changes: 1 addition & 1 deletion pkg/logutils/logutils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] {
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/checkstyle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"encoding/xml"
"fmt"
"io"
Expand Down Expand Up @@ -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",
}
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/checkstyle_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"strings"
"testing"
Expand Down Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/codeclimate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"encoding/json"
"fmt"
"io"
Expand Down Expand Up @@ -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]
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/codeclimate_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"fmt"
"io"

Expand Down Expand Up @@ -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 {
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/github_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/html.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"fmt"
"html/template"
"io"
Expand Down Expand Up @@ -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 {
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/html_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -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())
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"encoding/json"
"io"

Expand All @@ -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,
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/json_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/junitxml.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"encoding/xml"
"fmt"
"io"
Expand Down Expand Up @@ -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 {
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/junitxml_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -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>
Expand Down
4 changes: 1 addition & 3 deletions pkg/printers/printer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
}
3 changes: 1 addition & 2 deletions pkg/printers/tab.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"fmt"
"io"
"text/tabwriter"
Expand Down Expand Up @@ -39,7 +38,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 {
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/tab_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -92,7 +91,7 @@ path/to/fileb.go:300:9 another issue

printer := NewTab(test.printLinterName, test.useColors, logutils.NewStderrLog(logutils.DebugKeyEmpty), buf)

err := printer.Print(context.Background(), issues)
err := printer.Print(issues)
require.NoError(t, err)

assert.Equal(t, test.expected, buf.String())
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/teamcity.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"fmt"
"io"
"strings"
Expand Down Expand Up @@ -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 {
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/teamcity_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -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']
Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/text.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package printers

import (
"context"
"fmt"
"io"
"strings"
Expand Down Expand Up @@ -41,7 +40,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])

Expand Down
3 changes: 1 addition & 2 deletions pkg/printers/text_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package printers

import (
"bytes"
"context"
"go/token"
"testing"

Expand Down Expand Up @@ -120,7 +119,7 @@ path/to/fileb.go:300:9: another issue

printer := NewText(test.printIssuedLine, test.useColors, test.printLinterName, logutils.NewStderrLog(logutils.DebugKeyEmpty), buf)

err := printer.Print(context.Background(), issues)
err := printer.Print(issues)
require.NoError(t, err)

assert.Equal(t, test.expected, buf.String())
Expand Down