Add noinline option for checking all comments except inlined.

README.md

@@ -36,6 +36,7 @@ defaults are used:
 # Which comments to check:
 #   declarations - for top level declaration comments (default);
 #   toplevel     - for top level comments;
+#   noinline     - for all except inline comments;
 #   all          - for all comments.
 scope: declarations
 

getters.go

@@ -66,6 +66,9 @@ func (pf *parsedFile) getComments(scope Scope, exclude []*regexp.Regexp) []comme
 	case AllScope:
 		// All comments
 		comments = pf.getAllComments(exclude)
+	case NoInlineScope:
+		// All except inline comments
+		comments = pf.getNoInline(exclude)
 	case TopLevelScope:
 		// All top level comments and comments from the inside
 		// of top level blocks
@@ -173,6 +176,34 @@ func (pf *parsedFile) getDeclarationComments(exclude []*regexp.Regexp) []comment
 	return comments
 }
 
+// getNoInline gets all except inline comments.
+func (pf *parsedFile) getNoInline(exclude []*regexp.Regexp) []comment {
+	var comments []comment //nolint:prealloc
+	for _, c := range pf.file.Comments {
+		if c == nil || len(c.List) == 0 {
+			continue
+		}
+		firstLine := pf.fset.Position(c.Pos()).Line
+		lastLine := pf.fset.Position(c.End()).Line
+
+		c := comment{
+			lines: pf.lines[firstLine-1 : lastLine],
+			start: pf.fset.Position(c.List[0].Slash),
+			text:  getText(c, exclude),
+		}
+
+		// Skip inline
+		if len(c.lines) == 1 {
+			before := c.lines[0][:c.start.Column-1]
+			if len(strings.TrimSpace(before)) > 0 {
+				continue
+			}
+		}
+		comments = append(comments, c)
+	}
+	return comments
+}
+
 // getAllComments gets every single comment from the file.
 func (pf *parsedFile) getAllComments(exclude []*regexp.Regexp) []comment {
 	var comments []comment //nolint:prealloc

getters_test.go

@@ -38,10 +38,15 @@ func TestGetComments(t *testing.T) {
 			scope:    TopLevelScope,
 			contains: []string{"[DECL]", "[TOP]"},
 		},
+		{
+			name:     "scope: noinline",
+			scope:    NoInlineScope,
+			contains: []string{"[DECL]", "[TOP]", "[ALL]"},
+		},
 		{
 			name:     "scope: all",
 			scope:    AllScope,
-			contains: []string{"[DECL]", "[TOP]", "[ALL]"},
+			contains: []string{"[DECL]", "[TOP]", "[ALL]", "[INLINE]"},
 		},
 	}
 

godot_test.go

@@ -95,13 +95,23 @@ func TestRun(t *testing.T) {
 				"[PERIOD_TOP]", "[CAPITAL_TOP]",
 			},
 		},
+		{
+			name:  "scope: noinline",
+			scope: NoInlineScope,
+			contains: []string{
+				"[PERIOD_DECL]", "[CAPITAL_DECL]",
+				"[PERIOD_TOP]", "[CAPITAL_TOP]",
+				"[PERIOD_ALL]", "[CAPITAL_ALL]",
+			},
+		},
 		{
 			name:  "scope: all",
 			scope: AllScope,
 			contains: []string{
 				"[PERIOD_DECL]", "[CAPITAL_DECL]",
 				"[PERIOD_TOP]", "[CAPITAL_TOP]",
 				"[PERIOD_ALL]", "[CAPITAL_ALL]",
+				"[PERIOD_INLINE]", "[CAPITAL_INLINE]",
 			},
 		},
 	}
@@ -254,13 +264,36 @@ func TestFix(t *testing.T) {
 		assertEqualContent(t, expected, string(fixed))
 	})
 
