Add 'floatcompare' linter

mweb · mweb · commit e35cee485bb6 · 2022-04-05T17:56:09.000+02:00
diff --git a/.golangci.example.yml b/.golangci.example.yml
@@ -285,6 +285,11 @@ linters-settings:
       - '*.Test'
       - 'example.com/package.ExampleStruct'
 
+  floatcompare:
+    # Search only for == and != no other comparisons
+    # Default: false
+    equal-only: true
+
   forbidigo:
     # Forbid the following identifiers (list of regexp).
     forbid:
diff --git a/go.mod b/go.mod
@@ -61,6 +61,7 @@ require (
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/mitchellh/go-ps v1.0.0
 	github.com/moricho/tparallel v0.2.1
+	github.com/mweb/floatcompare v1.0.1
 	github.com/nakabonne/nestif v0.3.1
 	github.com/nishanths/exhaustive v0.7.11
 	github.com/nishanths/predeclared v0.2.1
diff --git a/go.sum b/go.sum
diff --git a/pkg/config/linters_settings.go b/pkg/config/linters_settings.go
@@ -123,6 +123,7 @@ type LintersSettings struct {
 	ErrorLint        ErrorLintSettings
 	Exhaustive       ExhaustiveSettings
 	ExhaustiveStruct ExhaustiveStructSettings
+	FloatCompare     FloatCompareSettings
 	Forbidigo        ForbidigoSettings
 	Funlen           FunlenSettings
 	Gci              GciSettings
@@ -255,6 +256,10 @@ type ExhaustiveStructSettings struct {
 	StructPatterns []string `mapstructure:"struct-patterns"`
 }
 
+type FloatCompareSettings struct {
+	EqualOnly bool `mapstructure:"equal-only"`
+}
+
 type ForbidigoSettings struct {
 	Forbid               []string `mapstructure:"forbid"`
 	ExcludeGodocExamples bool     `mapstructure:"exclude-godoc-examples"`
diff --git a/pkg/golinters/floatcompare.go b/pkg/golinters/floatcompare.go
@@ -0,0 +1,31 @@
+package golinters
+
+import (
+	"github.com/mweb/floatcompare"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+const floatcompareName = "floatcompare"
+
+func NewFloatCompare(settings *config.FloatCompareSettings) *goanalysis.Linter {
+	a := floatcompare.NewAnalyzer()
+
+	var cfg map[string]map[string]interface{}
+	if settings != nil {
+		d := map[string]interface{}{
+			"equalOnly": settings.EqualOnly,
+		}
+
+		cfg = map[string]map[string]interface{}{a.Name: d}
+	}
+
+	return goanalysis.NewLinter(
+		floatcompareName,
+		"search for float comparison, since these are potential errors",
+		[]*analysis.Analyzer{a},
+		cfg,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}
diff --git a/pkg/lint/lintersdb/manager.go b/pkg/lint/lintersdb/manager.go
@@ -107,6 +107,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 	var errorlintCfg *config.ErrorLintSettings
 	var exhaustiveCfg *config.ExhaustiveSettings
 	var exhaustiveStructCfg *config.ExhaustiveStructSettings
+	var floatCompareStructCfg *config.FloatCompareSettings
 	var gciCfg *config.GciSettings
 	var goModDirectivesCfg *config.GoModDirectivesSettings
 	var goMndCfg *config.GoMndSettings
@@ -140,6 +141,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		errorlintCfg = &m.cfg.LintersSettings.ErrorLint
 		exhaustiveCfg = &m.cfg.LintersSettings.Exhaustive
 		exhaustiveStructCfg = &m.cfg.LintersSettings.ExhaustiveStruct
+		floatCompareStructCfg = &m.cfg.LintersSettings.FloatCompare
 		gciCfg = &m.cfg.LintersSettings.Gci
 		goModDirectivesCfg = &m.cfg.LintersSettings.GoModDirectives
 		goMndCfg = &m.cfg.LintersSettings.Gomnd
@@ -289,6 +291,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/kyoh86/exportloopref"),
 
+		linter.NewConfig(golinters.NewFloatCompare(floatCompareStructCfg)).
+			WithSince("v1.46.0").
+			WithPresets(linter.PresetBugs).
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/mweb/floatcompare"),
+
 		linter.NewConfig(golinters.NewForbidigo()).
 			WithSince("v1.34.0").
 			WithPresets(linter.PresetStyle).
diff --git a/test/testdata/floatcompare.go b/test/testdata/floatcompare.go
@@ -0,0 +1,67 @@
+// args: -Efloatcompare
+package testdata
+
+func EqualCompareIfFloats() {
+	x, y := 400., 500.
+	if 300. == 100. { // ERROR `float comparison found "300. == 100."`
+		dummy()
+	}
+	if x == y { // ERROR `float comparison found "x == y"`
+		dummy()
+	}
+	if 300.+200. == 10. { // ERROR `float comparison found "300.+200. == 10."`
+		dummy()
+	}
+	if 300 == 200 {
+		dummy()
+	}
+}
+
+func NotEqualCompareIfFloats() {
+	x, y := 400., 500.
+	if 300. != 100. { // ERROR `float comparison found "300. != 100."``
+
+		dummy()
+	}
+	if x != y { // ERROR `float comparison found "x != y"`
+		dummy()
+	}
+}
+
+func EqualCompareIfCustomType() {
+	type number float64
+	var x, y number = 300., 400.
+	if x == y { // ERROR `float comparison found "x == y"`
+		dummy()
+	}
+}
+
+func GreaterLessCompareIfFloats() {
+	if 300. >= 100. { // ERROR `float comparison found "300. >= 100."`
+		dummy()
+	}
+	if 300. <= 100. { // ERROR `float comparison found "300. <= 100."`
+		dummy()
+	}
+	if 300. < 100. { // ERROR `float comparison found "300. < 100."`
+		dummy()
+	}
+	if 300. > 100. { // ERROR `float comparison found "300. > 100."`
+		dummy()
+	}
+}
+
+func SwitchStmtWithFloat() {
+	switch 300. { // ERROR "float comparison with switch statement"
+	case 100.:
+	case 200:
+	}
+}
+
+func EqualCompareSwitchFloats() {
+	switch {
+	case 100. == 200.: // ERROR `float comparison found "100. == 200."`
+	}
+}
+
+func dummy() {}
