@adobe/helix-markdown-support 3.1.4 → 3.1.7

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [3.1.7](https://github.com/adobe/helix-markdown-support/compare/v3.1.6...v3.1.7) (2022-07-09)
+
+
+### Bug Fixes
+
+* **deps:** update dependency mdast-util-to-hast to v12.1.2 ([3df98b2](https://github.com/adobe/helix-markdown-support/commit/3df98b2f9b51e41b47998fc61bce94896def9c8c))
+
+## [3.1.6](https://github.com/adobe/helix-markdown-support/compare/v3.1.5...v3.1.6) (2022-05-30)
+
+
+### Bug Fixes
+
+* move leading and trailing breaks out of heading ([#112](https://github.com/adobe/helix-markdown-support/issues/112)) ([87775dc](https://github.com/adobe/helix-markdown-support/commit/87775dcf189f024ccf789f8c883ab90d296c8d0d))
+
+## [3.1.5](https://github.com/adobe/helix-markdown-support/compare/v3.1.4...v3.1.5) (2022-05-17)
+
+
+### Bug Fixes
+
+* (re)move breaks in links and headings ([621c85b](https://github.com/adobe/helix-markdown-support/commit/621c85b664621e56111e00e9cbb9cd7d648471d6)), closes [#106](https://github.com/adobe/helix-markdown-support/issues/106)
+
 ## [3.1.4](https://github.com/adobe/helix-markdown-support/compare/v3.1.3...v3.1.4) (2022-05-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-markdown-support",
-  "version": "3.1.4",
+  "version": "3.1.7",
   "description": "Helix Markdown Support",
   "type": "module",
   "scripts": {
@@ -24,7 +24,7 @@
   "dependencies": {
     "hast-util-to-html": "8.0.3",
     "js-yaml": "4.1.0",
-    "mdast-util-to-hast": "12.1.1",
+    "mdast-util-to-hast": "12.1.2",
     "unist-util-find": "1.0.2",
     "unist-util-visit": "4.1.0"
   },
@@ -41,21 +41,21 @@
     "@adobe/eslint-config-helix": "1.3.2",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/git": "10.0.1",
-    "c8": "7.11.2",
+    "c8": "7.11.3",
     "codecov": "3.8.3",
-    "eslint": "8.15.0",
+    "eslint": "8.19.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.26.0",
     "husky": "8.0.1",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "12.4.1",
+    "lint-staged": "13.0.3",
     "mdast-builder": "1.1.1",
     "mocha": "10.0.0",
     "mocha-multi-reporters": "1.5.1",
     "remark-gfm": "3.0.1",
     "remark-parse": "10.0.1",
     "remark-stringify": "10.0.2",
-    "semantic-release": "19.0.2",
+    "semantic-release": "19.0.3",
     "unified": "10.1.2",
     "unist-util-inspect": "7.0.0"
   },

package/src/mdast-sanitize-heading.js

@@ -14,6 +14,7 @@ import { visit } from 'unist-util-visit';
 /**
  * Sanitizes headings:
  * - (re)move images ('before', 'both', 'after')
+ * - converts BREAKs inside headings to <br>.
  *
  * @param {object} tree
  * @param {object} [opts] options
@@ -41,7 +42,7 @@ export default function sanitizeHeading(tree, opts = {}) {
             siblings.splice(index, 0, para);
             // eslint-disable-next-line no-param-reassign
             index += 1;
-            after = index + 1;
+            after += 1;
           } else {
             // move after heading
             siblings.splice(after, 0, para);
@@ -49,13 +50,41 @@ export default function sanitizeHeading(tree, opts = {}) {
           }
         }
       }
+
+      // move leading breaks before heading
+      while (children[0]?.type === 'break') {
+        const brk = children.shift();
+        siblings.splice(index, 0, brk);
+        // eslint-disable-next-line no-param-reassign
+        index += 1;
+      }
+      // move trailing breaks after heading
+      let last = children.length - 1;
+      while (children[last]?.type === 'break') {
+        const brk = children.pop();
+        siblings.splice(index + 1, 0, brk);
+        last -= 1;
+      }
+      // convert inline breaks to <br>
+      for (let i = 0; i < children.length; i += 1) {
+        if (children[i].type === 'break') {
+          children[i] = {
+            type: 'html',
+            value: '<br>',
+          };
+        }
+      }
+
       // remove empty headings
       if (!children.length) {
         siblings.splice(index, 1);
-        after -= 1;
+        // eslint-disable-next-line no-param-reassign
+        index -= 1;
       }
+      return index + 1;
     }
-    return after;
+
+    return index + 1;
   });
   return tree;
 }

package/src/mdast-sanitize-links.js

@@ -15,6 +15,8 @@ import find from 'unist-util-find';
 /**
  * Sanitizes links:
  * - unwraps formatting in links if possible. eg: [_text_](...) -> _[test](...)_
+ * - moves leading, trailing BREAKs out of link
+ * - converts BREAKs inside link to <br>.
  *
  * @param {object} tree
  * @returns {object} The modified (original) tree.
@@ -60,6 +62,31 @@ export default function sanitizeLinks(tree) {
           }
         }
       }
+    } else if (node.type === 'link' && children.length > 1) {
+      // move leading breaks outside of link
+      while (children[0]?.type === 'break') {
+        const brk = children.shift();
+        parent.children.splice(index, 0, brk);
+        // eslint-disable-next-line no-param-reassign
+        index += 1;
+      }
+      // move trailing breaks after link
+      let last = children.length - 1;
+      while (children[last]?.type === 'break') {
+        const brk = children.pop();
+        parent.children.splice(index + 1, 0, brk);
+        last -= 1;
+      }
+      // convert inline breaks to <br>
+      for (let i = 0; i < children.length; i += 1) {
+        if (children[i].type === 'break') {
+          children[i] = {
+            type: 'html',
+            value: '<br>',
+          };
+        }
+      }
+      return index + 1;
     }
     return CONTINUE;
   });