@adobe/helix-markdown-support 6.2.0 → 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,17 @@
+# [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)
+
+
+### Bug Fixes
+
+* no whitespace around sub/sup ([1754c65](https://github.com/adobe/helix-markdown-support/commit/1754c65ef5990c5fc76ae4fe4c6308d9ed58f930))
+
 # [6.2.0](https://github.com/adobe/helix-markdown-support/compare/v6.1.3...v6.2.0) (2023-07-18)
 
 

package/package.json

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

package/src/index.js

@@ -23,3 +23,4 @@ export { default as sanitizeTextAndFormats } from './mdast-sanitize-text-and-for
 export { default as imageReferences } from './mdast-image-references.js';
 export { default as dereference } from './mdast-dereference.js';
 export { default as remarkGfmNoLink } from './remark-gfm-nolink.js';
+export { default as renderHtmlFormats } from './mdast-render-html-formats.js';

package/src/mdast-render-html-formats.js

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import { visit, CONTINUE } from 'unist-util-visit';
+
+const FORMATS = {
+  subscript: {
+    open: '<sub>',
+    close: '</sub>',
+  },
+  superscript: {
+    open: '<sup>',
+    close: '</sup>',
+  },
+  underline: {
+    open: '<u>',
+    close: '</u>',
+  },
+};
+
+/**
+ * Renders the special html formats
+ *
+ * @param {object} tree
+ * @returns {object} The modified (original) tree.
+ */
+export default function renderHtmlFormats(tree) {
+  visit(tree, (node, index, parent) => {
+    const { children: siblings = [] } = parent || {};
+    const fmt = FORMATS[node.type];
+    if (fmt) {
+      siblings.splice(
+        index,
+        1,
+        {
+          type: 'html',
+          value: fmt.open,
+        },
+        ...node.children,
+        {
+          type: 'html',
+          value: fmt.close,
+        },
+      );
+      return index + node.children.length;
+    }
+    return CONTINUE;
+  });
+  return tree;
+}

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

@@ -21,6 +21,59 @@ export function isFormat(type) {
     || type === 'underline';
 }
 
+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
@@ -105,7 +158,7 @@ export default function sanitizeTextAndFormats(tree) {
 
       // ensure that text before format has trailing whitespace
       const prev = siblings[index - 1];
-      if (prev?.type === 'text') {
+      if (prev?.type === 'text' && !isSnug(node.type)) {
         const code = prev.value.charCodeAt(prev.value.length - 1);
         if (!asciiPunctuation(code) && !markdownSpace(code) && !unicodePunctuation(code)) {
           prev.value += ' ';
@@ -114,7 +167,7 @@ export default function sanitizeTextAndFormats(tree) {
 
       // ensure that text after format has leading whitespace
       const next = siblings[index + 1];
-      if (children.length && next?.type === 'text') {
+      if (children.length && next?.type === 'text' && !isSnug(node.type)) {
         const code = next.value.charCodeAt(0);
         if (!asciiPunctuation(code) && !markdownSpace(code) && !unicodePunctuation(code)) {
           next.value = ` ${next.value}`;
@@ -195,6 +248,6 @@ export default function sanitizeTextAndFormats(tree) {
     return false;
   }
   prune(tree);
-
+  sort(tree);
   return tree;
 }