Merge pull request #228 from oferchen/codex/update-comment-formatting-in-multiple-files

Allow //go:build lines in comment check

Author: oferchen

cmd/commentcheck/main.go

@@ -35,14 +35,18 @@ func check(root string) error {
 		if err != nil {
 			return err
 		}
+		var nonBuild []token.Position
 		for _, cg := range file.Comments {
 			for _, c := range cg.List {
-				if fset.Position(c.Slash).Line > 1 {
-					bad = append(bad, path)
-					return nil
+				if strings.HasPrefix(c.Text, "//go:build") {
+					continue
 				}
+				nonBuild = append(nonBuild, fset.Position(c.Slash))
 			}
 		}
+		if len(nonBuild) != 1 || nonBuild[0].Line != 1 {
+			bad = append(bad, path)
+		}
 		return nil
 	}
 	if err := filepath.WalkDir(root, walk); err != nil {

cmd/commentcheck/main_test.go

@@ -10,14 +10,21 @@ import (
 func TestCheck(t *testing.T) {
 	t.Run("compliant", func(t *testing.T) {
 		dir := t.TempDir()
-		write(t, dir, "ok.go", "// ok.go\npackage main\n")
+		write(t, dir, "ok.go", "// ok.go\n//go:build test\n\npackage main\n")
 		if err := check(dir); err != nil {
 			t.Fatalf("unexpected error: %v", err)
 		}
 	})
-	t.Run("noncompliant", func(t *testing.T) {
+	t.Run("noncompliant extra comment", func(t *testing.T) {
 		dir := t.TempDir()
-		write(t, dir, "bad.go", "// bad.go\npackage main\n// bad\n")
+		write(t, dir, "bad.go", "// bad.go\n//go:build test\n\npackage main\n// bad\n")
+		if err := check(dir); err == nil {
+			t.Fatalf("expected error")
+		}
+	})
+	t.Run("noncompliant missing comment", func(t *testing.T) {
+		dir := t.TempDir()
+		write(t, dir, "bad.go", "//go:build test\n\npackage main\n")
 		if err := check(dir); err == nil {
 			t.Fatalf("expected error")
 		}

internal/fs/ewindows_other.go

@@ -1,6 +1,6 @@
+// internal/fs/ewindows_other.go
 //go:build !windows
 
-// internal/fs/ewindows_other.go
 package fs
 
 func isErrWindows(err error) bool {

internal/fs/ewindows_windows.go

@@ -1,6 +1,6 @@
+// internal/fs/ewindows_windows.go
 //go:build windows
 
-// internal/fs/ewindows_windows.go
 package fs
 
 import (

internal/fs/stdio.go

@@ -1,3 +1,4 @@
+// internal/fs/stdio.go
 package fs
 
 import "io"