Skip to content
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

Jump to bottom

chore(formatting): Print Line Position in to Header #90

Merged
merged 1 commit into from
Oct 18, 2024
Merged

chore(formatting): Print Line Position in to Header #90

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
2 changes: 1 addition & 1 deletion formatter/builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ func (b *IssueFormatterBuilder) AddHeader(kind headerType) *IssueFormatterBuilde
// add file name
padding := strings.Repeat(" ", b.maxLineNumWidth)
b.result.WriteString(lineStyle.Sprint(fmt.Sprintf("%s--> ", padding)))
b.result.WriteString(fileStyle.Sprintln(b.issue.Filename))
b.result.WriteString(fileStyle.Sprintf("%s:%d:%d\n", b.issue.Filename, b.issue.Start.Line, b.issue.Start.Column))

return b
}
Expand Down
71 changes: 8 additions & 63 deletions formatter/formatter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ func TestFormatIssuesWithArrows(t *testing.T) {
}

expected := `error: unused-variable
--> test.go
--> test.go:4:5
|
4 | x := 1
| ~~
= x declared but not used

error: empty-if
--> test.go
--> test.go:5:5
|
5 | if true {}
| ~~~~~~~~~
Expand All @@ -72,14 +72,14 @@ error: empty-if
}

expectedWithTabs := `error: unused-variable
--> test.go
--> test.go:4:5
|
4 | x := 1
| ~~
= x declared but not used

error: empty-if
--> test.go
--> test.go:5:5
|
5 | if true {}
| ~~~~~~~~~
Expand Down Expand Up @@ -134,21 +134,21 @@ func TestFormatIssuesWithArrows_MultipleDigitsLineNumbers(t *testing.T) {
}

expected := `error: unused-variable
--> test.go
--> test.go:4:5
|
4 | x := 1 // unused variable
| ~~
= x declared but not used

error: empty-if
--> test.go
--> test.go:5:5
|
5 | if true {} // empty if statement
| ~~~~~~~~~
= empty branch

error: example
--> test.go
--> test.go:10:5
|
10 | println("end")
| ~~~~~~~~
Expand All @@ -161,61 +161,6 @@ error: example
assert.Equal(t, expected, result, "Formatted output with multiple digit line numbers does not match expected")
}

func TestFormatIssuesWithArrows_UnnecessaryElse(t *testing.T) {
t.Skip()
t.Parallel()
code := &internal.SourceCode{
Lines: []string{
"package main",
"",
"func unnecessaryElse() bool {",
" if condition {",
" return true",
" } else {",
" return false",
" }",
"}",
},
}

issues := []tt.Issue{
{
Rule: "unnecessary-else",
Filename: "test.go",
Start: token.Position{Line: 6, Column: 5},
End: token.Position{Line: 8, Column: 5},
Message: "unnecessary else block",
},
}

expected := `error: unnecessary-else
--> test.go
|
4 | if condition {
5 | return true
6 | } else {
7 | return false
8 | }
| ~~~~~~~~~~~~~~~~~~~~
| unnecessary else block

Suggestion:
|
4 | if condition {
5 | return true
6 | }
7 | return false
|
Note: Unnecessary 'else' block removed.
The code inside the 'else' block has been moved outside, as it will only be executed when the 'if' condition is false.

`

result := GenerateFormattedIssue(issues, code)
t.Logf("result: %s", result)
assert.Equal(t, expected, result, "Formatted output does not match expected for unnecessary else")
}

func TestUnnecessaryTypeConversionFormatter(t *testing.T) {
t.Parallel()
formatter := &UnnecessaryTypeConversionFormatter{}
Expand All @@ -242,7 +187,7 @@ func TestUnnecessaryTypeConversionFormatter(t *testing.T) {
}

expected := `error: unnecessary-type-conversion
--> test.go
--> test.go:5:10
|
5 | result := int(myInt)
| ~~~~~~~~~~~
Expand Down
Loading