JS: Support YAML comments.

MathiasVP · MathiasVP · commit b76c32db8fbf · 2026-06-04T16:52:28.000+01:00
diff --git a/javascript/ql/lib/semmle/javascript/YAML.qll b/javascript/ql/lib/semmle/javascript/YAML.qll
@@ -44,6 +44,12 @@ private module YamlSig implements LibYaml::InputSig {
   class ParseErrorBase extends LocatableBase, @yaml_error {
     string getMessage() { yaml_errors(this, result) }
   }
+
+  class CommentBase extends LocatableBase, @yaml_comment {
+    string getText() { yaml_comments(this, result, _) }
+
+    override string toString() { yaml_comments(this, _, result) }
+  }
 }
 
 import LibYaml::Make<YamlSig>
diff --git a/javascript/ql/lib/semmlecode.javascript.dbscheme b/javascript/ql/lib/semmlecode.javascript.dbscheme
@@ -1090,13 +1090,17 @@ yaml_scalars (unique int scalar: @yaml_scalar_node ref,
               int style: int ref,
               string value: string ref);
 
+yaml_comments (unique int id: @yaml_comment,
+               string text: string ref,
+               string tostring: string ref);
+
 yaml_errors (unique int id: @yaml_error,
              string message: string ref);
 
 yaml_locations(unique int locatable: @yaml_locatable ref,
              int location: @location_default ref);
 
-@yaml_locatable = @yaml_node | @yaml_error;
+@yaml_locatable = @yaml_node | @yaml_error | @yaml_comment;
 
 /*- XML Files -*/
 
diff --git a/javascript/ql/lib/semmlecode.javascript.dbscheme.stats b/javascript/ql/lib/semmlecode.javascript.dbscheme.stats
@@ -1406,6 +1406,10 @@
 <v>1</v>
 </e>
 <e>
+<k>@yaml_comment</k>
+<v>1000</v>
+</e>
+<e>
 <k>@jsx_element</k>
 <v>1090</v>
 </e>
@@ -24077,6 +24081,25 @@
 </dependencies>
 </relation>
 <relation>
+<name>yaml_comments</name>
+<cardinality>1000</cardinality>
+<columnsizes>
+<e>
+<k>id</k>
+<v>1000</v>
+</e>
+<e>
+<k>text</k>
+<v>1000</v>
+</e>
+<e>
+<k>tostring</k>
+<v>1000</v>
+</e>
+</columnsizes>
+<dependencies/>
+</relation>
+<relation>
 <name>xmlEncoding</name>
 <cardinality>39724</cardinality>
 <columnsizes>

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,12 @@ private module YamlSig implements LibYaml::InputSig {`
`44`	`44`	`class ParseErrorBase extends LocatableBase, @yaml_error {`
`45`	`45`	`string getMessage() { yaml_errors(this, result) }`
`46`	`46`	`}`
	`47`	`+`
	`48`	`+ class CommentBase extends LocatableBase, @yaml_comment {`
	`49`	`+ string getText() { yaml_comments(this, result, _) }`
	`50`	`+`
	`51`	`+ override string toString() { yaml_comments(this, _, result) }`
	`52`	`+ }`
`47`	`53`	`}`
`48`	`54`
`49`	`55`	`import LibYaml::Make<YamlSig>`