+	t.Run("scope: noinline", func(t *testing.T) {
+		expected := strings.ReplaceAll(string(content), "[PERIOD_DECL]", "[PERIOD_DECL].")
+		expected = strings.ReplaceAll(expected, "[PERIOD_TOP]", "[PERIOD_TOP].")
+		expected = strings.ReplaceAll(expected, "[PERIOD_ALL]", "[PERIOD_ALL].")
+		expected = strings.ReplaceAll(expected, "non-capital-decl", "Non-capital-decl")
+		expected = strings.ReplaceAll(expected, "non-capital-top", "Non-capital-top")
+		expected = strings.ReplaceAll(expected, "non-capital-all", "Non-capital-all")
+
+		fixed, err := Fix(testFile, file, fset, Settings{
+			Scope:   NoInlineScope,
+			Exclude: testExclude,
+			Period:  true,
+			Capital: true,
+		})
+		if err != nil {
+			t.Fatalf("Unexpected error: %v", err)
+		}
+
+		assertEqualContent(t, expected, string(fixed))
+	})
+
 	t.Run("scope: all", func(t *testing.T) {
 		expected := strings.ReplaceAll(string(content), "[PERIOD_DECL]", "[PERIOD_DECL].")
 		expected = strings.ReplaceAll(expected, "[PERIOD_TOP]", "[PERIOD_TOP].")
 		expected = strings.ReplaceAll(expected, "[PERIOD_ALL]", "[PERIOD_ALL].")
+		expected = strings.ReplaceAll(expected, "[PERIOD_INLINE]", "[PERIOD_INLINE].")
 		expected = strings.ReplaceAll(expected, "non-capital-decl", "Non-capital-decl")
 		expected = strings.ReplaceAll(expected, "non-capital-top", "Non-capital-top")
 		expected = strings.ReplaceAll(expected, "non-capital-all", "Non-capital-all")
+		expected = strings.ReplaceAll(expected, "non-capital-inline", "Non-capital-inline")
 
 		fixed, err := Fix(testFile, file, fset, Settings{
 			Scope:   AllScope,
@@ -417,16 +450,46 @@ func TestReplace(t *testing.T) {
 		assertEqualContent(t, expected, string(fixed))
 	})
 
+	t.Run("scope: noinline", func(t *testing.T) {
+		defer func() {
+			os.WriteFile(testFile, content, mode)
+		}()
+		expected := strings.ReplaceAll(string(content), "[PERIOD_DECL]", "[PERIOD_DECL].")
+		expected = strings.ReplaceAll(expected, "[PERIOD_TOP]", "[PERIOD_TOP].")
+		expected = strings.ReplaceAll(expected, "[PERIOD_ALL]", "[PERIOD_ALL].")
+		expected = strings.ReplaceAll(expected, "non-capital-decl", "Non-capital-decl")
+		expected = strings.ReplaceAll(expected, "non-capital-top", "Non-capital-top")
+		expected = strings.ReplaceAll(expected, "non-capital-all", "Non-capital-all")
+
+		err := Replace(testFile, file, fset, Settings{
+			Scope:   NoInlineScope,
+			Exclude: testExclude,
+			Period:  true,
+			Capital: true,
+		})
+		if err != nil {
+			t.Fatalf("Unexpected error: %v", err)
+		}
+		fixed, err := os.ReadFile(testFile)
+		if err != nil {
+			t.Fatalf("Failed to read fixed file %s: %v", testFile, err)
+		}
+
+		assertEqualContent(t, expected, string(fixed))
+	})
+
 	t.Run("scope: all", func(t *testing.T) {
 		defer func() {
 			os.WriteFile(testFile, content, mode)
 		}()
 		expected := strings.ReplaceAll(string(content), "[PERIOD_DECL]", "[PERIOD_DECL].")
 		expected = strings.ReplaceAll(expected, "[PERIOD_TOP]", "[PERIOD_TOP].")
 		expected = strings.ReplaceAll(expected, "[PERIOD_ALL]", "[PERIOD_ALL].")
+		expected = strings.ReplaceAll(expected, "[PERIOD_INLINE]", "[PERIOD_INLINE].")
 		expected = strings.ReplaceAll(expected, "non-capital-decl", "Non-capital-decl")
 		expected = strings.ReplaceAll(expected, "non-capital-top", "Non-capital-top")
 		expected = strings.ReplaceAll(expected, "non-capital-all", "Non-capital-all")
+		expected = strings.ReplaceAll(expected, "non-capital-inline", "Non-capital-inline")
 
 		err := Replace(testFile, file, fset, Settings{
 			Scope:   AllScope,

settings.go

@@ -24,6 +24,8 @@ const (
 	DeclScope Scope = "declarations"
 	// TopLevelScope is for all top level comments.
 	TopLevelScope Scope = "toplevel"
+	// NoInlineScope is for all except inline comments.
+	NoInlineScope Scope = "noinline"
 	// AllScope is for all comments.
 	AllScope Scope = "all"
 )

testdata/check/main.go

@@ -20,7 +20,7 @@ import (
 const (
     one = 1
 
-        two = 2
+        two = 2 // Inline comment [PERIOD_INLINE]
 
 )
 
@@ -105,7 +105,7 @@ func Sum(a, b int) int {
 	a++
 	b++
 
-	return a + b // Inline comment [PERIOD_ALL]
+	return a + b // Inline comment [PERIOD_INLINE]
 }
 
 // Declaration multiline comment
@@ -147,7 +147,7 @@ func inside() {
 	type thing struct {
 		field string
 	}
-	t := thing{} // Inline comment [PERIOD_ALL]
+	t := thing{} // Inline comment [PERIOD_INLINE]
 	println(t)
 	// @Comment without a period excluded by regexp pattern [PASS]
 }
@@ -158,7 +158,7 @@ func nonCapital() int {
 	x := 10
 
 	// non-capital-all [CAPITAL_ALL].
-	return x // non-capital-all [CAPITAL_ALL].
+	return x // non-capital-inline [CAPITAL_INLINE].
 }
 
 // ExamplePrintln is a function that you would normally see in tests.

testdata/get/main.go

@@ -8,7 +8,7 @@ import "fmt"
 const (
     one = 1
 
-        two = 2
+        two = 2 // Inline comment [TOP]
 
 )
 
@@ -45,7 +45,7 @@ type Thing struct {
 }
 
 // Example is an example function. Top level function declaration comment [DECL].
-func Example() { // top level inline comment [ALL]
+func Example() { // top level inline comment [INLINE]
 	// Regular comment [ALL]
 
 	// Declaration comment [ALL]
@@ -54,5 +54,5 @@ func Example() { // top level inline comment [ALL]
 		fmt.Println("hello, world")
 	}
 
-	prn() // Inline comment [ALL]
+	prn() // Inline comment [INLINE]
 }