From 4f9f5b38ba6eaed886087091dff7dbe1f2b12b7f Mon Sep 17 00:00:00 2001 From: karamaru-alpha Date: Wed, 14 Feb 2024 06:40:32 +0900 Subject: [PATCH 1/7] feat: copyloopvar linter Signed-off-by: karamaru-alpha --- .golangci.reference.yml | 2 ++ go.mod | 1 + go.sum | 2 ++ pkg/golinters/copyloopvar.go | 19 +++++++++++++++++++ pkg/lint/lintersdb/manager.go | 6 ++++++ test/testdata/copyloopvar.go | 34 ++++++++++++++++++++++++++++++++++ 6 files changed, 64 insertions(+) create mode 100644 pkg/golinters/copyloopvar.go create mode 100644 test/testdata/copyloopvar.go diff --git a/.golangci.reference.yml b/.golangci.reference.yml index d032fbb886d0..5a63383a5f05 100644 --- a/.golangci.reference.yml +++ b/.golangci.reference.yml @@ -2485,6 +2485,7 @@ linters: - bodyclose - containedctx - contextcheck + - copyloopvar - cyclop - deadcode - decorder @@ -2606,6 +2607,7 @@ linters: - bodyclose - containedctx - contextcheck + - copyloopvar - cyclop - deadcode - decorder diff --git a/go.mod b/go.mod index 6e48bde0d495..a09ad7887274 100644 --- a/go.mod +++ b/go.mod @@ -60,6 +60,7 @@ require ( github.com/jirfag/go-printf-func-name v0.0.0-20200119135958-7558a9eaa5af github.com/jjti/go-spancheck v0.5.2 github.com/julz/importas v0.1.0 + github.com/karamaru-alpha/copyloopvar v1.0.1 github.com/kisielk/errcheck v1.7.0 github.com/kkHAIKE/contextcheck v1.1.4 github.com/kulti/thelper v0.6.3 diff --git a/go.sum b/go.sum index bbc4a06643a9..f3afed76b0b0 100644 --- a/go.sum +++ b/go.sum @@ -320,6 +320,8 @@ github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7V github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM= github.com/julz/importas v0.1.0 h1:F78HnrsjY3cR7j0etXy5+TU1Zuy7Xt08X/1aJnH5xXY= github.com/julz/importas v0.1.0/go.mod h1:oSFU2R4XK/P7kNBrnL/FEQlDGN1/6WoxXEjSSXO0DV0= +github.com/karamaru-alpha/copyloopvar v1.0.1 h1:fE4aoMl3z8JJqUKozsEbTT05+qvDcuQdcUYEHlLNg0Q= +github.com/karamaru-alpha/copyloopvar v1.0.1/go.mod h1:u7CIfztblY0jZLOQZgH3oYsJzpC2A7S6u/lfgSXHy0k= github.com/kisielk/errcheck v1.7.0 h1:+SbscKmWJ5mOK/bO1zS60F5I9WwZDWOfRsC4RwfwRV0= github.com/kisielk/errcheck v1.7.0/go.mod h1:1kLL+jV4e+CFfueBmI1dSK2ADDyQnlrnrY/FqKluHJQ= github.com/kisielk/gotool v1.0.0 h1:AV2c/EiW3KqPNT9ZKl07ehoAGi4C5/01Cfbblndcapg= diff --git a/pkg/golinters/copyloopvar.go b/pkg/golinters/copyloopvar.go new file mode 100644 index 000000000000..1fe73aad119f --- /dev/null +++ b/pkg/golinters/copyloopvar.go @@ -0,0 +1,19 @@ +package golinters + +import ( + "github.com/karamaru-alpha/copyloopvar" + "golang.org/x/tools/go/analysis" + + "github.com/golangci/golangci-lint/pkg/golinters/goanalysis" +) + +func NewCopyLoopVar() *goanalysis.Linter { + a := copyloopvar.Analyzer + + return goanalysis.NewLinter( + a.Name, + a.Doc, + []*analysis.Analyzer{a}, + nil, + ).WithLoadMode(goanalysis.LoadModeTypesInfo) +} diff --git a/pkg/lint/lintersdb/manager.go b/pkg/lint/lintersdb/manager.go index fdc73ec734a1..d06f1495c74c 100644 --- a/pkg/lint/lintersdb/manager.go +++ b/pkg/lint/lintersdb/manager.go @@ -298,6 +298,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config { WithLoadForGoAnalysis(). WithURL("https://github.com/kkHAIKE/contextcheck"), + linter.NewConfig(golinters.NewCopyLoopVar()). + WithSince("v1.57.0"). + WithLoadForGoAnalysis(). + WithPresets(linter.PresetStyle). + WithURL("https://github.com/karamaru-alpha/copyloopvar"), + linter.NewConfig(golinters.NewCyclop(cyclopCfg)). WithSince("v1.37.0"). WithLoadForGoAnalysis(). diff --git a/test/testdata/copyloopvar.go b/test/testdata/copyloopvar.go new file mode 100644 index 000000000000..f8c7efc6a43b --- /dev/null +++ b/test/testdata/copyloopvar.go @@ -0,0 +1,34 @@ +//golangcitest:args -Ecopyloopvar +package testdata + +func copyloopvarCase1() { + slice := []int{1, 2, 3} + fns := make([]func(), 0, len(slice)*2) + for i, v := range slice { + i := i // want `It's unnecessary to copy the loop variable "i"` + fns = append(fns, func() { + _ = i + }) + _v := v // want `It's unnecessary to copy the loop variable "v"` + fns = append(fns, func() { + _ = _v + }) + } + for _, fn := range fns { + fn() + } +} + +func copyloopvarCase2() { + loopCount := 3 + fns := make([]func(), 0, loopCount) + for i := 1; i <= loopCount; i++ { + i := i // want `It's unnecessary to copy the loop variable "i"` + fns = append(fns, func() { + _ = i + }) + } + for _, fn := range fns { + fn() + } +} From 8c2d6678b76cf40400c90a342897f20f46efec29 Mon Sep 17 00:00:00 2001 From: karamaru-alpha Date: Wed, 14 Feb 2024 09:39:54 +0900 Subject: [PATCH 2/7] update: LICENSE Signed-off-by: karamaru-alpha --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index a09ad7887274..352a7802a892 100644 --- a/go.mod +++ b/go.mod @@ -60,7 +60,7 @@ require ( github.com/jirfag/go-printf-func-name v0.0.0-20200119135958-7558a9eaa5af github.com/jjti/go-spancheck v0.5.2 github.com/julz/importas v0.1.0 - github.com/karamaru-alpha/copyloopvar v1.0.1 + github.com/karamaru-alpha/copyloopvar v1.0.2 github.com/kisielk/errcheck v1.7.0 github.com/kkHAIKE/contextcheck v1.1.4 github.com/kulti/thelper v0.6.3 diff --git a/go.sum b/go.sum index f3afed76b0b0..ac2059b203e8 100644 --- a/go.sum +++ b/go.sum @@ -320,8 +320,8 @@ github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7V github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM= github.com/julz/importas v0.1.0 h1:F78HnrsjY3cR7j0etXy5+TU1Zuy7Xt08X/1aJnH5xXY= github.com/julz/importas v0.1.0/go.mod h1:oSFU2R4XK/P7kNBrnL/FEQlDGN1/6WoxXEjSSXO0DV0= -github.com/karamaru-alpha/copyloopvar v1.0.1 h1:fE4aoMl3z8JJqUKozsEbTT05+qvDcuQdcUYEHlLNg0Q= -github.com/karamaru-alpha/copyloopvar v1.0.1/go.mod h1:u7CIfztblY0jZLOQZgH3oYsJzpC2A7S6u/lfgSXHy0k= +github.com/karamaru-alpha/copyloopvar v1.0.2 h1:tmJjTFg4edmOuFTSBuxeueH8lL21kmCPTQHILQcYJWw= +github.com/karamaru-alpha/copyloopvar v1.0.2/go.mod h1:u7CIfztblY0jZLOQZgH3oYsJzpC2A7S6u/lfgSXHy0k= github.com/kisielk/errcheck v1.7.0 h1:+SbscKmWJ5mOK/bO1zS60F5I9WwZDWOfRsC4RwfwRV0= github.com/kisielk/errcheck v1.7.0/go.mod h1:1kLL+jV4e+CFfueBmI1dSK2ADDyQnlrnrY/FqKluHJQ= github.com/kisielk/gotool v1.0.0 h1:AV2c/EiW3KqPNT9ZKl07ehoAGi4C5/01Cfbblndcapg= From ea900d35d692d962211a25773552dce76a0f6cd8 Mon Sep 17 00:00:00 2001 From: karamaru-alpha Date: Wed, 14 Feb 2024 09:40:32 +0900 Subject: [PATCH 3/7] update: add std lib to testcase Signed-off-by: karamaru-alpha --- test/testdata/copyloopvar.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/test/testdata/copyloopvar.go b/test/testdata/copyloopvar.go index f8c7efc6a43b..dd969202804f 100644 --- a/test/testdata/copyloopvar.go +++ b/test/testdata/copyloopvar.go @@ -1,17 +1,19 @@ //golangcitest:args -Ecopyloopvar package testdata +import "fmt" + func copyloopvarCase1() { slice := []int{1, 2, 3} fns := make([]func(), 0, len(slice)*2) for i, v := range slice { i := i // want `It's unnecessary to copy the loop variable "i"` fns = append(fns, func() { - _ = i + fmt.Println(i) }) _v := v // want `It's unnecessary to copy the loop variable "v"` fns = append(fns, func() { - _ = _v + fmt.Println(_v) }) } for _, fn := range fns { @@ -25,7 +27,7 @@ func copyloopvarCase2() { for i := 1; i <= loopCount; i++ { i := i // want `It's unnecessary to copy the loop variable "i"` fns = append(fns, func() { - _ = i + fmt.Println(i) }) } for _, fn := range fns { From 5d806d1cb76034ba2e4393769f3640b76b2db65f Mon Sep 17 00:00:00 2001 From: karamaru-alpha Date: Wed, 14 Feb 2024 12:33:06 +0900 Subject: [PATCH 4/7] update: LoadMode Type to Syntax Signed-off-by: karamaru-alpha --- pkg/golinters/copyloopvar.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/golinters/copyloopvar.go b/pkg/golinters/copyloopvar.go index 1fe73aad119f..0389ddddb909 100644 --- a/pkg/golinters/copyloopvar.go +++ b/pkg/golinters/copyloopvar.go @@ -15,5 +15,5 @@ func NewCopyLoopVar() *goanalysis.Linter { a.Doc, []*analysis.Analyzer{a}, nil, - ).WithLoadMode(goanalysis.LoadModeTypesInfo) + ).WithLoadMode(goanalysis.LoadModeSyntax) } From 1f40e1e022e98504dc240cc4ada42bc984f24002 Mon Sep 17 00:00:00 2001 From: karamaru-alpha Date: Wed, 14 Feb 2024 14:07:34 +0900 Subject: [PATCH 5/7] upgrade: copyloopvar v1.0.2 to v1.0.3 Signed-off-by: karamaru-alpha --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 352a7802a892..8852a952dd9f 100644 --- a/go.mod +++ b/go.mod @@ -60,7 +60,7 @@ require ( github.com/jirfag/go-printf-func-name v0.0.0-20200119135958-7558a9eaa5af github.com/jjti/go-spancheck v0.5.2 github.com/julz/importas v0.1.0 - github.com/karamaru-alpha/copyloopvar v1.0.2 + github.com/karamaru-alpha/copyloopvar v1.0.3 github.com/kisielk/errcheck v1.7.0 github.com/kkHAIKE/contextcheck v1.1.4 github.com/kulti/thelper v0.6.3 diff --git a/go.sum b/go.sum index ac2059b203e8..5d11bd2867d6 100644 --- a/go.sum +++ b/go.sum @@ -320,8 +320,8 @@ github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7V github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM= github.com/julz/importas v0.1.0 h1:F78HnrsjY3cR7j0etXy5+TU1Zuy7Xt08X/1aJnH5xXY= github.com/julz/importas v0.1.0/go.mod h1:oSFU2R4XK/P7kNBrnL/FEQlDGN1/6WoxXEjSSXO0DV0= -github.com/karamaru-alpha/copyloopvar v1.0.2 h1:tmJjTFg4edmOuFTSBuxeueH8lL21kmCPTQHILQcYJWw= -github.com/karamaru-alpha/copyloopvar v1.0.2/go.mod h1:u7CIfztblY0jZLOQZgH3oYsJzpC2A7S6u/lfgSXHy0k= +github.com/karamaru-alpha/copyloopvar v1.0.3 h1:RqIwhmGdMFmXU2DYZhMbKl87CuDHJHD+yo/iz+UQMhE= +github.com/karamaru-alpha/copyloopvar v1.0.3/go.mod h1:u7CIfztblY0jZLOQZgH3oYsJzpC2A7S6u/lfgSXHy0k= github.com/kisielk/errcheck v1.7.0 h1:+SbscKmWJ5mOK/bO1zS60F5I9WwZDWOfRsC4RwfwRV0= github.com/kisielk/errcheck v1.7.0/go.mod h1:1kLL+jV4e+CFfueBmI1dSK2ADDyQnlrnrY/FqKluHJQ= github.com/kisielk/gotool v1.0.0 h1:AV2c/EiW3KqPNT9ZKl07ehoAGi4C5/01Cfbblndcapg= From 40cd9ea409a3fa4aaef8b4ae9cac71a30ae72ca5 Mon Sep 17 00:00:00 2001 From: karamaru-alpha Date: Wed, 14 Feb 2024 14:10:25 +0900 Subject: [PATCH 6/7] fix: remove WithLoadForGoAnalysis Signed-off-by: karamaru-alpha --- pkg/lint/lintersdb/manager.go | 1 - 1 file changed, 1 deletion(-) diff --git a/pkg/lint/lintersdb/manager.go b/pkg/lint/lintersdb/manager.go index d06f1495c74c..0bc89ab7e1bd 100644 --- a/pkg/lint/lintersdb/manager.go +++ b/pkg/lint/lintersdb/manager.go @@ -300,7 +300,6 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config { linter.NewConfig(golinters.NewCopyLoopVar()). WithSince("v1.57.0"). - WithLoadForGoAnalysis(). WithPresets(linter.PresetStyle). WithURL("https://github.com/karamaru-alpha/copyloopvar"), From 02dd963fe5d51498878f57695a413c7b75368db2 Mon Sep 17 00:00:00 2001 From: karamaru-alpha Date: Fri, 16 Feb 2024 07:25:03 +0900 Subject: [PATCH 7/7] upgrade: copyloopvar --- go.mod | 2 +- go.sum | 4 ++-- test/testdata/copyloopvar.go | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/go.mod b/go.mod index 8852a952dd9f..84a06a21b855 100644 --- a/go.mod +++ b/go.mod @@ -60,7 +60,7 @@ require ( github.com/jirfag/go-printf-func-name v0.0.0-20200119135958-7558a9eaa5af github.com/jjti/go-spancheck v0.5.2 github.com/julz/importas v0.1.0 - github.com/karamaru-alpha/copyloopvar v1.0.3 + github.com/karamaru-alpha/copyloopvar v1.0.4 github.com/kisielk/errcheck v1.7.0 github.com/kkHAIKE/contextcheck v1.1.4 github.com/kulti/thelper v0.6.3 diff --git a/go.sum b/go.sum index 5d11bd2867d6..b7f4651963e4 100644 --- a/go.sum +++ b/go.sum @@ -320,8 +320,8 @@ github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7V github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM= github.com/julz/importas v0.1.0 h1:F78HnrsjY3cR7j0etXy5+TU1Zuy7Xt08X/1aJnH5xXY= github.com/julz/importas v0.1.0/go.mod h1:oSFU2R4XK/P7kNBrnL/FEQlDGN1/6WoxXEjSSXO0DV0= -github.com/karamaru-alpha/copyloopvar v1.0.3 h1:RqIwhmGdMFmXU2DYZhMbKl87CuDHJHD+yo/iz+UQMhE= -github.com/karamaru-alpha/copyloopvar v1.0.3/go.mod h1:u7CIfztblY0jZLOQZgH3oYsJzpC2A7S6u/lfgSXHy0k= +github.com/karamaru-alpha/copyloopvar v1.0.4 h1:JD6IPXo4+RawkSPe9uMKh9OtTzYKsCelAgPMUwaVxBw= +github.com/karamaru-alpha/copyloopvar v1.0.4/go.mod h1:u7CIfztblY0jZLOQZgH3oYsJzpC2A7S6u/lfgSXHy0k= github.com/kisielk/errcheck v1.7.0 h1:+SbscKmWJ5mOK/bO1zS60F5I9WwZDWOfRsC4RwfwRV0= github.com/kisielk/errcheck v1.7.0/go.mod h1:1kLL+jV4e+CFfueBmI1dSK2ADDyQnlrnrY/FqKluHJQ= github.com/kisielk/gotool v1.0.0 h1:AV2c/EiW3KqPNT9ZKl07ehoAGi4C5/01Cfbblndcapg= diff --git a/test/testdata/copyloopvar.go b/test/testdata/copyloopvar.go index dd969202804f..a1fb44164d3f 100644 --- a/test/testdata/copyloopvar.go +++ b/test/testdata/copyloopvar.go @@ -7,11 +7,11 @@ func copyloopvarCase1() { slice := []int{1, 2, 3} fns := make([]func(), 0, len(slice)*2) for i, v := range slice { - i := i // want `It's unnecessary to copy the loop variable "i"` + i := i // want `The copy of the 'for' variable "i" can be deleted \(Go 1\.22\+\)` fns = append(fns, func() { fmt.Println(i) }) - _v := v // want `It's unnecessary to copy the loop variable "v"` + _v := v // want `The copy of the 'for' variable "v" can be deleted \(Go 1\.22\+\)` fns = append(fns, func() { fmt.Println(_v) }) @@ -25,7 +25,7 @@ func copyloopvarCase2() { loopCount := 3 fns := make([]func(), 0, loopCount) for i := 1; i <= loopCount; i++ { - i := i // want `It's unnecessary to copy the loop variable "i"` + i := i // want `The copy of the 'for' variable "i" can be deleted \(Go 1\.22\+\)` fns = append(fns, func() { fmt.Println(i) })