add star-block like headers support

Signed-off-by: Denis Tingaikin <[email protected]>

Author: denis-tingaikin

analyzer.go

@@ -96,6 +96,13 @@ func (a *Analyzer) Analyze(target *Target) (i Issue) {
 	if len(file.Comments) > 0 && file.Comments[0].Pos() < file.Package {
 		if strings.HasPrefix(file.Comments[0].List[0].Text, "/*") {
 			header = (&ast.CommentGroup{List: []*ast.Comment{file.Comments[0].List[0]}}).Text()
+			header = trimEachLine(strings.TrimSpace(header), strings.TrimSpace)
+			header = trimEachLine(header, func(s string) string {
+				return strings.TrimFunc(s, func(r rune) bool {
+					return r == '*'
+				})
+			})
+			header = trimEachLine(strings.TrimSpace(header), strings.TrimSpace)
 		} else {
 			header = file.Comments[0].Text()
 			offset.Position += 3
@@ -112,6 +119,7 @@ func (a *Analyzer) Analyze(target *Target) (i Issue) {
 		i = NewIssueWithFix(i.Message(), i.Location(), fix)
 	}()
 	header = strings.TrimSpace(header)
+
 	if header == "" {
 		return NewIssue("Missed header for check")
 	}
@@ -305,3 +313,11 @@ func countLines(text string) int {
 	}
 	return lines
 }
+
+func trimEachLine(input string, trimFunc func(string) string) string {
+	lines := strings.Split(input, "\n")
+	for i, line := range lines {
+		lines[i] = trimFunc(line)
+	}
+	return strings.Join(lines, "\n")
+}

analyzer_test.go

@@ -93,6 +93,12 @@ func TestAnalyzer_Analyze(t *testing.T) {
 			config:   "readme/readme.yml",
 			assert:   assert.Nil,
 		},
+		{
+			desc:     "star-block like header",
+			filename: "starcomment/starcomment.go",
+			config:   "starcomment/starcomment.yml",
+			assert:   assert.Nil,
+		},
 	}
 
 	for _, test := range testCases {

testdata/starcomment/starcomment.go

@@ -0,0 +1,6 @@
+/*
+ * A 2020
+ * B
+ */
+
+package constvalue

testdata/starcomment/starcomment.yml

@@ -0,0 +1,7 @@
+template: |-
+  A {{ .YEAR }}
+  B
+
+vars:
+  'YEAR': '2020'
+