feat: make rules configurable (#4)

Complete the refactor from database/sql specific rowserr to configurable
uncalled.

Author: stevenh

.goreleaser.yaml

@@ -13,25 +13,25 @@ builds:
     goarch:
       - amd64
       - arm64
-    main: ./cmd/rowserr
-    id: rowserr
-    binary: rowserr
+    main: ./cmd/uncalled
+    id: uncalled
+    binary: uncalled
 universal_binaries:
   - replace: true
-    id: rowserr
+    id: uncalled
 checksum:
   name_template: 'checksums.txt'
 snapshot:
   name_template: '{{ incpatch .Version }}-next'
 archives:
-  - id: rowserr
+  - id: uncalled
     name_template: '{{ .Binary }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}{{ if .Mips }}_{{ .Mips }}{{ end }}'
 release:
   header: |
     <a name='{{.Tag}}'></a>
     ### {{.Tag}} Release Notes ({{.Date}})
   footer: |
-    [Full Changelog](https://github.com/stevenh/go-rowserr/cmd/rowserr/compare/{{ .PreviousTag }}...{{ .Tag }})
+    [Full Changelog](https://github.com/stevenh/go-uncalled/cmd/uncalled/compare/{{ .PreviousTag }}...{{ .Tag }})
 changelog:
   use: github
   sort: asc
@@ -51,22 +51,22 @@ changelog:
   # Default is no groups.
   groups:
     - title: Features
-      regexp: '^.*(feat|feature)(\([[:word:]]+\))??!?:.+$'
+      regexp: '^.*?(feat|feature)(\([[:word:]]+\))??!?:.+$'
       order: 0
     - title: 'Bug fixes'
-      regexp: '^.*fix(\([[:word:]]+\))??!?:.+$'
+      regexp: '^.*?fix(\([[:word:]]+\))??!?:.+$'
       order: 1
     - title: 'Chores'
-      regexp: '^.*chore(\([[:word:]]+\))??!?:.+$'
+      regexp: '^.*?chore(\([[:word:]]+\))??!?:.+$'
       order: 2
     - title: 'Quality'
-      regexp: '^.*(qa|test|tests)(\([[:word:]]+\))??!?:.+$'
+      regexp: '^.*?(qa|test|tests)(\([[:word:]]+\))??!?:.+$'
       order: 3
     - title: 'Documentation'
-      regexp: '^.*(doc|docs)(\([[:word:]]+\))??!?:.+$'
+      regexp: '^.*?(doc|docs)(\([[:word:]]+\))??!?:.+$'
       order: 4
     - title: 'Continuous Integration'
-      regexp: '^.*ci(\([[:word:]]+\))??!?:.+$'
+      regexp: '^.*?ci(\([[:word:]]+\))??!?:.+$'
       order: 5
     - title: Other
       order: 999

README.md

@@ -1,48 +1,48 @@
-# go-rowserr
+# go-uncalled
 
-[![Reference](https://pkg.go.dev/badge/github.com/stevenh/go-rowserr.svg)](https://pkg.go.dev/github.com/stevenh/go-rowserr) [![License](https://img.shields.io/badge/License-BSD_2--Clause-blue.svg)](https://opensource.org/licenses/BSD-2-Clause) [![Go Report Card](https://goreportcard.com/badge/github.com/stevenh/go-rowserr)](https://goreportcard.com/report/github.com/stevenh/go-rowserr)
+[![Reference](https://pkg.go.dev/badge/github.com/stevenh/go-uncalled.svg)](https://pkg.go.dev/github.com/stevenh/go-uncalled) [![License](https://img.shields.io/badge/License-BSD_2--Clause-blue.svg)](https://opensource.org/licenses/BSD-2-Clause) [![Go Report Card](https://goreportcard.com/badge/github.com/stevenh/go-uncalled)](https://goreportcard.com/report/github.com/stevenh/go-uncalled)
 
-go-rowserr is a static analysis tool for golang which checks for missing [Rows.Err()](https://pkg.go.dev/database/sql#Rows.Err) calls.
+go-uncalled is a static analysis tool for golang which checks for missing calls.
 
 It is compatible with both standard and generic functions as introduced by [golang](https://go.dev/) version [1.18](https://go.dev/doc/go1.18).
 
 ## Install
 
-You can install `rowserr` cmd using `go install` command.
+You can install the `uncalled` cmd using `go install` command.
 
 ```bash
-go install github.com/stevenh/go-rowserr/cmd/rowserr@latest
+go install github.com/stevenh/go-uncalled/cmd/uncalled@latest
 ```
 
 ## How to use
 
-You run `rowserr` with [go vet](https://pkg.go.dev/cmd/vet).
+You run `uncalled` with [go vet](https://pkg.go.dev/cmd/vet).
 
 ```bash
-go vet -vettool=$(which rowserr) ./...
-# github.com/stevenh/go-rowserr/test
-test/bad.go:10:2: rows.Err() must be checked
+go vet -vettool=$(which uncalled) ./...
+# github.com/stevenh/go-uncalled/test
+test/bad.go:10:2: rows.Err() must be called
 ```
 
-You can also run it directly:
+Or run it directly.
 ```bash
-rowserr ./...
-# github.com/stevenh/go-rowserr/test
-test/bad.go:10:2: rows.Err() must be checked
+uncalled ./...
+# github.com/stevenh/go-uncalled/test
+test/bad.go:10:2: rows.Err() must be called
 ```
 
-Additional package to check can be added using `-packages <pk1,pkg2...pkgN>`.
+A custom configuration can be loaded using `-config <filename>`.
 
 The version can be checked with `-version`.
 
-By default this checks the following packages:
-
-- [database/sql](https://pkg.go.dev/database/sql)
-- [github.com/jmoiron/sqlx](https://pkg.go.dev/github.com/jmoiron/sqlx)
+By default it includes the rules in:
+[pkg/uncalled/.uncalled.yaml](pkg/uncalled/.uncalled.yaml)
 
 ## Analyzer
 
-`rowserr` validates that code which uses [database/sql](https://pkg.go.dev/database/sql) and similar packages, to obtain [Rows](https://pkg.go.dev/database/sql#Rows) calls [Rows.Err()](https://pkg.go.dev/database/sql#Rows.Err) as described by
+`uncalled` validates that code to ensure expected calls are made.
+
+Its default config checks calls to [database/sql](https://pkg.go.dev/database/sql) and similar packages, that obtain [Rows](https://pkg.go.dev/database/sql#Rows) calls [Rows.Err()](https://pkg.go.dev/database/sql#Rows.Err) as described by
 
 - [sql.Rows.Next](https://pkg.go.dev/database/sql#Rows.Next)
 - [sql.Rows.NextResultSet](https://pkg.go.dev/database/sql#Rows.NextResultSet)
@@ -76,7 +76,7 @@ if err = rows.Err(); err != nil {
 }
 ```
 
-`rowserr` helps uncover such errors which will result in incomplete data if an error is triggered while processing rows.
+`uncalled` helps uncover such errors which will result in incomplete data if an error is triggered while processing rows.
 This can happen when a connection becomes invalid, this causes [Rows.Next()](https://pkg.go.dev/database/sql#Rows.Next) or [sql.Rows.NextResultSet](https://pkg.go.dev/database/sql#Rows.NextResultSet) to return false without processing all rows.
 
 ## Inspired by

cmd/rowserr/main.go

@@ -0,0 +1,13 @@
+//go:build !plugin
+
+// Command uncalled checks for missing calls.
+package main
+
+import (
+	"github.com/stevenh/go-uncalled/pkg/uncalled"
+	"golang.org/x/tools/go/analysis/singlechecker"
+)
+
+func main() {
+	singlechecker.Main(uncalled.NewAnalyzer())
+}

cmd/uncalled/main.go

@@ -1,19 +1,19 @@
 //go:build plugin
 
-// Command rowserr is a plugin which checks for missing database/sql.Rows.Err() calls.
+// Command uncalled is a plugin which checks for missing calls.
 package main
 
 import (
-	"github.com/stevenh/go-rowserr/pkg/rowserr"
+	"github.com/stevenh/go-uncalled/pkg/uncalled"
 	"golang.org/x/tools/go/analysis"
 )
 
 type analyzerPlugin struct{}
 
-// GetAnalyzers returns rowserr Analyzer.
+// GetAnalyzers returns uncalled Analyzer.
 func (analyzerPlugin) GetAnalyzers() []*analysis.Analyzer {
 	return []*analysis.Analyzer{
-		rowserr.Analyzer,
+		uncalled.NewAnalyzer(),
 	}
 }
 

cmd/rowserr/plugin.go renamed to cmd/uncalled/plugin.go

@@ -1,8 +1,11 @@
-module github.com/stevenh/go-rowserr
+module github.com/stevenh/go-uncalled
 
 go 1.19
 
-require golang.org/x/tools v0.2.0
+require (
+	golang.org/x/tools v0.2.0
+	gopkg.in/yaml.v3 v3.0.1
+)
 
 require (
 	golang.org/x/mod v0.6.0 // indirect

go.mod

@@ -4,3 +4,7 @@ golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/tools v0.2.0 h1:G6AHpWxTMGY1KyEYoAQ5WTtIekUUvDNjan3ugu60JvE=
 golang.org/x/tools v0.2.0/go.mod h1:y4OqIKeOV/fWJetJ8bXPU1sEVniLMIyDAZWeHdV+NTA=
+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=