chore: rename functions

ldez · ldez · commit a6711f903847 · 2024-05-06T18:30:47.000+02:00
diff --git a/pkg/printers/githubaction.go b/pkg/printers/githubaction.go
@@ -21,7 +21,7 @@ func NewGitHubAction(w io.Writer) *GitHubAction {
 
 func (p *GitHubAction) Print(issues []result.Issue) error {
 	for ind := range issues {
-		_, err := fmt.Fprintln(p.w, formatIssueAsGithub(&issues[ind]))
+		_, err := fmt.Fprintln(p.w, formatIssueAsGitHub(&issues[ind]))
 		if err != nil {
 			return err
 		}
@@ -30,7 +30,7 @@ func (p *GitHubAction) Print(issues []result.Issue) error {
 }
 
 // print each line as: ::error file=app.js,line=10,col=15::Something went wrong
-func formatIssueAsGithub(issue *result.Issue) string {
+func formatIssueAsGitHub(issue *result.Issue) string {
 	severity := defaultGithubSeverity
 	if issue.Severity != "" {
 		severity = issue.Severity
diff --git a/pkg/printers/githubaction_problem_matchers.go b/pkg/printers/githubaction_problem_matchers.go
@@ -88,7 +88,7 @@ func (p *GitHubActionProblemMatchers) Print(issues []result.Issue) error {
 	_, _ = fmt.Fprintln(p.w, "::add-matcher::"+filename)
 
 	for ind := range issues {
-		_, err := fmt.Fprintln(p.w, formatIssueAsGitHub(&issues[ind]))
+		_, err := fmt.Fprintln(p.w, formatIssueAsProblemMatcher(&issues[ind]))
 		if err != nil {
 			return err
 		}
@@ -136,7 +136,7 @@ func generateProblemMatcher() GHProblemMatchers {
 	}
 }
 
-func formatIssueAsGitHub(issue *result.Issue) string {
+func formatIssueAsProblemMatcher(issue *result.Issue) string {
 	severity := defaultGitHubSeverity
 	if issue.Severity != "" {
 		severity = issue.Severity
diff --git a/pkg/printers/githubaction_problem_matchers_test.go b/pkg/printers/githubaction_problem_matchers_test.go
@@ -67,7 +67,7 @@ error	path/to/fileb.go:300:9:	another issue (linter-b)
 	assert.Equal(t, expected, buf.String())
 }
 
-func Test_formatIssueAsGitHub(t *testing.T) {
+func Test_formatIssueAsProblemMatcher(t *testing.T) {
 	sampleIssue := result.Issue{
 		FromLinter: "sample-linter",
 		Text:       "some issue",
@@ -78,13 +78,13 @@ func Test_formatIssueAsGitHub(t *testing.T) {
 			Column:   4,
 		},
 	}
-	require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
+	require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))
 
 	sampleIssue.Pos.Column = 0
-	require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
+	require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))
 }
 
-func Test_formatIssueAsGitHub_Windows(t *testing.T) {
+func Test_formatIssueAsProblemMatcher_Windows(t *testing.T) {
 	if runtime.GOOS != "windows" {
 		t.Skip("Skipping test on non Windows")
 	}
@@ -99,10 +99,10 @@ func Test_formatIssueAsGitHub_Windows(t *testing.T) {
 			Column:   4,
 		},
 	}
-	require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
+	require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))
 
 	sampleIssue.Pos.Column = 0
-	require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
+	require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))
 }
 
 func Test_generateProblemMatcher(t *testing.T) {
diff --git a/pkg/printers/githubaction_test.go b/pkg/printers/githubaction_test.go
@@ -56,7 +56,7 @@ func TestGitHubAction_Print(t *testing.T) {
 	assert.Equal(t, expected, buf.String())
 }
 
-func Test_formatIssueAsGithub(t *testing.T) {
+func Test_formatIssueAsGitHub(t *testing.T) {
 	sampleIssue := result.Issue{
 		FromLinter: "sample-linter",
 		Text:       "some issue",
@@ -67,13 +67,13 @@ func Test_formatIssueAsGithub(t *testing.T) {
 			Column:   4,
 		},
 	}
-	require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))
+	require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
 
 	sampleIssue.Pos.Column = 0
-	require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))
+	require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
 }
 
-func Test_formatIssueAsGithub_Windows(t *testing.T) {
+func Test_formatIssueAsGitHub_Windows(t *testing.T) {
 	if runtime.GOOS != "windows" {
 		t.Skip("Skipping test on non Windows")
 	}
@@ -88,8 +88,8 @@ func Test_formatIssueAsGithub_Windows(t *testing.T) {
 			Column:   4,
 		},
 	}
-	require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))
+	require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
 
 	sampleIssue.Pos.Column = 0
