Refactor to remove micromark helper getSiblingTokens for simpler code and better performance.

demo/markdownlint-browser.js

@@ -1473,28 +1473,6 @@ function filterByTypes(tokens, types) {
   return filterByPredicate(tokens, predicate);
 }
 
-/**
- * Gets all sibling token groups for a list of Micromark tokens.
- *
- * @param {Token[]} tokens Micromark tokens.
- * @returns {Token[][]} Sibling token groups.
- */
-function getSiblingTokens(tokens) {
-  const result = [];
-  const queue = [ tokens ];
-  // eslint-disable-next-line init-declarations
-  let current;
-  while ((current = queue.shift())) {
-    result.push(current);
-    for (const token of current) {
-      if (token.children.length > 0) {
-        queue.push(token.children);
-      }
-    }
-  }
-  return result;
-}
-
 /**
  * Gets the heading level of a Micromark heading tokan.
  *
@@ -1619,7 +1597,6 @@ module.exports = {
   getHeadingLevel,
   getHtmlTagInfo,
   getMicromarkEvents,
-  getSiblingTokens,
   getTokenParentOfType,
   getTokenTextByType,
   inHtmlFlow,
@@ -4544,18 +4521,17 @@ module.exports = {
 
 
 const { addErrorContext } = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
-const { getSiblingTokens } = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs");
+const { filterByTypes } = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs");
 
 module.exports = {
   "names": ["MD027", "no-multiple-space-blockquote"],
   "description": "Multiple spaces after blockquote symbol",
   "tags": ["blockquote", "whitespace", "indentation"],
   "function": function MD027(params, onError) {
-    for (const siblings of getSiblingTokens(params.parsers.micromark.tokens)) {
+    const { tokens } = params.parsers.micromark;
-      let previousType = null;
+    for (const token of filterByTypes(tokens, [ "linePrefix" ])) {
-      for (const token of siblings) {
+      const siblings = token.parent?.children || tokens;
-        const { type } = token;
+      if (siblings[siblings.indexOf(token) - 1]?.type === "blockQuotePrefix") {
-        if ((type === "linePrefix") && (previousType === "blockQuotePrefix")) {
         const { startColumn, startLine, text } = token;
         const { length } = text;
         const line = params.lines[startLine - 1];
@@ -4572,8 +4548,6 @@ module.exports = {
           }
         );
       }
-        previousType = type;
-      }
     }
   }
 };
@@ -4593,35 +4567,35 @@ module.exports = {
 
 
 const { addError } = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
-const { getSiblingTokens } = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs");
+const { filterByTypes } = __webpack_require__(/*! ../helpers/micromark.cjs */ "../helpers/micromark.cjs");
+
+const ignoreTypes = new Set([ "lineEnding", "listItemIndent", "linePrefix" ]);
 
 module.exports = {
   "names": [ "MD028", "no-blanks-blockquote" ],
   "description": "Blank line inside blockquote",
   "tags": [ "blockquote", "whitespace" ],
   "function": function MD028(params, onError) {
-    for (const siblings of getSiblingTokens(params.parsers.micromark.tokens)) {
+    const { tokens } = params.parsers.micromark;
-      let errorLineNumbers = null;
+    for (const token of filterByTypes(tokens, [ "blockQuote" ])) {
-      for (const sibling of siblings) {
+      const errorLineNumbers = [];
-        switch (sibling.type) {
+      const siblings = token.parent?.children || tokens;
-          case "blockQuote":
+      for (let i = siblings.indexOf(token) + 1; i < siblings.length; i++) {
-            for (const lineNumber of (errorLineNumbers || [])) {
+        const sibling = siblings[i];
+        const { startLine, type } = sibling;
+        if (type === "lineEndingBlank") {
+          // Possible blank between blockquotes
+          errorLineNumbers.push(startLine);
+        } else if (ignoreTypes.has(type)) {
+          // Ignore invisible formatting
+        } else if (type === "blockQuote") {
+          // Blockquote followed by blockquote
+          for (const lineNumber of errorLineNumbers) {
             addError(onError, lineNumber);
           }
-            errorLineNumbers = [];
           break;
-          case "lineEnding":
+        } else {
-          case "linePrefix":
+          // Blockquote not followed by blockquote
-          case "listItemIndent":
-            // Ignore
-            break;
-          case "lineEndingBlank":
-            if (errorLineNumbers) {
-              errorLineNumbers.push(sibling.startLine);
-            }
-            break;
-          default:
-            errorLineNumbers = null;
           break;
         }
       }

helpers/micromark.cjs

@@ -295,28 +295,6 @@ function filterByTypes(tokens, types) {
   return filterByPredicate(tokens, predicate);
 }
 
-/**
- * Gets all sibling token groups for a list of Micromark tokens.
- *
- * @param {Token[]} tokens Micromark tokens.
- * @returns {Token[][]} Sibling token groups.
- */
-function getSiblingTokens(tokens) {
-  const result = [];
-  const queue = [ tokens ];
-  // eslint-disable-next-line init-declarations
-  let current;
-  while ((current = queue.shift())) {
-    result.push(current);
-    for (const token of current) {
-      if (token.children.length > 0) {
-        queue.push(token.children);
-      }
-    }
-  }
-  return result;
-}
-
 /**
  * Gets the heading level of a Micromark heading tokan.
  *
@@ -441,7 +419,6 @@ module.exports = {
   getHeadingLevel,
   getHtmlTagInfo,
   getMicromarkEvents,
-  getSiblingTokens,
   getTokenParentOfType,
   getTokenTextByType,
   inHtmlFlow,

lib/md027.js

@@ -3,18 +3,17 @@
 "use strict";
 
 const { addErrorContext } = require("../helpers");
-const { getSiblingTokens } = require("../helpers/micromark.cjs");
+const { filterByTypes } = require("../helpers/micromark.cjs");
 
 module.exports = {
   "names": ["MD027", "no-multiple-space-blockquote"],
   "description": "Multiple spaces after blockquote symbol",
   "tags": ["blockquote", "whitespace", "indentation"],
   "function": function MD027(params, onError) {
-    for (const siblings of getSiblingTokens(params.parsers.micromark.tokens)) {
+    const { tokens } = params.parsers.micromark;
-      let previousType = null;
+    for (const token of filterByTypes(tokens, [ "linePrefix" ])) {
-      for (const token of siblings) {
+      const siblings = token.parent?.children || tokens;
-        const { type } = token;
+      if (siblings[siblings.indexOf(token) - 1]?.type === "blockQuotePrefix") {
-        if ((type === "linePrefix") && (previousType === "blockQuotePrefix")) {
         const { startColumn, startLine, text } = token;
         const { length } = text;
         const line = params.lines[startLine - 1];
@@ -31,8 +30,6 @@ module.exports = {
           }
         );
       }
-        previousType = type;
-      }
     }
   }
 };

lib/md028.js

@@ -3,35 +3,35 @@
 "use strict";
 
 const { addError } = require("../helpers");
-const { getSiblingTokens } = require("../helpers/micromark.cjs");
+const { filterByTypes } = require("../helpers/micromark.cjs");
+
+const ignoreTypes = new Set([ "lineEnding", "listItemIndent", "linePrefix" ]);
 
 module.exports = {
   "names": [ "MD028", "no-blanks-blockquote" ],
   "description": "Blank line inside blockquote",
   "tags": [ "blockquote", "whitespace" ],
   "function": function MD028(params, onError) {
-    for (const siblings of getSiblingTokens(params.parsers.micromark.tokens)) {
+    const { tokens } = params.parsers.micromark;
-      let errorLineNumbers = null;
+    for (const token of filterByTypes(tokens, [ "blockQuote" ])) {
-      for (const sibling of siblings) {
+      const errorLineNumbers = [];
-        switch (sibling.type) {
+      const siblings = token.parent?.children || tokens;
-          case "blockQuote":
+      for (let i = siblings.indexOf(token) + 1; i < siblings.length; i++) {
-            for (const lineNumber of (errorLineNumbers || [])) {
+        const sibling = siblings[i];
+        const { startLine, type } = sibling;
+        if (type === "lineEndingBlank") {
+          // Possible blank between blockquotes
+          errorLineNumbers.push(startLine);
+        } else if (ignoreTypes.has(type)) {
+          // Ignore invisible formatting
+        } else if (type === "blockQuote") {
+          // Blockquote followed by blockquote
+          for (const lineNumber of errorLineNumbers) {
             addError(onError, lineNumber);
           }
-            errorLineNumbers = [];
           break;
-          case "lineEnding":
+        } else {
-          case "linePrefix":
+          // Blockquote not followed by blockquote
-          case "listItemIndent":
-            // Ignore
-            break;
-          case "lineEndingBlank":
-            if (errorLineNumbers) {
-              errorLineNumbers.push(sibling.startLine);
-            }
-            break;
-          default:
-            errorLineNumbers = null;
           break;
         }
       }