@adobe/helix-docx2md 1.4.9 → 1.4.10

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.4.10](https://github.com/adobe/helix-docx2md/compare/v1.4.9...v1.4.10) (2023-07-18)
+
+
+### Bug Fixes
+
+* improve handling of sub- and superscript ([#266](https://github.com/adobe/helix-docx2md/issues/266)) ([fd32fc8](https://github.com/adobe/helix-docx2md/commit/fd32fc8bcaabe1f591c5ba488abc7a21a37e4f1b)), closes [#262](https://github.com/adobe/helix-docx2md/issues/262)
+
 ## [1.4.9](https://github.com/adobe/helix-docx2md/compare/v1.4.8...v1.4.9) (2023-07-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-docx2md",
-  "version": "1.4.9",
+  "version": "1.4.10",
   "description": "Helix library that converts word documents to markdown",
   "type": "module",
   "main": "./src/index.js",
@@ -33,7 +33,7 @@
   },
   "homepage": "https://github.com/adobe/helix-docx2md#readme",
   "dependencies": {
-    "@adobe/helix-markdown-support": "6.1.3",
+    "@adobe/helix-markdown-support": "6.2.1",
     "@adobe/helix-shared-process-queue": "3.0.0",
     "@adobe/mammoth": "1.5.1-bleeding.2",
     "@adobe/mdast-util-gridtables": "2.0.1",
@@ -52,13 +52,13 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.2",
-    "@adobe/helix-mediahandler": "2.2.4",
+    "@adobe/helix-mediahandler": "2.2.5",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "c8": "8.0.0",
     "dotenv": "16.3.1",
-    "eslint": "8.44.0",
+    "eslint": "8.45.0",
     "husky": "8.0.3",
     "junit-report-builder": "3.0.1",
     "lint-staged": "13.2.3",

package/src/dast2mdast/handlers/run.js

@@ -63,13 +63,13 @@ export default function run(h, node, parent, siblings) {
 
   let result = nodes;
   if (node.verticalAlignment === 'superscript') {
-    result = [h('html', { value: '<sup>' }), ...result, h('html', { value: '</sup>' })];
+    result = [h('superscript', result)];
   }
   if (node.verticalAlignment === 'subscript') {
-    result = [h('html', { value: '<sub>' }), ...result, h('html', { value: '</sub>' })];
+    result = [h('subscript', result)];
   }
   if (node.isUnderline && node.styleId !== 'Hyperlink') {
-    result = [h('html', { value: '<u>' }), ...result, h('html', { value: '</u>' })];
+    result = [h('underline', result)];
   }
   if (node.isBold) {
     result = [h('strong', result)];

package/src/mdast2md/format-plugin/index.js

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2021 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 toMarkdown from './to-markdown.js';
+
+export default function formatPlugin(options) {
+  const data = this.data();
+
+  function add(field, value) {
+    /* c8 ignore next 2 */
+    if (data[field]) {
+      data[field].push(value);
+    } else {
+      data[field] = [value];
+    }
+  }
+
+  // add('micromarkExtensions', syntax(options));
+  // add('fromMarkdownExtensions', fromMarkdown(options));
+  add('toMarkdownExtensions', toMarkdown(options));
+}

package/src/mdast2md/format-plugin/to-markdown.js

@@ -0,0 +1,51 @@
+/*
+ * 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.
+ */
+/**
+ * Renders special html only format.
+ */
+function format(tagName) {
+  const tagOpen = `<${tagName}>`;
+  const tagClose = `</${tagName}>`;
+
+  /**
+   * @param {Node} node
+   * @param {Parents | undefined} _
+   * @param {State} state
+   * @param {Info} info
+   * @returns {string}
+   */
+  return (node, _, state, info) => {
+    const exit = state.enter('html');
+    const tracker = state.createTracker(info);
+    let value = tracker.move(tagOpen);
+    value += tracker.move(
+      state.containerPhrasing(node, {
+        before: value,
+        after: tagOpen,
+        ...tracker.current(),
+      }),
+    );
+    value += tracker.move(tagClose);
+    exit();
+    return value;
+  };
+}
+
+export default function toMarkdown() {
+  return {
+    handlers: {
+      subscript: format('sub'),
+      superscript: format('sup'),
+      underline: format('u'),
+    },
+  };
+}

package/src/mdast2md/mdast2md.js

@@ -26,7 +26,7 @@ import {
   sanitizeText,
   sanitizeTextAndFormats,
   sanitizeLinks,
-  imageReferences,
+  imageReferences, renderHtmlFormats,
 } from '@adobe/helix-markdown-support';
 import { remarkMatter } from '@adobe/helix-markdown-support/matter';
 import remarkGridTable from '@adobe/remark-gridtables';
@@ -34,6 +34,7 @@ import remarkGridTable from '@adobe/remark-gridtables';
 import processImages from './mdast-process-images.js';
 import sanitizeAutoEmbeds from './mdast-sanitize-autoembeds.js';
 import orderedListPlugin from './ordered-list/index.js';
+import formatPlugin from './format-plugin/index.js';
 
 /**
  * Converts the mdast to markdown using common filters suitable for helix.
@@ -61,6 +62,7 @@ export default async function mdast2md(mdast, opts = {}) {
       ruleSpaces: false,
     })
     .use(gfm)
+    .use(formatPlugin)
     .use(remarkMatter)
     .use(orderedListPlugin);
 
@@ -81,6 +83,7 @@ export default async function mdast2md(mdast, opts = {}) {
     await sanitizeFormats(mdast); // collapse formats once
     await sanitizeLinks(mdast);
     await sanitizeFormats(mdast); // and again for sanitized links
+    await renderHtmlFormats(mdast);
     await sanitizeText(mdast);
     await suppressSpaceCode(mdast);
     await sanitizeAutoEmbeds(mdast);