-	require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))
+	require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))
 }

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ func (p *GitHubActionProblemMatchers) Print(issues []result.Issue) error {`
`88`	`88`	`_, _ = fmt.Fprintln(p.w, "::add-matcher::"+filename)`
`89`	`89`
`90`	`90`	`for ind := range issues {`
`91`		`- _, err := fmt.Fprintln(p.w, formatIssueAsGitHub(&issues[ind]))`
	`91`	`+ _, err := fmt.Fprintln(p.w, formatIssueAsProblemMatcher(&issues[ind]))`
`92`	`92`	`if err != nil {`
`93`	`93`	`return err`
`94`	`94`	`}`
`@@ -136,7 +136,7 @@ func generateProblemMatcher() GHProblemMatchers {`
`136`	`136`	`}`
`137`	`137`	`}`
`138`	`138`
`139`		`-func formatIssueAsGitHub(issue *result.Issue) string {`
	`139`	`+func formatIssueAsProblemMatcher(issue *result.Issue) string {`
`140`	`140`	`severity := defaultGitHubSeverity`
`141`	`141`	`if issue.Severity != "" {`
`142`	`142`	`severity = issue.Severity`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ error path/to/fileb.go:300:9: another issue (linter-b)`
`67`	`67`	`assert.Equal(t, expected, buf.String())`
`68`	`68`	`}`
`69`	`69`
`70`		`-func Test_formatIssueAsGitHub(t *testing.T) {`
	`70`	`+func Test_formatIssueAsProblemMatcher(t *testing.T) {`
`71`	`71`	`sampleIssue := result.Issue{`
`72`	`72`	`FromLinter: "sample-linter",`
`73`	`73`	`Text: "some issue",`
`@@ -78,13 +78,13 @@ func Test_formatIssueAsGitHub(t *testing.T) {`
`78`	`78`	`Column: 4,`
`79`	`79`	`},`
`80`	`80`	`}`
`81`		`- require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
	`81`	`+ require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))`
`82`	`82`
`83`	`83`	`sampleIssue.Pos.Column = 0`
`84`		`- require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
	`84`	`+ require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))`
`85`	`85`	`}`
`86`	`86`
`87`		`-func Test_formatIssueAsGitHub_Windows(t *testing.T) {`
	`87`	`+func Test_formatIssueAsProblemMatcher_Windows(t *testing.T) {`
`88`	`88`	`if runtime.GOOS != "windows" {`
`89`	`89`	`t.Skip("Skipping test on non Windows")`
`90`	`90`	`}`
`@@ -99,10 +99,10 @@ func Test_formatIssueAsGitHub_Windows(t *testing.T) {`
`99`	`99`	`Column: 4,`
`100`	`100`	`},`
`101`	`101`	`}`
`102`		`- require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
	`102`	`+ require.Equal(t, "error\tpath/to/file.go:10:4:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))`
`103`	`103`
`104`	`104`	`sampleIssue.Pos.Column = 0`
`105`		`- require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
	`105`	`+ require.Equal(t, "error\tpath/to/file.go:10:\tsome issue (sample-linter)", formatIssueAsProblemMatcher(&sampleIssue))`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`func Test_generateProblemMatcher(t *testing.T) {`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ func TestGitHubAction_Print(t *testing.T) {`
`56`	`56`	`assert.Equal(t, expected, buf.String())`
`57`	`57`	`}`
`58`	`58`
`59`		`-func Test_formatIssueAsGithub(t *testing.T) {`
	`59`	`+func Test_formatIssueAsGitHub(t *testing.T) {`
`60`	`60`	`sampleIssue := result.Issue{`
`61`	`61`	`FromLinter: "sample-linter",`
`62`	`62`	`Text: "some issue",`
`@@ -67,13 +67,13 @@ func Test_formatIssueAsGithub(t *testing.T) {`
`67`	`67`	`Column: 4,`
`68`	`68`	`},`
`69`	`69`	`}`
`70`		`- require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))`
	`70`	`+ require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
`71`	`71`
`72`	`72`	`sampleIssue.Pos.Column = 0`
`73`		`- require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))`
	`73`	`+ require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
`74`	`74`	`}`
`75`	`75`
`76`		`-func Test_formatIssueAsGithub_Windows(t *testing.T) {`
	`76`	`+func Test_formatIssueAsGitHub_Windows(t *testing.T) {`
`77`	`77`	`if runtime.GOOS != "windows" {`
`78`	`78`	`t.Skip("Skipping test on non Windows")`
`79`	`79`	`}`
`@@ -88,8 +88,8 @@ func Test_formatIssueAsGithub_Windows(t *testing.T) {`
`88`	`88`	`Column: 4,`
`89`	`89`	`},`
`90`	`90`	`}`
`91`		`- require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))`
	`91`	`+ require.Equal(t, "::error file=path/to/file.go,line=10,col=4::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
`92`	`92`
`93`	`93`	`sampleIssue.Pos.Column = 0`
`94`		`- require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGithub(&sampleIssue))`
	`94`	`+ require.Equal(t, "::error file=path/to/file.go,line=10::some issue (sample-linter)", formatIssueAsGitHub(&sampleIssue))`
`95`	`95`	`}`