From 2a24eacae84d298e91763d43cc5a3f8edaf46efd Mon Sep 17 00:00:00 2001
From: patrickm68 <patrick.mcenaney68@gmail.com>
Date: Sat, 24 Apr 2021 17:42:59 +0200
Subject: [PATCH] feat: validate illformed YAML comments (#180)

Refs: https://github.com/nodejs/node/pull/38324
---
 remark-lint-nodejs-yaml-comments.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/remark-lint-nodejs-yaml-comments.js b/remark-lint-nodejs-yaml-comments.js
index b9f5bde..5a7a5fd 100644
--- 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));