feat: plugin example

Author: ldez

.gitignore

@@ -0,0 +1,9 @@
+/.idea/
+/.vscode/
+/dist/
+.DS_Store
+/*.pprof
+/*.txt
+/golangci-lint
+/golangci-lint.exe
+/example.so

.golangci.example.yml

@@ -0,0 +1,19 @@
+linters-settings:
+  custom:
+    example:
+      type: module
+      # Description is optional
+      description: The description of the linter. This is optional, but shows up when running `golangci-lint linters`.
+      # Original-url is optional, and is only used for documentation purposes.
+      original-url: github.com/golangci/example-plugin-module-linter
+      settings:
+        one: Foo
+        two:
+          - name: Bar
+        three:
+          name: Bar
+
+linters:
+  disable-all: true
+  enable:
+    - example

LICENSE

@@ -0,0 +1,75 @@
+package linters
+
+import (
+	"go/ast"
+	"strings"
+
+	"github.com/golangci/plugin-module-register/register"
+	"golang.org/x/tools/go/analysis"
+)
+
+func init() {
+	register.Plugin("example", New)
+}
+
+type MySettings struct {
+	One   string    `json:"one"`
+	Two   []Element `json:"two"`
+	Three Element   `json:"three"`
+}
+
+type Element struct {
+	Name string `json:"name"`
+}
+
+type PluginExample struct {
+	settings MySettings
+}
+
+func New(settings any) (register.LinterPlugin, error) {
+	// The configuration type will be map[string]any or []interface, it depends on your configuration.
+	// You can use https://github.com/go-viper/mapstructure to convert map to struct.
+
+	s, err := register.DecodeSettings[MySettings](settings)
+	if err != nil {
+		return nil, err
+	}
+
+	return &PluginExample{settings: s}, nil
+}
+
+func (f *PluginExample) BuildAnalyzers() ([]*analysis.Analyzer, error) {
+	return []*analysis.Analyzer{
+		{
+			Name: "todo",
+			Doc:  "finds todos without author",
+			Run:  f.run,
+		},
+	}, nil
+}
+
+func (f *PluginExample) GetLoadMode() string {
+	return register.LoadModeSyntax
+}
+
+func (f *PluginExample) run(pass *analysis.Pass) (interface{}, error) {
+	for _, file := range pass.Files {
+		ast.Inspect(file, func(n ast.Node) bool {
+			if comment, ok := n.(*ast.Comment); ok {
+				if strings.HasPrefix(comment.Text, "// TODO:") || strings.HasPrefix(comment.Text, "// TODO():") {
+					pass.Report(analysis.Diagnostic{
+						Pos:            comment.Pos(),
+						End:            0,
+						Category:       "todo",
+						Message:        "TODO comment has no author",
+						SuggestedFixes: nil,
+					})
+				}
+			}
+
+			return true
+		})
+	}
+
+	return nil, nil
+}

example.go

@@ -0,0 +1,35 @@
+package linters
+
+import (
+	"path/filepath"
+	"runtime"
+	"testing"
+
+	"github.com/golangci/plugin-module-register/register"
+	"github.com/stretchr/testify/require"
+	"golang.org/x/tools/go/analysis/analysistest"
+)
+
+func TestPluginExample(t *testing.T) {
+	newPlugin, err := register.GetPlugin("example")
+	require.NoError(t, err)
+
+	plugin, err := newPlugin(nil)
+	require.NoError(t, err)
+
+	analyzers, err := plugin.BuildAnalyzers()
+	require.NoError(t, err)
+
+	analysistest.Run(t, testdataDir(t), analyzers[0], "testlintdata/todo")
+}
+
+func testdataDir(t *testing.T) string {
+	t.Helper()
+
+	_, testFilename, _, ok := runtime.Caller(1)
+	if !ok {
+		require.Fail(t, "unable to get current test filename")
+	}
+
+	return filepath.Join(filepath.Dir(testFilename), "testdata")
+}

example_test.go

@@ -0,0 +1,16 @@
+module github.com/golangci/example-plugin-module-linter
+
+go 1.21
+
+require (
+	github.com/golangci/plugin-module-register v0.0.0-20240305222101-f76272ec86ee
+	github.com/stretchr/testify v1.9.0
+	golang.org/x/tools v0.19.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/mod v0.16.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.mod

@@ -0,0 +1,18 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/golangci/plugin-module-register v0.0.0-20240305222101-f76272ec86ee h1:nl5nPZ5b2O2dj5+LizmFQ8gNq0r65OfALkp0M8EWJ8E=
+github.com/golangci/plugin-module-register v0.0.0-20240305222101-f76272ec86ee/go.mod h1:mGTAkB/NoZMvAGMkiv4+pmmwVO+Gp+zeV77nggByWCc=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic=
+golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
+golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
+golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/tools v0.19.0 h1:tfGCXNR1OsFG+sVdLAitlpjAvD/I6dHDKnYrpEZUHkw=
+golang.org/x/tools v0.19.0/go.mod h1:qoJWxmGSIBmAeriMx19ogtrEPrGtDbPK634QFIcLAhc=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

go.sum

@@ -0,0 +1 @@
+This is an example linter that can be used as a plugin for `golangci-lint`.

readme.md

@@ -0,0 +1,21 @@
+package todo
+
+// comment without a to do
+func SomeFunc1() {
+	_ = 1 + 1
+}
+
+// TODO: do something	// want "TODO comment has no author"
+func SomeFunc2() {
+	_ = 1 + 2
+}
+
+// TODO(): do something // want "TODO comment has no author"
+func SomeFunc3() {
+	_ = 1 + 3
+}
+
+// TODO(dbraley): Do something with the value
+func SomeFunc4() {
+	_ = 1 + 4
+}