@adobe/helix-markdown-support 6.3.0 → 7.0.0

package/.circleci/config.yml

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

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [7.0.0](https://github.com/adobe/helix-markdown-support/compare/v6.3.1...v7.0.0) (2023-09-26)
+
+
+### Bug Fixes
+
+* **deps:** update micromark to 4.x ([f651a31](https://github.com/adobe/helix-markdown-support/commit/f651a3176c0458af230f8145cc3caa21a5e282f7))
+
+
+### BREAKING CHANGES
+
+* **deps:** micromark 4.x required
+
+## [6.3.1](https://github.com/adobe/helix-markdown-support/compare/v6.3.0...v6.3.1) (2023-08-24)
+
+
+### Bug Fixes
+
+* properly handle whitespace after sort ([#211](https://github.com/adobe/helix-markdown-support/issues/211)) ([03bf02a](https://github.com/adobe/helix-markdown-support/commit/03bf02a249f594e03c5d523d876e0b6522ad6ed5))
+
 # [6.3.0](https://github.com/adobe/helix-markdown-support/compare/v6.2.1...v6.3.0) (2023-07-27)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-markdown-support",
-  "version": "6.3.0",
+  "version": "7.0.0",
   "description": "Helix Markdown Support",
   "type": "module",
   "scripts": {
@@ -25,24 +25,24 @@
     "./matter": "./src/matter/index.js"
   },
   "dependencies": {
-    "hast-util-to-html": "8.0.4",
+    "hast-util-to-html": "9.0.0",
     "js-yaml": "4.1.0",
-    "mdast-util-gfm-footnote": "1.0.2",
-    "mdast-util-gfm-strikethrough": "1.0.3",
-    "mdast-util-gfm-table": "1.0.7",
-    "mdast-util-gfm-task-list-item": "1.0.2",
-    "mdast-util-phrasing": "3.0.1",
-    "mdast-util-to-hast": "12.3.0",
-    "micromark-extension-gfm-footnote": "1.1.2",
-    "micromark-extension-gfm-strikethrough": "1.0.7",
-    "micromark-extension-gfm-table": "1.0.7",
-    "micromark-extension-gfm-tagfilter": "1.0.2",
-    "micromark-extension-gfm-task-list-item": "1.0.5",
-    "micromark-util-character": "1.2.0",
-    "micromark-util-combine-extensions": "1.1.0",
-    "micromark-util-symbol": "1.1.0",
-    "unist-util-find": "1.0.4",
-    "unist-util-visit": "4.1.2"
+    "mdast-util-gfm-footnote": "2.0.0",
+    "mdast-util-gfm-strikethrough": "2.0.0",
+    "mdast-util-gfm-table": "2.0.0",
+    "mdast-util-gfm-task-list-item": "2.0.0",
+    "mdast-util-phrasing": "4.0.0",
+    "mdast-util-to-hast": "13.0.2",
+    "micromark-extension-gfm-footnote": "2.0.0",
+    "micromark-extension-gfm-strikethrough": "2.0.0",
+    "micromark-extension-gfm-table": "2.0.0",
+    "micromark-extension-gfm-tagfilter": "2.0.0",
+    "micromark-extension-gfm-task-list-item": "2.0.1",
+    "micromark-util-character": "2.0.1",
+    "micromark-util-combine-extensions": "2.0.0",
+    "micromark-util-symbol": "2.0.0",
+    "unist-util-find": "2.0.0",
+    "unist-util-visit": "5.0.0"
   },
   "mocha": {
     "spec": "test/**/*.test.js",
@@ -52,33 +52,33 @@
     "node-option": "conditions=development"
   },
   "peerDependencies": {
-    "unified": "10.x"
+    "unified": "11.x"
   },
   "engines": {
     "node": ">=14"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.2",
-    "@adobe/remark-gridtables": "1.0.4",
+    "@adobe/eslint-config-helix": "2.0.3",
+    "@adobe/remark-gridtables": "2.0.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "c8": "8.0.0",
-    "eslint": "8.45.0",
+    "c8": "8.0.1",
+    "eslint": "8.50.0",
     "husky": "8.0.3",
     "junit-report-builder": "3.0.1",
-    "lint-staged": "13.2.3",
+    "lint-staged": "13.3.0",
     "mdast-builder": "1.1.1",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
-    "rehype-format": "4.0.1",
-    "rehype-stringify": "9.0.3",
+    "rehype-format": "5.0.0",
+    "rehype-stringify": "10.0.0",
     "remark-gfm": "3.0.1",
-    "remark-parse": "10.0.2",
-    "remark-rehype": "10.1.0",
-    "remark-stringify": "10.0.3",
-    "semantic-release": "21.0.7",
-    "unified": "10.1.2",
-    "unist-util-inspect": "7.0.2"
+    "remark-parse": "11.0.0",
+    "remark-rehype": "11.0.0",
+    "remark-stringify": "11.0.0",
+    "semantic-release": "22.0.5",
+    "unified": "11.0.3",
+    "unist-util-inspect": "8.0.0"
   },
   "lint-staged": {
     "*.js": "eslint"

package/src/matter/from-markdown.js

@@ -20,7 +20,7 @@ function open(token) {
 function createClose(options) {
   function close(token) {
     const data = this.resume();
-    const node = this.exit(token);
+    const node = this.stack[this.stack.length - 1];
     // todo: avoid double parsing
     node.payload = jsYaml.load(data);
     if (options.yamlDump) {
@@ -28,6 +28,7 @@ function createClose(options) {
     } else {
       delete node.value;
     }
+    this.exit(token);
   }
 
   return close;

package/src/matter/syntax.js

@@ -11,8 +11,7 @@
  */
 /* eslint-disable no-use-before-define */
 import jsYaml from 'js-yaml';
-import { codes } from 'micromark-util-symbol/codes.js';
-import { types } from 'micromark-util-symbol/types.js';
+import { codes, types } from 'micromark-util-symbol';
 import { markdownLineEnding, markdownSpace } from 'micromark-util-character';
 import { TYPE_YAML } from './types.js';
 

package/src/mdast-sanitize-links.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { visit, CONTINUE } from 'unist-util-visit';
-import find from 'unist-util-find';
+import { find } from 'unist-util-find';
 
 /**
  * Sanitizes links:

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

@@ -74,22 +74,7 @@ export function sort(tree) {
   }
 }
 
-/**
- * Sanitizes text:
- * - collapses consecutive formats
- * - collapses consecutive text blocks
- * - trims ends of texts before break
- * - trims ends of texts at the end
- * - moves leading and trailing whitespaces out of formats
- * - ensures spaces after formats
- * - removes trailing breaks in containers
- *   see https://github.com/micromark/micromark/issues/118#issuecomment-1238225086
- * - removes empty text blocks, formats, paragraphs
- *
- * @param {object} tree
- * @returns {object} The modified (original) tree.
- */
-export default function sanitizeTextAndFormats(tree) {
+function collapse(tree) {
   visit(tree, (node, index, parent) => {
     const { children: siblings = [] } = parent || {};
     const { children = [] } = node;
@@ -105,7 +90,17 @@ export default function sanitizeTextAndFormats(tree) {
         siblings.splice(index, 1);
         return index - 1;
       }
+    }
+    return CONTINUE;
+  });
+}
+
+function whitespace(tree) {
+  visit(tree, (node, index, parent) => {
+    const { children: siblings = [] } = parent || {};
+    const { children = [] } = node;
 
+    if (isFormat(node.type)) {
       // check if last text block has trailing whitespace
       const last = children[children.length - 1];
       if (last?.type === 'text') {
@@ -176,7 +171,9 @@ export default function sanitizeTextAndFormats(tree) {
     }
     return CONTINUE;
   });
+}
 
+function cleanup(tree) {
   visit(tree, (node, index, parent) => {
     const { children: siblings = [] } = parent || {};
 
@@ -226,28 +223,56 @@ export default function sanitizeTextAndFormats(tree) {
 
     return CONTINUE;
   });
+}
 
-  // remove text, formats and paragraphs
-  function prune(node) {
-    const { children, type } = node;
-    if (type === 'text') {
-      return !node.value;
-    }
-    if (!children) {
-      return false;
-    }
-    for (let i = 0; i < children.length; i += 1) {
-      if (prune(children[i])) {
-        children.splice(i, 1);
-        i -= 1;
-      }
-    }
-    if (type === 'paragraph' || isFormat(type)) {
-      return children.length === 0;
-    }
+/**
+ * remove empty text, formats, paragraphs
+ * @param node
+ * @return {boolean}
+ */
+function prune(node) {
+  const { children, type } = node;
+  if (type === 'text') {
+    return !node.value;
+  }
+  if (!children) {
     return false;
   }
+  for (let i = 0; i < children.length; i += 1) {
+    if (prune(children[i])) {
+      children.splice(i, 1);
+      i -= 1;
+    }
+  }
+  if (type === 'paragraph' || isFormat(type)) {
+    return children.length === 0;
+  }
+  return false;
+}
+
+/**
+ * Sanitizes text:
+ * - collapses consecutive formats
+ * - collapses consecutive text blocks
+ * - trims ends of texts before break
+ * - trims ends of texts at the end
+ * - moves leading and trailing whitespaces out of formats
+ * - ensures spaces after formats
+ * - removes trailing breaks in containers
+ *   see https://github.com/micromark/micromark/issues/118#issuecomment-1238225086
+ * - removes empty text blocks, formats, paragraphs
+ *
+ * @param {object} tree
+ * @returns {object} The modified (original) tree.
+ */
+export default function sanitizeTextAndFormats(tree) {
+  collapse(tree);
   prune(tree);
   sort(tree);
+  // collapse again, because sorting the nodes might have produce new collapsable siblings
+  collapse(tree);
+  whitespace(tree);
+  cleanup(tree);
+  prune(tree);
   return tree;
 }

package/src/mdast-util-gfm-nolink.js

@@ -12,37 +12,17 @@
 
 /*
 copied from
-https://github.com/micromark/micromark-extension-gfm/blob/7bc6b6f3baf941f877d7b2111e9257b21b13b37e/index.js
-
-(The MIT License)
-
-Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
+https://github.com/syntax-tree/mdast-util-gfm/blob/main/lib/index.js
+*/
 
 /**
  * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
- *
+ */
+
+/**
  * @typedef {import('mdast-util-gfm-table').Options} Options
+ *   Configuration.
  */
 
 // import {
@@ -64,30 +44,41 @@ import {
 } from 'mdast-util-gfm-task-list-item';
 
 /**
- * @returns {Array.<FromMarkdownExtension>}
+ * Create an extension for `mdast-util-from-markdown` to enable GFM (autolink
+ * literals, footnotes, strikethrough, tables, tasklists).
+ *
+ * @returns {Array<FromMarkdownExtension>}
+ *   Extension for `mdast-util-from-markdown` to enable GFM (autolink literals,
+ *   footnotes, strikethrough, tables, tasklists).
  */
 export function gfmFromMarkdown() {
   return [
+    // gfmAutolinkLiteralFromMarkdown(),
     gfmFootnoteFromMarkdown(),
-    gfmStrikethroughFromMarkdown,
-    gfmTableFromMarkdown,
-    // gfmAutolinkLiteralFromMarkdown,
-    gfmTaskListItemFromMarkdown,
+    gfmStrikethroughFromMarkdown(),
+    gfmTableFromMarkdown(),
+    gfmTaskListItemFromMarkdown(),
   ];
 }
 
 /**
- * @param {Options} [options]
+ * Create an extension for `mdast-util-to-markdown` to enable GFM (autolink
+ * literals, footnotes, strikethrough, tables, tasklists).
+ *
+ * @param {Options | null | undefined} [options]
+ *   Configuration.
  * @returns {ToMarkdownExtension}
+ *   Extension for `mdast-util-to-markdown` to enable GFM (autolink literals,
+ *   footnotes, strikethrough, tables, tasklists).
  */
 export function gfmToMarkdown(options) {
   return {
     extensions: [
-      // gfmAutolinkLiteralToMarkdown,
+      // gfmAutolinkLiteralToMarkdown(),
       gfmFootnoteToMarkdown(),
-      gfmStrikethroughToMarkdown,
+      gfmStrikethroughToMarkdown(),
       gfmTableToMarkdown(options),
-      gfmTaskListItemToMarkdown,
+      gfmTaskListItemToMarkdown(),
     ],
   };
 }

package/src/micromark-extension-gfm-nolink.js

@@ -12,37 +12,14 @@
 
 /*
 copied from
-https://github.com/micromark/micromark-extension-gfm/blob/942585eba9ec22fd9818638d42a7c8e62a7208b0/index.js
-
-(The MIT License)
-
-Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
+https://github.com/micromark/micromark-extension-gfm/blob/main/index.js
+*/
 
 /**
+ * @typedef {import('micromark-extension-gfm-footnote').HtmlOptions} HtmlOptions
+ * @typedef {import('micromark-extension-gfm-strikethrough').Options} Options
  * @typedef {import('micromark-util-types').Extension} Extension
  * @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
- * @typedef {import('micromark-extension-gfm-strikethrough').Options} Options
- * @typedef {import('micromark-extension-gfm-footnote').HtmlOptions} HtmlOptions
  */
 
 import {
@@ -51,8 +28,8 @@ import {
 } from 'micromark-util-combine-extensions';
 // import {
 //   gfmAutolinkLiteral,
-//   gfmAutolinkLiteralHtml,
-// } from 'micromark-extension-gfm-autolink-literal';
+//   gfmAutolinkLiteralHtml
+// } from 'micromark-extension-gfm-autolink-literal'
 import { gfmFootnote, gfmFootnoteHtml } from 'micromark-extension-gfm-footnote';
 import {
   gfmStrikethrough,
@@ -66,47 +43,45 @@ import {
 } from 'micromark-extension-gfm-task-list-item';
 
 /**
- * Add support for parsing GFM in markdown.
- *
- * Function that can be called to get a syntax extension for micromark (passed
- * in `extensions`).
+ * Create an extension for `micromark` to enable GFM syntax.
  *
- * @param {Options} [options]
+ * @param {Options | null | undefined} [options]
  *   Configuration (optional).
+ *
  *   Passed to `micromark-extens-gfm-strikethrough`.
  * @returns {Extension}
- *   Syntax extension for micromark (passed in `extensions`).
+ *   Extension for `micromark` that can be passed in `extensions` to enable GFM
+ *   syntax.
  */
 export function gfm(options) {
   return combineExtensions([
-    // gfmAutolinkLiteral,
+    // gfmAutolinkLiteral(),
     gfmFootnote(),
     gfmStrikethrough(options),
-    gfmTable,
-    gfmTaskListItem,
+    gfmTable(),
+    gfmTaskListItem(),
   ]);
 }
 
 /**
- * Add support for turning GFM in markdown to HTML.
- *
- * Function that can be called to get an HTML extension for micromark (passed
- * in `htmlExtensions`).
+ * Create an extension for `micromark` to support GFM when serializing to HTML.
  *
- * @param {HtmlOptions} [options]
+ * @param {HtmlOptions | null | undefined} [options]
  *   Configuration (optional).
+ *
  *   Passed to `micromark-extens-gfm-footnote`.
  * @returns {HtmlExtension}
- *   HTML extension for micromark (passed in `htmlExtensions`).
+ *   Extension for `micromark` that can be passed in `htmlExtensions` to
+ *   support GFM when serializing to HTML.
  */
 /* c8 ignore next 10 */
 export function gfmHtml(options) {
   return combineHtmlExtensions([
-    // gfmAutolinkLiteralHtml,
+    // gfmAutolinkLiteralHtml(),
     gfmFootnoteHtml(options),
-    gfmStrikethroughHtml,
-    gfmTableHtml,
-    gfmTagfilterHtml,
-    gfmTaskListItemHtml,
+    gfmStrikethroughHtml(),
+    gfmTableHtml(),
+    gfmTagfilterHtml(),
+    gfmTaskListItemHtml(),
   ]);
 }