fix: honor IgnoredScopes when a markup format is mapped onto source

Signed-off-by: Joseph Kato <joseph@jdkato.io>

Author: jdkato

internal/lint/code.go

@@ -28,13 +28,24 @@ func updateQueries(f *core.File, views map[string]*core.View) ([]core.Scope, err
 	return found, nil
 }
 
+// skipsComment reports whether `IgnoredScopes` excludes a comment of this
+// scope -- `text.comment.block` for a Python docstring, say.
+//
+// Both paths that read comments consult this. Which one runs depends on
+// whether a markup format is mapped onto the file, and asking for Markdown in
+// your comments must not also cost you the ability to exclude one. See #858.
+func (l *Linter) skipsComment(scope string) bool {
+	ignored := l.Manager.Config.IgnoredScopes
+	return core.StringInSlice("comment", ignored) ||
+		core.StringInSlice(scope, ignored)
+}
+
 func (l *Linter) lintCode(f *core.File) error {
 	lang, err := code.GetLanguageFromExt(f.RealExt)
 	if err != nil {
 		// No tree-sitter grammar available for this file type.
 		return l.lintCodeOld(f)
 	}
-	ignored := l.Manager.Config.IgnoredScopes
 
 	found, err := updateQueries(f, l.Manager.Config.Views)
 	if err != nil {
@@ -52,9 +63,7 @@ func (l *Linter) lintCode(f *core.File) error {
 	last := 0
 	for _, comment := range comments {
 		f.SetMetaScope(comment.Scope)
-		if core.StringInSlice("comment", ignored) {
-			continue
-		} else if core.StringInSlice(comment.Scope, ignored) {
+		if l.skipsComment(comment.Scope) {
 			continue
 		}
 		f.SetText(comment.Text)

internal/lint/code_test.go

@@ -0,0 +1,45 @@
+package lint
+
+import (
+	"testing"
+
+	"github.com/errata-ai/vale/v3/internal/core"
+)
+
+// Both readers of a source file consult skipsComment, so a scope excluded from
+// one is excluded from the other. Mapping a markup format onto a file switches
+// which reader runs, and used to switch this off with it. See #858.
+func TestSkipsComment(t *testing.T) {
+	tests := []struct {
+		name    string
+		ignored []string
+		scope   string
+		want    bool
+	}{
+		{"nothing ignored", nil, "text.comment.block", false},
+		{"the scope itself", []string{"text.comment.block"}, "text.comment.block", true},
+		{"every comment", []string{"comment"}, "text.comment.block", true},
+		{"a different scope", []string{"text.comment.line"}, "text.comment.block", false},
+		{"alongside the defaults", []string{"code", "tt", "text.comment.block"},
+			"text.comment.block", true},
+	}
+
+	cfg, err := core.NewConfig(&core.CLIFlags{})
+	if err != nil {
+		t.Fatal(err)
+	}
+	linter, err := NewLinter(cfg)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			linter.Manager.Config.IgnoredScopes = tt.ignored
+			if got := linter.skipsComment(tt.scope); got != tt.want {
+				t.Errorf("skipsComment(%q) = %v with %v, want %v",
+					tt.scope, got, tt.ignored, tt.want)
+			}
+		})
+	}
+}

internal/lint/fragment.go

@@ -108,6 +108,9 @@ func (l *Linter) lintFragments(f *core.File) error {
 		}
 
 		f.SetMetaScope(comment.Scope)
+		if l.skipsComment(comment.Scope) {
+			continue
+		}
 		f.SetText(comment.Text)
 
 		switch f.NormedExt {

testdata/e2e/scopes.yaml

@@ -265,3 +265,62 @@ cases:
       test.rst:9:3:rules.List:'TODO' left in text
       test.rst:10:3:rules.List:'TODO' left in text
       test.rst:14:4:rules.List:'XXX' left in text
+
+  - name: ignored-comment-scope
+    about: "#858 -- `IgnoredScopes` excludes a comment scope when the file is
+      read as source."
+    files:
+      .vale.ini: |
+        MinAlertLevel = suggestion
+        IgnoredScopes = text.comment.block
+
+        [*.py]
+        BasedOnStyles = Vale
+        Vale.Terms = NO
+      example.py: |
+        # The folowing function computes an area.
+
+        def area(radius: float) -> float:
+            """Compute the area of a circle.
+
+            Takes the raduis and returns the area.
+            """
+            return 3.14 * radius ** 2
+    args: example.py
+    exit: 1
+    want: |
+      example.py:1:7:Vale.Spelling:Did you really mean 'folowing'?
+    absent:
+      - raduis
+
+  - name: ignored-comment-scope-mapped
+    about: "#858 -- and when a markup format is mapped onto it. Mapping one
+      switches which reader runs; it must not cost the ability to leave a
+      docstring alone, which `BlockIgnores` cannot do in its place -- by the
+      time those patterns run, the delimiters they match are gone."
+    files:
+      .vale.ini: |
+        MinAlertLevel = suggestion
+        IgnoredScopes = text.comment.block
+
+        [formats]
+        py = md
+
+        [*.py]
+        BasedOnStyles = Vale
+        Vale.Terms = NO
+      example.py: |
+        # The folowing function computes an area.
+
+        def area(radius: float) -> float:
+            """Compute the area of a circle.
+
+            Takes the raduis and returns the area.
+            """
+            return 3.14 * radius ** 2
+    args: example.py
+    exit: 1
+    want: |
+      example.py:1:7:Vale.Spelling:Did you really mean 'folowing'?
+    absent:
+      - raduis