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

errors replacements are labeled as faster #38

Closed
wants to merge 1 commit into from
Closed

errors replacements are labeled as faster #38

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
220 changes: 95 additions & 125 deletions analyzer/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,18 +162,16 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
removedFmtUsages[fname]++
if fn == "fmt.Errorf" {
neededPackages[fname]["errors"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with errors.New",
[]analysis.SuggestedFix{
fn,
"errors.New",
[]analysis.TextEdit{
{
Message: "Use errors.New",
TextEdits: []analysis.TextEdit{{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("errors.New("),
}},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("errors.New("),
},
},
)
Expand All @@ -200,18 +198,16 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
errMethodCall := formatNode(pass.Fset, value) + ".Error()"
fname := pass.Fset.File(call.Pos()).Name()
removedFmtUsages[fname]++
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with "+errMethodCall,
[]analysis.SuggestedFix{
fn,
errMethodCall,
[]analysis.TextEdit{
{
Message: "Use " + errMethodCall,
TextEdits: []analysis.TextEdit{{
Pos: call.Pos(),
End: call.End(),
NewText: []byte(errMethodCall),
}},
Pos: call.Pos(),
End: call.End(),
NewText: []byte(errMethodCall),
},
},
)
Expand All @@ -223,18 +219,16 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["strconv"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster strconv.FormatBool",
[]analysis.SuggestedFix{
fn,
"strconv.FormatBool",
[]analysis.TextEdit{
{
Message: "Use strconv.FormatBool",
TextEdits: []analysis.TextEdit{{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatBool("),
}},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatBool("),
},
},
)
Expand All @@ -251,25 +245,21 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["encoding/hex"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster hex.EncodeToString",
[]analysis.SuggestedFix{
fn,
"hex.EncodeToString",
[]analysis.TextEdit{
{
Message: "Use hex.EncodeToString",
TextEdits: []analysis.TextEdit{
{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("hex.EncodeToString("),
},
{
Pos: value.End(),
End: value.End(),
NewText: []byte("[:]"),
},
},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("hex.EncodeToString("),
},
{
Pos: value.End(),
End: value.End(),
NewText: []byte("[:]"),
},
},
)
Expand All @@ -280,18 +270,16 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["encoding/hex"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster hex.EncodeToString",
[]analysis.SuggestedFix{
fn,
"hex.EncodeToString",
[]analysis.TextEdit{
{
Message: "Use hex.EncodeToString",
TextEdits: []analysis.TextEdit{{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("hex.EncodeToString("),
}},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("hex.EncodeToString("),
},
},
)
Expand All @@ -303,25 +291,21 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["strconv"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster strconv.Itoa",
[]analysis.SuggestedFix{
fn,
"strconv.Itoa",
[]analysis.TextEdit{
{
Message: "Use strconv.Itoa",
TextEdits: []analysis.TextEdit{
{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.Itoa(int("),
},
{
Pos: value.End(),
End: value.End(),
NewText: []byte(")"),
},
},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.Itoa(int("),
},
{
Pos: value.End(),
End: value.End(),
NewText: []byte(")"),
},
},
)
Expand All @@ -332,18 +316,16 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["strconv"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster strconv.Itoa",
[]analysis.SuggestedFix{
fn,
"strconv.Itoa",
[]analysis.TextEdit{
{
Message: "Use strconv.Itoa",
TextEdits: []analysis.TextEdit{{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.Itoa("),
}},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.Itoa("),
},
},
)
Expand All @@ -354,25 +336,21 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["strconv"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster strconv.FormatInt",
[]analysis.SuggestedFix{
fn,
"strconv.FormatInt",
[]analysis.TextEdit{
{
Message: "Use strconv.FormatInt",
TextEdits: []analysis.TextEdit{
{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatInt("),
},
{
Pos: value.End(),
End: value.End(),
NewText: []byte(", 10"),
},
},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatInt("),
},
{
Pos: value.End(),
End: value.End(),
NewText: []byte(", 10"),
},
},
)
Expand All @@ -388,25 +366,21 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["strconv"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster strconv.FormatUint",
[]analysis.SuggestedFix{
fn,
"strconv.FormatUint",
[]analysis.TextEdit{
{
Message: "Use strconv.FormatUint",
TextEdits: []analysis.TextEdit{
{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatUint(uint64("),
},
{
Pos: value.End(),
End: value.End(),
NewText: base,
},
},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatUint(uint64("),
},
{
Pos: value.End(),
End: value.End(),
NewText: base,
},
},
)
Expand All @@ -421,25 +395,21 @@ func (n *perfSprint) run(pass *analysis.Pass) (interface{}, error) {
neededPackages[fname] = make(map[string]struct{})
}
neededPackages[fname]["strconv"] = struct{}{}
d = newAnalysisDiagnostic(
d = newFasterFunctionReplacementDiagnostic(
"", // TODO: precise checker
call,
fn+" can be replaced with faster strconv.FormatUint",
[]analysis.SuggestedFix{
fn,
"strconv.FormatUint",
[]analysis.TextEdit{
{
Message: "Use strconv.FormatUint",
TextEdits: []analysis.TextEdit{
{
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatUint("),
},
{
Pos: value.End(),
End: value.End(),
NewText: base,
},
},
Pos: call.Pos(),
End: value.Pos(),
NewText: []byte("strconv.FormatUint("),
},
{
Pos: value.End(),
End: value.End(),
NewText: base,
},
},
)
Expand Down
20 changes: 20 additions & 0 deletions analyzer/diagnostic.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,23 @@ func newAnalysisDiagnostic(
}
return &d
}

func newFasterFunctionReplacementDiagnostic(
checker string,
analysisRange analysis.Range,
function string,
suggestedFunction string,
textEdits []analysis.TextEdit,
) *analysis.Diagnostic {
return newAnalysisDiagnostic(
checker,
analysisRange,
function+" can be replaced with faster "+suggestedFunction,
[]analysis.SuggestedFix{
{
Message: "Use " + suggestedFunction,
TextEdits: textEdits,
},
},
)
}
24 changes: 12 additions & 12 deletions analyzer/testdata/src/p/p.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ func positive() {
fmt.Sprintf("%[1]s", s) // want "fmt.Sprintf can be replaced with just using the string"
fmt.Sprintf("%v", s) // want "fmt.Sprintf can be replaced with just using the string"
fmt.Sprint(s) // want "fmt.Sprint can be replaced with just using the string"
fmt.Errorf("hello") // want "fmt.Errorf can be replaced with errors.New"
fmt.Errorf("hello") // want "fmt.Errorf can be replaced with faster errors.New"

fmt.Sprintf("Hello %s", s) // want "fmt.Sprintf can be replaced with string concatenation"
fmt.Sprintf("%s says Hello", s) // want "fmt.Sprintf can be replaced with string concatenation"
fmt.Sprintf("Hello says %[1]s", s) // want "fmt.Sprintf can be replaced with string concatenation"

var err error
fmt.Sprintf("%s", errSentinel) // want "fmt.Sprintf can be replaced with errSentinel.Error()"
fmt.Sprintf("%v", errSentinel) // want "fmt.Sprintf can be replaced with errSentinel.Error()"
fmt.Sprint(errSentinel) // want "fmt.Sprint can be replaced with errSentinel.Error()"
fmt.Sprintf("%s", io.EOF) // want "fmt.Sprintf can be replaced with io.EOF.Error()"
fmt.Sprintf("%v", io.EOF) // want "fmt.Sprintf can be replaced with io.EOF.Error()"
fmt.Sprint(io.EOF) // want "fmt.Sprint can be replaced with io.EOF.Error()"
fmt.Sprintf("%s", err) // want "fmt.Sprintf can be replaced with err.Error()"
fmt.Sprintf("%v", err) // want "fmt.Sprintf can be replaced with err.Error()"
fmt.Sprint(err) // want "fmt.Sprint can be replaced with err.Error()"
fmt.Sprintf("%s", errSentinel) // want "fmt.Sprintf can be replaced with faster errSentinel.Error()"
fmt.Sprintf("%v", errSentinel) // want "fmt.Sprintf can be replaced with faster errSentinel.Error()"
fmt.Sprint(errSentinel) // want "fmt.Sprint can be replaced with faster errSentinel.Error()"
fmt.Sprintf("%s", io.EOF) // want "fmt.Sprintf can be replaced with faster io.EOF.Error()"
fmt.Sprintf("%v", io.EOF) // want "fmt.Sprintf can be replaced with faster io.EOF.Error()"
fmt.Sprint(io.EOF) // want "fmt.Sprint can be replaced with faster io.EOF.Error()"
fmt.Sprintf("%s", err) // want "fmt.Sprintf can be replaced with faster err.Error()"
fmt.Sprintf("%v", err) // want "fmt.Sprintf can be replaced with faster err.Error()"
fmt.Sprint(err) // want "fmt.Sprint can be replaced with faster err.Error()"
Comment on lines +32 to +40
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the report message constitutes a breaking change. However, the PR's title states "chore: define newFasterFunctionReplacementDiagnostic," which suggests it's a simple refactoring. I propose we either change the PR's title or avoid making breaking changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's related to this #38 (comment)


var b bool
fmt.Sprintf("%t", true) // want "fmt.Sprintf can be replaced with faster strconv.FormatBool"
Expand Down Expand Up @@ -140,8 +140,8 @@ func suggestedFixesTest() {
return fmt.Sprintf("%s", "replace me") // want "fmt.Sprintf can be replaced with just using the string"
}

fmt.Println(fmt.Sprint(errSentinel)) // want "fmt.Sprint can be replaced with errSentinel.Error()"
fmt.Println(fmt.Sprintf("%s", errSentinel)) // want "fmt.Sprintf can be replaced with errSentinel.Error()"
fmt.Println(fmt.Sprint(errSentinel)) // want "fmt.Sprint can be replaced with faster errSentinel.Error()"
fmt.Println(fmt.Sprintf("%s", errSentinel)) // want "fmt.Sprintf can be replaced with faster errSentinel.Error()"

_ = func() string {
switch 42 {
Expand Down
Loading