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: #38384 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Sep 4, 2021 · dfdf6c7 · dfdf6c7
1 parent 95b9cc7
commit dfdf6c7
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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));