@adobe/helix-markdown-support 4.0.4 → 5.0.2

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## [5.0.2](https://github.com/adobe/helix-markdown-support/compare/v5.0.1...v5.0.2) (2022-09-07)
+
+
+### Bug Fixes
+
+* clean more breaks ([#137](https://github.com/adobe/helix-markdown-support/issues/137)) ([a6f9d37](https://github.com/adobe/helix-markdown-support/commit/a6f9d372eb040ad0980e681f7deb5dbe694ee7f4))
+
+## [5.0.1](https://github.com/adobe/helix-markdown-support/compare/v5.0.0...v5.0.1) (2022-09-06)
+
+
+### Bug Fixes
+
+* remove trailing breaks ([d08b6fc](https://github.com/adobe/helix-markdown-support/commit/d08b6fcded991f054b30da04298a489091d38cf7))
+
+# [5.0.0](https://github.com/adobe/helix-markdown-support/compare/v4.0.4...v5.0.0) (2022-09-06)
+
+
+### Bug Fixes
+
+* remove breaksAsSpaces ([e6bb665](https://github.com/adobe/helix-markdown-support/commit/e6bb665930ce39876228aff9cd9bec842ed5030b))
+
+
+### BREAKING CHANGES
+
+* breaksAsSpaces removed. no longer needed.
+
 ## [4.0.4](https://github.com/adobe/helix-markdown-support/compare/v4.0.3...v4.0.4) (2022-09-06)
 
 

package/package.json

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

package/src/index.js

@@ -11,7 +11,6 @@
  */
 
 export { default as robustTables } from './mdast-robust-tables.js';
-export { default as breaksAsSpaces } from './remark-breaks-as-spaces.js';
 export { default as sanitizeHeading } from './mdast-sanitize-heading.js';
 export { default as suppressSpaceCode } from './mdast-suppress-spacecode.js';
 export { default as sanitizeFormats } from './mdast-sanitize-formats.js';

package/src/mdast-sanitize-heading.js

@@ -51,18 +51,14 @@ export default function sanitizeHeading(tree, opts = {}) {
         }
       }
 
-      // move leading breaks before heading
+      // remove leading breaks
       while (children[0]?.type === 'break') {
-        const brk = children.shift();
-        siblings.splice(index, 0, brk);
-        // eslint-disable-next-line no-param-reassign
-        index += 1;
+        children.shift();
       }
-      // move trailing breaks after heading
+      // remove trailing breaks
       let last = children.length - 1;
       while (children[last]?.type === 'break') {
-        const brk = children.pop();
-        siblings.splice(index + 1, 0, brk);
+        children.pop();
         last -= 1;
       }
       // convert inline breaks to <br>

package/src/mdast-sanitize-text.js

@@ -18,6 +18,9 @@ import { visit, CONTINUE } from 'unist-util-visit';
  * - trims ends of texts at the end
  * - moves leading and trailing whitespaces out of formats
  * - removes leading whitespaces before images
+ * - removes trailing breaks in containers
+ *   see https://github.com/micromark/micromark/issues/118#issuecomment-1238225086
+ * - removes empty paragraphs
  *
  * @param {object} tree
  * @returns {object} The modified (original) tree.
@@ -92,8 +95,13 @@ export default function sanitizeText(tree) {
         return index - 1;
       }
     }
-    // remove trailing whitespace before break blocks
+    // remove trailing whitespace before break blocks and trailing breaks altogether
     if (node.type === 'break') {
+      if (index === siblings.length - 1) {
+        siblings.splice(index, 1);
+        return index - 1;
+      }
+
       // eslint-disable-next-line no-param-reassign
       delete node.value;
       if (index > 0) {
@@ -109,5 +117,15 @@ export default function sanitizeText(tree) {
     }
     return CONTINUE;
   });
+
+  // remove empty paragraphs
+  visit(tree, (node, index, parent) => {
+    if (node.type === 'paragraph' && node.children.length === 0) {
+      parent.children.splice(index, 1);
+      return index - 1;
+    }
+    return CONTINUE;
+  });
+
   return tree;
 }

package/src/remark-breaks-as-spaces.js

@@ -1,33 +0,0 @@
-/*
- * Copyright 2020 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.
- */
-
-/**
- * Remark extension that handles soft-breaks correctly.
- */
-export default function softBreak() {
-  function handleBreak(node, _, context) {
-    if (context.stack.indexOf('tableCell') !== -1) {
-      return '   ';
-    } else {
-      return '  \n';
-    }
-  }
-
-  if (!this.data('toMarkdownExtensions')) {
-    this.data('toMarkdownExtensions', []);
-  }
-  this.data('toMarkdownExtensions').push({
-    handlers: {
-      break: handleBreak,
-    },
-  });
-}