@adobe/helix-markdown-support 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.1.0](https://github.com/adobe/helix-markdown-support/compare/v3.0.0...v3.1.0) (2022-01-14)
+
+
+### Features
+
+* improve sanitize-headings to move leading images before heading ([292dc72](https://github.com/adobe/helix-markdown-support/commit/292dc72dbe43def0d97e8f1c528eeb065b3bff12)), closes [#83](https://github.com/adobe/helix-markdown-support/issues/83)
+
 # [3.0.0](https://github.com/adobe/helix-markdown-support/compare/v2.0.1...v3.0.0) (2021-12-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-markdown-support",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Helix Markdown Support",
   "type": "module",
   "scripts": {
@@ -38,17 +38,17 @@
     "unified": "10.x"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "1.3.1",
+    "@adobe/eslint-config-helix": "1.3.2",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/git": "10.0.1",
-    "c8": "7.10.0",
+    "c8": "7.11.0",
     "codecov": "3.8.3",
-    "eslint": "8.4.0",
+    "eslint": "8.6.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-import": "2.25.4",
     "husky": "7.0.4",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "12.1.2",
+    "lint-staged": "12.1.7",
     "mdast-builder": "1.1.1",
     "mocha": "9.1.3",
     "mocha-multi-reporters": "1.5.1",

package/src/mdast-fix-code-flow.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 /* eslint-disable no-param-reassign */
-import { visit } from 'unist-util-visit';
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * ensures that `code` is at a flow level. i.e. outside a paragraph
@@ -50,7 +50,7 @@ export default function fixCodeFlow(tree) {
       }
     }
     // return index;
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }

package/src/mdast-robust-tables.js

@@ -12,7 +12,7 @@
 /* eslint-disable no-param-reassign */
 import { toHast as md2hast } from 'mdast-util-to-hast';
 import { toHtml as hast2html } from 'hast-util-to-html';
-import { visit } from 'unist-util-visit';
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Converts tables to HTML
@@ -23,7 +23,7 @@ import { visit } from 'unist-util-visit';
 export default function robustTables(tree) {
   visit(tree, (node) => {
     if (node.type !== 'table') {
-      return visit.CONTINUE;
+      return CONTINUE;
     }
     let html = '<table>\n';
     (node.children /* c8 ignore next */ || []).forEach((row) => {
@@ -71,7 +71,7 @@ export default function robustTables(tree) {
     node.type = 'html';
     node.value = html;
     delete node.children;
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }

package/src/mdast-sanitize-formats.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { visit } from 'unist-util-visit';
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Sanitizes text:
@@ -43,7 +43,7 @@ export default function sanitizeFormats(tree) {
         }
       }
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }

package/src/mdast-sanitize-heading.js

@@ -13,36 +13,49 @@ import { visit } from 'unist-util-visit';
 
 /**
  * Sanitizes headings:
- * - (re)move images
+ * - (re)move images ('before', 'both', 'after')
  *
  * @param {object} tree
+ * @param {object} [opts] options
+ * @param {string} [opts.imageHandling] specifies how images are handled. defaults to 'after'.
  * @returns {object} The modified (original) tree.
  */
-export default function sanitizeHeading(tree) {
+export default function sanitizeHeading(tree, opts = {}) {
+  const { imageHandling = 'after' } = opts;
   visit(tree, (node, index, parent) => {
     const { children: siblings = [] } = parent || {};
     const { children = [] } = node;
+    let after = index + 1;
     if (node.type === 'heading') {
       for (let i = 0; i < children.length; i += 1) {
         const child = children[i];
         if (child.type === 'image') {
-          // move after heading
-          children.splice(i, 1);
-          i -= 1;
           const para = {
             type: 'paragraph',
             children: [child],
           };
-          siblings.splice(index + 1, 0, para);
+          children.splice(i, 1);
+          i -= 1;
+          if ((i < 0 && imageHandling !== 'after') || imageHandling === 'before') {
+            // move before heading
+            siblings.splice(index, 0, para);
+            // eslint-disable-next-line no-param-reassign
+            index += 1;
+            after = index + 1;
+          } else {
+            // move after heading
+            siblings.splice(after, 0, para);
+            after += 1;
+          }
         }
       }
       // remove empty headings
       if (!children.length) {
         siblings.splice(index, 1);
-        return index;
+        after -= 1;
       }
     }
-    return visit.CONTINUE;
+    return after;
   });
   return tree;
 }

package/src/mdast-sanitize-links.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { visit } from 'unist-util-visit';
+import { visit, CONTINUE } from 'unist-util-visit';
 import find from 'unist-util-find';
 
 /**
@@ -61,7 +61,7 @@ export default function sanitizeLinks(tree) {
         }
       }
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }

package/src/mdast-sanitize-text.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { visit } from 'unist-util-visit';
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Sanitizes text:
@@ -107,7 +107,7 @@ export default function sanitizeText(tree) {
         }
       }
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }

package/src/mdast-suppress-spacecode.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { visit } from 'unist-util-visit';
+import { visit, CONTINUE } from 'unist-util-visit';
 
 /**
  * Looks for text starting with 4 spaces. As this would render as code in some markdown,
@@ -27,7 +27,7 @@ export default function suppressSpaceCode(tree) {
       // eslint-disable-next-line no-param-reassign
       child.value = child.value.replace(/^\s+/, ' ');
     }
-    return visit.CONTINUE;
+    return CONTINUE;
   });
   return tree;
 }