fix: anonymous/inaccessible structs for commentstart

Author: tsuzu

pkg/analysis/commentstart/analyzer.go

@@ -42,43 +42,59 @@ func run(pass *analysis.Pass) (interface{}, error) {
 
 	// Filter to structs so that we can iterate over fields in a struct.
 	nodeFilter := []ast.Node{
-		(*ast.StructType)(nil),
+		(*ast.Field)(nil),
 	}
 
-	inspect.Preorder(nodeFilter, func(n ast.Node) {
-		sTyp, ok := n.(*ast.StructType)
+	inspect.WithStack(nodeFilter, func(n ast.Node, push bool, stack []ast.Node) (proceed bool) {
+		if !push {
+			return false
+		}
+
+		if len(stack) < 2 {
+			return true
+		}
+
+		// The 0th node in the stack is the *ast.File.
+		// The 1st node in the stack is the *ast.GenDecl.
+		decl, ok := stack[1].(*ast.GenDecl)
 		if !ok {
-			return
+			return false
 		}
 
-		if sTyp.Fields == nil {
-			return
+		if decl.Tok != token.TYPE {
+			return false
 		}
 
-		for _, field := range sTyp.Fields.List {
-			checkField(pass, field, jsonTags)
+		field, ok := n.(*ast.Field)
+		if !ok {
+			return true
 		}
+
+		return checkField(pass, field, jsonTags)
 	})
 
 	return nil, nil //nolint:nilnil
 }
 
-func checkField(pass *analysis.Pass, field *ast.Field, jsonTags extractjsontags.StructFieldTags) {
+func checkField(pass *analysis.Pass, field *ast.Field, jsonTags extractjsontags.StructFieldTags) (proceed bool) {
 	if field == nil || len(field.Names) == 0 {
-		return
+		return false
 	}
 
-	fieldName := field.Names[0].Name
-
 	tagInfo := jsonTags.FieldTags(field)
+	if tagInfo.Ignored {
+		return false
+	}
 
 	if tagInfo.Name == "" {
-		return
+		return true
 	}
 
+	fieldName := field.Names[0].Name
+
 	if field.Doc == nil {
 		pass.Reportf(field.Pos(), "field %s is missing godoc comment", fieldName)
-		return
+		return true
 	}
 
 	firstLine := field.Doc.List[0]
@@ -105,4 +121,6 @@ func checkField(pass *analysis.Pass, field *ast.Field, jsonTags extractjsontags.
 			pass.Reportf(field.Doc.List[0].Pos(), "godoc for field %s should start with '%s ...'", fieldName, tagInfo.Name)
 		}
 	}
+
+	return true
 }

pkg/analysis/commentstart/testdata/src/a/a.go

@@ -8,6 +8,18 @@ type CommentStartTestStruct struct {
 	Ignored       string `json:"-"`
 	Hyphen        string `json:"-,"` // want "field Hyphen is missing godoc comment"
 
+	AnonymousStruct struct { // want "field AnonymousStruct is missing godoc comment"
+		NoComment string `json:"noComment"` // want "field NoComment is missing godoc comment"
+	} `json:"anonymousStruct"`
+
+	AnonymousStructInlineJSONTag struct {
+		NoComment string `json:"noComment"` // want "field NoComment is missing godoc comment"
+	} `json:",inline"`
+
+	IgnoredAnonymousStruct struct {
+		NoComment string `json:"noComment"`
+	} `json:"-"`
+
 	// IncorrectStartComment is a field with an incorrect start to the comment. // want "godoc for field IncorrectStartComment should start with 'incorrectStartComment ...'"
 	IncorrectStartComment string `json:"incorrectStartComment"`
 
@@ -34,3 +46,13 @@ type CommentStartTestStruct struct {
 
 // DoNothing is used to check that the analyser doesn't report on methods.
 func (CommentStartTestStruct) DoNothing() {}
+
+type unexportedStruct struct {
+	NoComment string `json:"noComment"` // want "field NoComment is missing godoc comment"
+}
+
+func FunctionWithStructs() {
+	type InaccessibleStruct struct {
+		NoComment string `json:"noComment"`
+	}
+}

pkg/analysis/commentstart/testdata/src/a/a.go.golden

@@ -8,6 +8,18 @@ type CommentStartTestStruct struct {
 	Ignored       string `json:"-"`
 	Hyphen        string `json:"-,"` // want "field Hyphen is missing godoc comment"
 
+	AnonymousStruct struct { // want "field AnonymousStruct is missing godoc comment"
+		NoComment string `json:"noComment"` // want "field NoComment is missing godoc comment"
+	} `json:"anonymousStruct"`
+
+	AnonymousStructInlineJSONTag struct {
+		NoComment string `json:"noComment"` // want "field NoComment is missing godoc comment"
+	} `json:",inline"`
+
+	IgnoredAnonymousStruct struct {
+		NoComment string `json:"noComment"`
+	} `json:"-"`
+
 	// incorrectStartComment is a field with an incorrect start to the comment. // want "godoc for field IncorrectStartComment should start with 'incorrectStartComment ...'"
 	IncorrectStartComment string `json:"incorrectStartComment"`
 
@@ -34,3 +46,13 @@ type CommentStartTestStruct struct {
 
 // DoNothing is used to check that the analyser doesn't report on methods.
 func (CommentStartTestStruct) DoNothing() {}
+
+type unexportedStruct struct {
+	NoComment string `json:"noComment"` // want "field NoComment is missing godoc comment"
+}
+
+func FunctionWithStructs() {
+	type InaccessibleStruct struct {
+		NoComment string `json:"noComment"`
+	}
+}