From dfdf6c731717a71bc8372f3cb912be48df556b8b Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Sat, 24 Apr 2021 08:47:29 -0700
Subject: [PATCH] tools: update markdown linter rules

Update remark-preset-lint-node to 2.2.0 which includes improved YAML
comment linting for our markdown files.

PR-URL: https://github.com/nodejs/node/pull/38384
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
---
 tools/lint-md.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/tools/lint-md.js b/tools/lint-md.js
index 3089d1deb9d7bf..23a3e76a86f86e 100755
--- a/tools/lint-md.js
+++ b/tools/lint-md.js
@@ -49714,6 +49714,11 @@ function validateMeta(node, file, meta) {
 
 function validateYAMLComments(tree, file) {
   unistUtilVisit(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 = jsYaml$2.load("#" + node.value.slice(0, -"-->".length));