go/revive
1
0
Fork 0
mirror of https://github.com/mgechev/revive.git synced 2024-11-19 17:12:55 +02:00
Code Issues Releases Activity

fix: change URL to the page with rules descriptions (#1129)

Browse Source
This commit is contained in:
Oleksandr Redko 2024-11-16 13:09:38 +02:00 committed by GitHub
parent 3378f7033b
commit 772285d9c7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
formatter/default.go
View File

@ -26,3 +26,7 @@ func (*Default) Format(failures <-chan lint.Failure, _ lint.Config) (string, err
}
return buf.String(), nil
}
func ruleDescriptionURL(ruleName string) string {
return "https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#" + ruleName
}

8
formatter/formatter_test.go
View File

@ -50,7 +50,7 @@ func TestFormatter(t *testing.T) {
{
formatter: &formatter.Friendly{},
want: `
⚠ https://revive.run/r#rule test failure
⚠ https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#rule test failure
test.go:2:5
⚠ 1 problem (0 errors, 1 warning)
@ -69,7 +69,7 @@ Warnings:
},
{
formatter: &formatter.Plain{},
want: `test.go:2:5: test failure https://revive.run/r#rule`,
want: `test.go:2:5: test failure https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#rule`,
},
{
formatter: &formatter.Sarif{},
@ -100,7 +100,7 @@ Warnings:
],
"tool": {
"driver": {
"informationUri": "https://revive.run",
"informationUri": "https://github.com/mgechev/revive",
"name": "revive"
}
}
@ -114,7 +114,7 @@ Warnings:
formatter: &formatter.Stylish{},
want: `
test.go
(2, 5) https://revive.run/r#rule test failure
(2, 5) https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#rule test failure
✖ 1 problem (0 errors) (1 warnings)

2
formatter/friendly.go
View File

@ -67,7 +67,7 @@ func (f *Friendly) printHeaderRow(w io.Writer, failure lint.Failure, severity li
if severity == lint.SeverityError {
emoji = getErrorEmoji()
}
fmt.Fprint(w, f.table([][]string{{emoji, "https://revive.run/r#" + failure.RuleName, color.GreenString(failure.Failure)}}))
fmt.Fprint(w, f.table([][]string{{emoji, ruleDescriptionURL(failure.RuleName), color.GreenString(failure.Failure)}}))
}
func (*Friendly) printFilePosition(w io.Writer, failure lint.Failure) {

2
formatter/plain.go
View File

@ -22,7 +22,7 @@ func (*Plain) Name() string {
func (*Plain) Format(failures <-chan lint.Failure, _ lint.Config) (string, error) {
var buf bytes.Buffer
for failure := range failures {
fmt.Fprintf(&buf, "%v: %s %s\n", failure.Position.Start, failure.Failure, "https://revive.run/r#"+failure.RuleName)
fmt.Fprintf(&buf, "%v: %s %s\n", failure.Position.Start, failure.Failure, ruleDescriptionURL(failure.RuleName))
}
return buf.String(), nil
}

2
formatter/sarif.go
View File

@ -20,7 +20,7 @@ func (*Sarif) Name() string {
return "sarif"
}
const reviveSite = "https://revive.run"
const reviveSite = "https://github.com/mgechev/revive"
// Format formats the failures gotten from the lint.
func (*Sarif) Format(failures <-chan lint.Failure, cfg lint.Config) (string, error) {

5
formatter/stylish.go
View File

@ -22,11 +22,12 @@ func (*Stylish) Name() string {
func formatFailure(failure lint.Failure, severity lint.Severity) []string {
fString := color.CyanString(failure.Failure)
fName := color.RedString("https://revive.run/r#" + failure.RuleName)
fURL := ruleDescriptionURL(failure.RuleName)
fName := color.RedString(fURL)
lineColumn := failure.Position
pos := fmt.Sprintf("(%d, %d)", lineColumn.Start.Line, lineColumn.Start.Column)
if severity == lint.SeverityWarning {
fName = color.YellowString("https://revive.run/r#" + failure.RuleName)
fName = color.YellowString(fURL)
}
return []string{failure.GetFilename(), pos, fName, fString}
}

10
revivelib/core_test.go
View File

@ -54,11 +54,11 @@ func TestReviveFormat(t *testing.T) {
}
errorMsgs := []string{
"(91, 3) https://revive.run/r#unreachable-code unreachable code after this statement",
"(98, 3) https://revive.run/r#unreachable-code unreachable code after this statement",
"(15, 2) https://revive.run/r#if-return redundant if ...; err != nil check, just return error instead.",
"(88, 3) https://revive.run/r#if-return redundant if ...; err != nil check, just return error instead.",
"(95, 3) https://revive.run/r#if-return redundant if ...; err != nil check, just return error instead.",
"(91, 3) https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code unreachable code after this statement",
"(98, 3) https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code unreachable code after this statement",
"(15, 2) https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return redundant if ...; err != nil check, just return error instead.",
"(88, 3) https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return redundant if ...; err != nil check, just return error instead.",
"(95, 3) https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return redundant if ...; err != nil check, just return error instead.",
}
for _, errorMsg := range errorMsgs {
if !strings.Contains(failures, errorMsg) {