CI: add docnametypo linter and fix issues (#6493)

Author: cce

.custom-gcl.yml

@@ -8,3 +8,6 @@ plugins:
   - module: fillmore-labs.com/errortype
     import: fillmore-labs.com/errortype/gclplugin
     version: v0.0.7
+  - module: github.com/cce/docnametypo
+    import: github.com/cce/docnametypo/gclplugin
+    version: v0.2.0

.golangci-warnings.yml

@@ -4,16 +4,23 @@ run:
 linters:
   default: none
   enable:
+    - docnametypo
+    - errortype
     - gosec
     - partitiontest
-    - errortype
   settings:
     gosec:
       excludes: [G101, G103, G104, G107, G112, G114, G115, G202, G204, G301, G302, G303, G304, G306, G307, G404]
     custom:
-      partitiontest:
-        type: "module"
-        description: This custom linter ensures test functions call 'partitiontest.PartitionTest(t)'
+      docnametypo:
+        type: module
+        description: "docnametypo catches doc comments with mismatched function names"
+        original-url: "https://github.com/cce/docnametypo"
+        settings:
+          include-exported: true
+          include-types: true
+          include-generated: false
+          allowed-prefixes: asm,op
       errortype:
         type: module
         description: "errortype helps prevent subtle bugs in error handling."
@@ -24,6 +31,9 @@ linters:
           check-is: true
           unchecked-assert: false
           check-unused: true
+      partitiontest:
+        type: "module"
+        description: This custom linter ensures test functions call 'partitiontest.PartitionTest(t)'
   exclusions:
     generated: lax
     rules:

Makefile

@@ -112,6 +112,9 @@ modernize:
 lint: deps
 	$(GOBIN)/golangci-lint run -c .golangci.yml
 
+warninglint: custom-golangci-lint
+	./custom-golangci-lint run -c .golangci-warnings.yml
+
 expectlint:
 	cd test/e2e-go/cli/goal/expect && python3 expect_linter.py *.exp
 
@@ -423,6 +426,5 @@ include ./scripts/release/mule/Makefile.mule
 archive:
 	aws s3 cp tmp/node_pkgs s3://algorand-internal/channel/$(CHANNEL)/$(FULLBUILDNUMBER) --recursive --exclude "*" --include "*$(FULLBUILDNUMBER)*"
 
-build_custom_linters:
+custom-golangci-lint: .custom-gcl.yml
 	golangci-lint custom -v
-	./custom-golangci-lint --version

agreement/bundle.go

@@ -52,7 +52,7 @@ type bundle struct {
 	EquivocationVotes []equivocationVote `codec:"eqv,allocbound=bounds.MaxVoteThreshold"`
 }
 
-// voteAuthenticators omit the Round, Period, Step, and Proposal for compression
+// voteAuthenticator omits the Round, Period, Step, and Proposal for compression
 // and to simplify checking logic.
 type voteAuthenticator struct {
 	_struct struct{} `codec:""` // not omitempty

agreement/cryptoRequestContext.go

@@ -46,7 +46,7 @@ type roundRequestsContext struct {
 	periods map[cryptoRequestCtxKey]periodRequestsContext
 }
 
-// pendingRequests keeps the context for all pending requests
+// pendingRequestsContext keeps the context for all pending requests
 //
 //msgp:ignore pendingRequestsContext
 type pendingRequestsContext map[round]roundRequestsContext

agreement/events_test.go

@@ -25,7 +25,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// TestSerializableErrorBackwardCompatible ensures Err field of type serializableError can be
+// TestSerializableErrorBackwardCompatibility ensures Err field of type serializableError can be
 // properly decoded from ConsensusVersionView.
 // This test is only needed for agreement state serialization switch from reflection to msgp.
 func TestSerializableErrorBackwardCompatibility(t *testing.T) {

agreement/fuzzer/catchupFilter_test.go

@@ -104,7 +104,7 @@ func MakeCatchupFilterFactory(config *CatchupFilterConfig) *CatchupFilter {
 	}
 }
 
-// Unmarshall CatchupFilter
+// Unmarshal CatchupFilter
 func (n *CatchupFilter) Unmarshal(b []byte) NetworkFilterFactory {
 	type catchupFilterJSON struct {
 		Name string

agreement/fuzzer/clockedFilter_test.go

@@ -86,7 +86,7 @@ func (n *ClockedFilter) Tick(newClockTime int) bool {
 	return n.upstream.Tick(int(n.localClock))
 }
 
-// Unmarshall ClockedFilter
+// Unmarshal ClockedFilter
 func (n *ClockedFilter) Unmarshal(b []byte) NetworkFilterFactory {
 	type clockedFilterJSON struct {
 		Name             string

agreement/fuzzer/dropMessageFilter_test.go

@@ -96,7 +96,7 @@ func (n *DropMessageFilter) Marshal() (bytes []byte, err error) {
 
 }
 
-// Unmarshall DropMessageFilter
+// Unmarshal DropMessageFilter
 func (n *DropMessageFilter) Unmarshal(b []byte) NetworkFilterFactory {
 	type dropMessageFilterJSON struct {
 		Name               string

agreement/fuzzer/messageDecoderFilter_test.go

@@ -19,6 +19,7 @@ package fuzzer
 import (
 	"bytes"
 	"encoding/json"
+
 	"github.com/algorand/go-deadlock"
 
 	//"github.com/algorand/go-algorand/agreement"
@@ -107,7 +108,7 @@ type (
 		EquivocationVotes []equivocationVote `codec:"eqv"`
 	}
 
-	// voteAuthenticators omit the Round, Period, Step, and Proposal for compression
+	// voteAuthenticator omits the Round, Period, Step, and Proposal for compression
 	// and to simplify checking logic.
 	voteAuthenticator struct {
 		Sender basics.Address                      `codec:"snd"`
@@ -324,7 +325,7 @@ func (n *MessageDecoderFilter) getDecodedMessageCounts(tag protocol.Tag) int {
 	return -1
 }
 
-// Unmarshall MessageDecoderFilter
+// Unmarshal MessageDecoderFilter
 func (n *MessageDecoderFilter) Unmarshal(b []byte) NetworkFilterFactory {
 	type messageDecoderFilterJSON struct {
 		Name string