eat: support QML sources via qml = qdoc

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

Author: jdkato

internal/core/format.go

@@ -77,6 +77,7 @@ var FormatByExtension = map[string][]string{
 	`\.(?:myst)$`:                            {".myst", "markup"},
 	`\.(?:qdoc)$`:                            {".qdoc", "markup"},
 	`\.(?:qmd)$`:                             {".qmd", "markup"},
+	`\.(?:qml)$`:                             {".qml", "code"},
 	`\.(?:org)$`:                             {".org", "markup"},
 	`\.(?:php)$`:                             {".php", "code"},
 	`\.(?:pl|pm|pod)$`:                       {".r", "code"},

internal/core/util_test.go

@@ -16,6 +16,7 @@ func TestFormatFromExt(t *testing.T) {
 		".Rmd":   {".md", "markup"},
 		".rmd":   {".md", "markup"},
 		".R":     {".r", "code"},
+		".qml":   {".qml", "code"},
 	}
 	m := map[string]string{}
 	for ext, format := range extToFormat {
@@ -27,6 +28,14 @@ func TestFormatFromExt(t *testing.T) {
 			t.Errorf("expected = %v, got = %v", format[1], f)
 		}
 	}
+
+	mapped := map[string]string{"cpp": "qdoc", "qml": "qdoc"}
+	for _, ext := range []string{".cpp", ".qml"} {
+		normExt, f := FormatFromExt(ext, mapped)
+		if normExt != ".qdoc" || f != "fragment" {
+			t.Errorf("expected = [.qdoc fragment], got = [%v %v]", normExt, f)
+		}
+	}
 }
 
 func TestPrepText(t *testing.T) {

internal/lint/code/lang.go

@@ -61,6 +61,8 @@ func GetLanguageFromExt(ext string) (*Language, error) {
 		return Tsx(), nil
 	case ".proto":
 		return Protobuf(), nil
+	case ".qml":
+		return QML(), nil
 	case ".yml":
 		return YAML(), nil
 	case ".css":

internal/lint/code/qml.go

@@ -0,0 +1,21 @@
+package code
+
+import (
+	"regexp"
+
+	"github.com/errata-ai/vale/v3/internal/core"
+	"github.com/smacker/go-tree-sitter/javascript"
+)
+
+// QML is parsed with the JavaScript grammar: QML's object syntax isn't valid
+// JavaScript, but comments are extras and survive error recovery, which is all
+// comment extraction needs.
+func QML() *Language {
+	return &Language{
+		Delims:  regexp.MustCompile(`//|/\*[!*]?|\*/`),
+		Prefix:  cStylePrefix,
+		Parser:  javascript.GetLanguage(),
+		Queries: []core.Scope{{Name: "", Expr: "(comment) @comment", Type: ""}},
+		Padding: cStyle,
+	}
+}

testdata/e2e/lint.yaml

@@ -377,6 +377,45 @@ cases:
       widget.cpp:8:26:T.Tok:'ZQX' in a doc comment
       widget.cpp:15:41:T.Tok:'ZQX' in a doc comment
 
+  - name: qml-fragments
+    about: doc comments in QML sources lint as QDoc through `[formats]`;
+      the QML code itself is never prose
+    files:
+      .vale.ini: |
+        StylesPath = styles
+        MinAlertLevel = suggestion
+
+        [formats]
+        qml = qdoc
+
+        [*.qml]
+        T.Tok = YES
+      styles/T/Tok.yml: |
+        extends: existence
+        message: "'%s' in a doc comment"
+        level: error
+        nonword: true
+        raw:
+          - ZQX
+      Button.qml: |
+        import QtQuick
+
+        /*!
+            \qmltype Button
+            \brief A ZQX in the brief.
+
+            \section1 A ZQX heading
+        */
+        Button {
+            // A ZQX in a line comment stays code.
+            width: ZQX
+        }
+    args: Button.qml
+    exit: 1
+    want: |
+      Button.qml:5:14:T.Tok:'ZQX' in a doc comment
+      Button.qml:7:17:T.Tok:'ZQX' in a doc comment
+
   - name: quarto
     about: "#793 -- fenced divs, attributes, and shortcodes are markup, div
       content is linted, and code cells stay skipped, options and all"