refactor(core/reindent): move reindent to utils (speced#4629)

Author: marcoscaceres

src/core/markdown.js

@@ -11,9 +11,8 @@
  *
  */
 
-import { getElementIndentation } from "./utils.js";
+import { getElementIndentation, reindent } from "./utils.js";
 import { marked } from "./import-maps.js";
-import { reindent } from "./reindent.js";
 export const name = "core/markdown";
 
 const gtEntity = />/gm;

src/core/reindent.js

@@ -1,29 +1,13 @@
 // @ts-check
 /**
- * Module core/reindent
+ * @module core/reindent
  *
- * Removes common indents across the IDL texts,
+ * Normalizes indents across the pre elements in the document,
  * so that indentation inside <pre> won't affect the rendered result.
  */
-
+import { reindent } from "./utils.js";
 export const name = "core/reindent";
 
-/**
- * @param {string} text
- */
-export function reindent(text) {
-  if (!text) {
-    return text;
-  }
-  const lines = text.trimEnd().split("\n");
-  while (lines.length && !lines[0].trim()) {
-    lines.shift();
-  }
-  const indents = lines.filter(s => s.trim()).map(s => s.search(/[^\s]/));
-  const leastIndent = Math.min(...indents);
-  return lines.map(s => s.slice(leastIndent)).join("\n");
-}
-
 export function run() {
   for (const pre of document.getElementsByTagName("pre")) {
     pre.innerHTML = reindent(pre.innerHTML);

src/core/ui.js

@@ -9,11 +9,10 @@
 //  - make a release candidate that people can test
 //  - once we have something decent, merge, ship as 3.2.0
 import { html, pluralize } from "./import-maps.js";
+import { reindent, xmlEscape } from "./utils.js";
 import css from "../styles/ui.css.js";
 import { markdownToHtml } from "./markdown.js";
-import { reindent } from "./reindent.js";
 import { sub } from "./pubsubhub.js";
-import { xmlEscape } from "./utils.js";
 export const name = "core/ui";
 
 // Opportunistically inserts the style, with the chance to reduce some FOUC

src/core/utils.js

@@ -5,7 +5,6 @@
 import { lang as docLang } from "./l10n.js";
 import { html } from "./import-maps.js";
 import { pub } from "./pubsubhub.js";
-import { reindent } from "./reindent.js";
 export const name = "core/utils";
 
 const dashes = /-/g;
@@ -962,3 +961,24 @@ export function docLink(strings, ...keys) {
     .join("");
   return reindent(linkifiedStr);
 }
+
+/**
+ * Takes a text string, trims it, splits it into lines,
+ * finds the common indentation level, and then de-indents every line
+ * by that common indentation level.
+ *
+ * @param {string} text - The text to be re-indented.
+ * @returns {string} The re-indented text.
+ */
+export function reindent(text) {
+  if (!text) {
+    return text;
+  }
+  const lines = text.trimEnd().split("\n");
+  while (lines.length && !lines[0].trim()) {
+    lines.shift();
+  }
+  const indents = lines.filter(s => s.trim()).map(s => s.search(/[^\s]/));
+  const leastIndent = Math.min(...indents);
+  return lines.map(s => s.slice(leastIndent)).join("\n");
+}