Revert "fix: Revert "fix: nested lists roundtrip" (#539)"

This reverts commit ea645a9.
adobe · Sep 6, 2024 · 88392b9 · 88392b9
1 parent e92af55
commit 88392b9
Show file tree

Hide file tree

Showing 8 changed files with 93 additions and 8 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npx lint-staged
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "deploy": "hedy -v --deploy --test",
     "deploy-routes": "hedy --no-build --no-hints -l major",
     "deploy-ci": "hedy -v --deploy --test --pkgVersion=ci$CI_BUILD_NUM -l ci --cleanup-ci 24h",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "wsk": {
     "target": "aws",

diff --git a/src/html2md.js b/src/html2md.js
@@ -31,6 +31,7 @@ import {
   TYPE_GRID_TABLE, TYPE_GT_BODY, TYPE_GT_CELL, TYPE_GT_ROW, handleTableAsGridTable,
 } from './mdast-table-handler.js';
 import formatPlugin from './markdownFormatPlugin.js';
+import { unspreadLists } from './unspread-lists.js';
 
 function m(type, children, props = {}) {
   return {
@@ -282,6 +283,7 @@ export async function html2md(html, opts) {
   imageReferences(mdast);
   sanitizeHeading(mdast);
   sanitizeTextAndFormats(mdast);
+  unspreadLists(mdast);
 
   // noinspection JSVoidFunctionReturnValueUsed
   const md = unified()

diff --git a/src/unspread-lists.js b/src/unspread-lists.js
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 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';
+
+/**
+ * Collapse (un-spread) all lists
+ * @param {object} tree
+ */
+export function unspreadLists(tree) {
+  visit(tree, (node) => {
+    if (node.type === 'list' || node.type === 'listItem') {
+      // eslint-disable-next-line no-param-reassign
+      node.spread = false;
+    }
+    return CONTINUE;
+  });
+}
diff --git a/test/fixtures/codeblock.md b/test/fixtures/codeblock.md
@@ -4,15 +4,11 @@
 | Procedure                                                                                                                                        |
 +--------------------------------------------------------------------------------------------------------------------------------------------------+
 | 1. Log in to Azure with the Azure CLI.                                                                                                           |
-|                                                                                                                                                  |
 | 2. Query Azure for your tenant and subscription IDs. .                                                                                           |
-|                                                                                                                                                  |
 |    ```                                                                                                                                           |
 |    az account list                                                                                                                               |
 |    ```                                                                                                                                           |
-|                                                                                                                                                  |
 | 3. Copy the output which is similar to the following example. In the output, identify the `tenantId` tenant ID and the `id` of the subscription. |
-|                                                                                                                                                  |
 |    ```bash                                                                                                                                       |
 |        "cloudName": "AzureCloud",                                                                                                                |
 |         "homeTenantId": <This value is not needed>,                                                                                              |

diff --git a/test/roundtrip/roundtrip-fixtures/nested-lists.input.html b/test/roundtrip/roundtrip-fixtures/nested-lists.input.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <title>Nested Lists</title>
+</head>
+
+<body>
+  <main>
+    <div>
+      <ul>
+        <li><a href="#" title="Navigate to Text 1">Text 1</a></li>
+        <li><a href="#" title="Navigate to Text 2">Text 2</a>
+          <ul>
+            <li><a href="#" title="Navigate to Text 2 / 1">Text 2 / 1</a>
+              <ul>
+                <li><a href="#" title="Navigate to Text 2 / 1 / 1">Text 2 / 1 / 1</a></li>
+                <li><a href="#" title="Navigate to Text 2 / 1 / 2">Text 2 / 1 / 2</a></li>
+                <li><a href="#" title="Navigate to Text 2 / 1 / 3">Text 2 / 1 / 3</a></li>
+              </ul>
+            </li>
+          </ul>
+        </li>
+      </ul>
+    </div>
+  </main>
+</body>
diff --git a/test/roundtrip/roundtrip-fixtures/nested-lists.output.html b/test/roundtrip/roundtrip-fixtures/nested-lists.output.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Nested Lists</title>
+    <link rel="canonical" href="https://undefined/">
+    <meta property="og:title" content="Nested Lists">
+    <meta property="og:url" content="https://undefined/">
+    <meta property="og:image" content="https://undefined/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
+    <meta property="og:image:secure_url" content="https://undefined/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
+    <meta name="twitter:card" content="summary_large_image">
+    <meta name="twitter:title" content="Nested Lists">
+    <meta name="twitter:image" content="https://undefined/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
+  </head>
+  <body>
+    <header></header>
+    <main>
+      <div>
+        <ul>
+          <li><a href="#" title="Navigate to Text 1">Text 1</a></li>
+          <li><a href="#" title="Navigate to Text 2">Text 2</a>
+            <ul>
+              <li><a href="#" title="Navigate to Text 2 / 1">Text 2 / 1</a>
+                <ul>
+                  <li><a href="#" title="Navigate to Text 2 / 1 / 1">Text 2 / 1 / 1</a></li>
+                  <li><a href="#" title="Navigate to Text 2 / 1 / 2">Text 2 / 1 / 2</a></li>
+                  <li><a href="#" title="Navigate to Text 2 / 1 / 3">Text 2 / 1 / 3</a></li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+        </ul>
+      </div>
+    </main>
+    <footer></footer>
+  </body>
+</html>
diff --git a/test/roundtrip/roundtrip.test.js b/test/roundtrip/roundtrip.test.js
@@ -25,6 +25,7 @@ const specs = [
   'some-text',
   'all-sections',
   'microdata',
+  'nested-lists',
 ];
 
 describe('Roundtrip tests', () => {