@adobe/helix-markdown-support 6.2.1 → 6.3.0

package/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2.1
 executors:
   node18:
     docker:
-      - image: cimg/node:18.16
+      - image: cimg/node:18.17
 
 orbs:
   codecov: codecov/codecov@3.2.5

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [6.3.0](https://github.com/adobe/helix-markdown-support/compare/v6.2.1...v6.3.0) (2023-07-27)
+
+
+### Features
+
+* sort formats ([#206](https://github.com/adobe/helix-markdown-support/issues/206)) ([b734a35](https://github.com/adobe/helix-markdown-support/commit/b734a359e764ac4630b7b2418c0e71e342ad52b6))
+
 ## [6.2.1](https://github.com/adobe/helix-markdown-support/compare/v6.2.0...v6.2.1) (2023-07-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-markdown-support",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "description": "Helix Markdown Support",
   "type": "module",
   "scripts": {

package/src/mdast-sanitize-text-and-formats.js

@@ -25,6 +25,55 @@ function isSnug(type) {
   return type === 'superscript' || type === 'subscript';
 }
 
+const FLOW_SORT_ORDER = [
+  'delete',
+  'strong',
+  'emphasis',
+  'link',
+  'underline',
+  'subscript',
+  'superscript',
+];
+
+export function sort(tree) {
+  if (!tree.children) {
+    return;
+  }
+  for (let i = 0; i < tree.children.length; i += 1) {
+    let node = tree.children[i];
+    let key = FLOW_SORT_ORDER.indexOf(node.type);
+    if (key >= 0) {
+      // find the longest chain of formats
+      const chain = [];
+      while (key >= 0) {
+        chain.push({ node, key });
+        node = node.children?.length === 1 ? node.children[0] : null;
+        key = node ? FLOW_SORT_ORDER.indexOf(node?.type) : -1;
+      }
+      if (chain.length > 1) {
+        // remember children of last node in chain
+        const lastChildren = chain[chain.length - 1].node.children;
+
+        // sort chain
+        chain.sort((n0, n1) => (n0.key - n1.key));
+
+        // relink chain
+        for (let j = 0; j < chain.length - 1; j += 1) {
+          chain[j].node.children = [chain[j + 1].node];
+        }
+        chain[chain.length - 1].node.children = lastChildren;
+
+        // eslint-disable-next-line no-param-reassign
+        tree.children[i] = chain[0].node;
+      }
+      // continue on last node
+      sort(chain[chain.length - 1].node);
+    } else {
+      sort(node);
+    }
+  }
+}
+
 /**
  * Sanitizes text:
  * - collapses consecutive formats
@@ -199,6 +248,6 @@ export default function sanitizeTextAndFormats(tree) {
     return false;
   }
   prune(tree);
-
+  sort(tree);
   return tree;
 }