Support ignore comment alongside godoc (#731)

Fixes #710
temporalio · Feb 22, 2022 · 621fd1e · 621fd1e
1 parent 2c19379
commit 621fd1e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/contrib/tools/workflowcheck/determinism/checker.go b/contrib/tools/workflowcheck/determinism/checker.go
@@ -203,8 +203,12 @@ func updateIgnoreMap(fset *token.FileSet, f *ast.File, m map[ast.Node]struct{})
 	// Collect only the ignore comments
 	var comments []*ast.CommentGroup
 	for _, group := range f.Comments {
-		if len(group.List) == 1 && strings.HasPrefix(group.List[0].Text, "//workflowcheck:ignore") {
-			comments = append(comments, group)
+		// Check each comment in list so Godoc and others can be in any order
+		for _, comment := range group.List {
+			if strings.HasPrefix(comment.Text, "//workflowcheck:ignore") {
+				comments = append(comments, group)
+				break
+			}
 		}
 	}
 	// Bail if no comments

diff --git a/contrib/tools/workflowcheck/determinism/testdata/src/a/ignore.go b/contrib/tools/workflowcheck/determinism/testdata/src/a/ignore.go
@@ -16,6 +16,7 @@ func IgnoreAboveLine() { // want IgnoreAboveLine:"calls non-deterministic functi
 }
 
 //workflowcheck:ignore
+// IgnoreEntireFunction can have a Godoc comment too
 func IgnoreEntireFunction() {
 	fmt.Print("Do not ignore this")
 	fmt.Printf("Ignore this")