Merge branch 'master' into use-acmd

.github/workflows/go.yml

@@ -20,6 +20,10 @@ jobs:
       run: |
         make ci-linter
 
+    - name: Precompiled
+      run: |
+        make ci-generate
+
     - name: Test
       run: |
         make ci-tests

Makefile

@@ -24,7 +24,7 @@ docs:
 	cd ./cmd/makedocs && go run main.go
 
 ci:
-	@if [ "$(TEST_SUITE)" = "linter" ]; then make ci-linter; else make ci-tidy; make ci-tests; fi
+	@if [ "$(TEST_SUITE)" = "linter" ]; then make ci-linter; else make ci-tidy; make ci-generate; make ci-tests; fi
 
 ci-tidy:
 	go mod tidy
@@ -35,6 +35,10 @@ ci-tidy:
 ci-tests:
 	GOCRITIC_EXTERNAL_TESTS=1 go test -v -race -count=1 -coverprofile=coverage.out ./...
 
+ci-generate:
+	go generate ./...
+	git diff --exit-code --quiet || (echo "Please run 'go generate ./...' to update precompiled rules."; false)
+
 ci-linter:
 	@curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH_DIR)/bin v1.30.0
 	@$(GOPATH_DIR)/bin/golangci-lint run -v

checkers/testdata/todoCommentWithoutDetail/negative_tests.go

@@ -0,0 +1,10 @@
+package checker_test
+
+func ExampleFoo() {
+	// TODO: something important
+	// TODO(jim)
+	// FIX fix this
+	// FIXME(bob)
+	//     TODO this
+	// BUG: oh no this is broken
+}

checkers/testdata/todoCommentWithoutDetail/positive_tests.go

@@ -0,0 +1,16 @@
+package checker_test
+
+func singleLineCode() {
+
+	/*! may want to add detail/assignee to this TODO/FIXME/BUG comment */
+	// TODO
+
+	/*! may want to add detail/assignee to this TODO/FIXME/BUG comment */
+	// FIX
+
+	/*! may want to add detail/assignee to this TODO/FIXME/BUG comment */
+	// FIXME
+
+	/*! may want to add detail/assignee to this TODO/FIXME/BUG comment */
+	// BUG
+}

checkers/todoCommentWithoutDetail_checker.go

@@ -0,0 +1,50 @@
+package checkers
+
+import (
+	"go/ast"
+	"regexp"
+
+	"github.com/go-critic/go-critic/checkers/internal/astwalk"
+	"github.com/go-critic/go-critic/framework/linter"
+)
+
+func init() {
+	var info linter.CheckerInfo
+	info.Name = "todoCommentWithoutDetail"
+	info.Tags = []string{"style", "opinionated", "experimental"}
+	info.Summary = "Detects TODO comments without detail/assignee"
+	info.Before = `
+// TODO
+fiiWithCtx(nil, a, b)
+`
+	info.After = `
+// TODO(admin): pass context.TODO() instead of nil
+fiiWithCtx(nil, a, b)
+`
+	collection.AddChecker(&info, func(ctx *linter.CheckerContext) (linter.FileWalker, error) {
+		visitor := &todoCommentWithoutCodeChecker{
+			ctx:   ctx,
+			regex: regexp.MustCompile(`^(//|/\*)?\s*(TODO|FIX|FIXME|BUG)\s*(\*/)?$`),
+		}
+		return astwalk.WalkerForComment(visitor), nil
+	})
+}
+
+type todoCommentWithoutCodeChecker struct {
+	astwalk.WalkHandler
+	ctx   *linter.CheckerContext
+	regex *regexp.Regexp
+}
+
+func (c *todoCommentWithoutCodeChecker) VisitComment(cg *ast.CommentGroup) {
+	for _, comment := range cg.List {
+		if c.regex.MatchString(comment.Text) {
+			c.warn(cg)
+			break
+		}
+	}
+}
+
+func (c *todoCommentWithoutCodeChecker) warn(cause ast.Node) {
+	c.ctx.Warn(cause, "may want to add detail/assignee to this TODO/FIXME/BUG comment")
+}