@adobe/helix-markdown-support 6.1.3 → 6.2.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [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)
+
+
+### Features
+
+* support extended formats ([b1561dd](https://github.com/adobe/helix-markdown-support/commit/b1561ddfc13ddd8aae22a6f396d2d956afcd0a09))
+
 ## [6.1.3](https://github.com/adobe/helix-markdown-support/compare/v6.1.2...v6.1.3) (2023-06-27)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-markdown-support",
-  "version": "6.1.3",
+  "version": "6.2.1",
   "description": "Helix Markdown Support",
   "type": "module",
   "scripts": {
@@ -41,7 +41,7 @@
     "micromark-util-character": "1.2.0",
     "micromark-util-combine-extensions": "1.1.0",
     "micromark-util-symbol": "1.1.0",
-    "unist-util-find": "1.0.3",
+    "unist-util-find": "1.0.4",
     "unist-util-visit": "4.1.2"
   },
   "mocha": {
@@ -59,14 +59,14 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.2",
-    "@adobe/remark-gridtables": "1.0.3",
+    "@adobe/remark-gridtables": "1.0.4",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "c8": "8.0.0",
-    "eslint": "8.43.0",
+    "eslint": "8.45.0",
     "husky": "8.0.3",
     "junit-report-builder": "3.0.1",
-    "lint-staged": "13.2.2",
+    "lint-staged": "13.2.3",
     "mdast-builder": "1.1.1",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
@@ -76,7 +76,7 @@
     "remark-parse": "10.0.2",
     "remark-rehype": "10.1.0",
     "remark-stringify": "10.0.3",
-    "semantic-release": "21.0.5",
+    "semantic-release": "21.0.7",
     "unified": "10.1.2",
     "unist-util-inspect": "7.0.2"
   },

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-formats.js

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { visit, CONTINUE } from 'unist-util-visit';
+import { isFormat } from './mdast-sanitize-text-and-formats.js';
 
 /**
  * Sanitizes text:
@@ -23,7 +24,7 @@ export default function sanitizeFormats(tree) {
   visit(tree, (node, index, parent) => {
     const { children: siblings = [] } = parent || {};
     const { children } = node;
-    if (node.type === 'strong' || node.type === 'emphasis' || node.type === 'delete') {
+    if (isFormat(node.type)) {
       // remove empty nodes
       if (!children || !children.length) {
         siblings.splice(index, 1);

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

@@ -12,8 +12,17 @@
 import { visit, CONTINUE } from 'unist-util-visit';
 import { asciiPunctuation, markdownSpace, unicodePunctuation } from 'micromark-util-character';
 
-function isFormat(type) {
-  return type === 'strong' || type === 'emphasis' || type === 'delete';
+export function isFormat(type) {
+  return type === 'strong'
+    || type === 'emphasis'
+    || type === 'delete'
+    || type === 'superscript'
+    || type === 'subscript'
+    || type === 'underline';
+}
+
+function isSnug(type) {
+  return type === 'superscript' || type === 'subscript';
 }
 
 /**
@@ -100,7 +109,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 += ' ';
@@ -109,7 +118,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}`;