feat: validate illformed YAML comments (#180)

Refs: nodejs/node#38324
patrickm68 · Apr 24, 2021 · 2a24eac · 2a24eac
1 parent ca72175
commit 2a24eac
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/remark-lint-nodejs-yaml-comments.js b/remark-lint-nodejs-yaml-comments.js
@@ -219,6 +219,11 @@ function validateMeta(node, file, meta) {
 
 function validateYAMLComments(tree, file) {
   visit(tree, "html", function visitor(node) {
+    if (node.value.startsWith("<!--YAML\n"))
+      file.message(
+        "Expected `<!-- YAML`, found `<!--YAML`. Please add a space",
+        node
+      );
     if (!node.value.startsWith("<!-- YAML\n")) return;
     try {
       const meta = yaml.load("#" + node.value.slice(0, -"-->".length));