@t8/docsgen 0.1.81 → 0.1.82

package/dist/bin.js

@@ -421,8 +421,28 @@ ${navContent}
 </nav>`;
 }
 
-// src/bin/getParsedContent.ts
-var import_jsdom3 = require("jsdom");
+// src/bin/getTitle.ts
+function getTitle(ctx, { cover, originalContent, withPackageURL } = {}) {
+  let { root, name, title: packageTitle, htmlTitle, scope } = ctx;
+  if (originalContent && ![name, packageTitle].includes(originalContent.trim()))
+    return originalContent;
+  if (cover && htmlTitle) return htmlTitle;
+  if (packageTitle) {
+    let escapedTitle = escapeHTML(packageTitle);
+    return withPackageURL ? `<a href="${root}" class="name">${escapedTitle}</a>` : `<span class="name">${escapedTitle}</span>`;
+  }
+  let scopeMatches = name?.match(/^(@[^/]+)\/?(.*)/);
+  if (!scope || !scopeMatches) {
+    let escapedName = escapeHTML(name);
+    return withPackageURL ? `<a href="${root}" class="name">${escapedName}</a>` : `<span class="name">${escapedName}</span>`;
+  }
+  let title = `<a href="${scope}" class="scope">${scopeMatches[1]}</a><span class="sep">/</span>`;
+  title += withPackageURL ? `<a href="${root}" class="name">${scopeMatches[2]}</a>` : `<span class="name">${scopeMatches[2]}</span>`;
+  return title;
+}
+
+// src/bin/parsing/getParsedContent.ts
+var import_jsdom4 = require("jsdom");
 var import_markdown_it = __toESM(require("markdown-it"));
 
 // src/bin/getSlug.ts
@@ -436,13 +456,7 @@ function getSlug(title) {
   return slug;
 }
 
-// src/bin/getParsedContent.ts
-var md = new import_markdown_it.default({
-  html: true
-});
-function joinLines(x) {
-  return x.join("\n").trim();
-}
+// src/bin/parsing/buildNav.ts
 function buildNav(ctx, dom) {
   let { root, contentDir, singlePage } = ctx;
   let linkMap = {};
@@ -496,9 +510,13 @@ function buildNav(ctx, dom) {
     linkMap
   };
 }
+
+// src/bin/parsing/getInstallationCode.ts
 function getInstallationCode(element) {
   return element.querySelector("code")?.innerHTML.trim().match(/(\S\s*)?(npm (i|install) .*)/)?.[2];
 }
+
+// src/bin/parsing/getSectionPostprocess.ts
 function getSectionPostprocess(linkMap) {
   return (content) => {
     let s = content;
@@ -510,6 +528,14 @@ function getSectionPostprocess(linkMap) {
     return s;
   };
 }
+
+// src/bin/parsing/joinLines.ts
+function joinLines(x) {
+  return x.join("\n").trim();
+}
+
+// src/bin/parsing/postprocessBadges.ts
+var import_jsdom3 = require("jsdom");
 function postprocessBadges(content) {
   let { document } = new import_jsdom3.JSDOM(content).window;
   for (let img of document.querySelectorAll("img")) {
@@ -522,11 +548,37 @@ function postprocessBadges(content) {
   }
   return document.body.innerHTML;
 }
+
+// src/bin/parsing/preprocessContent.ts
+var marker = {
+  show: {
+    start: "<!-- docsgen-show-start --",
+    end: "-- docsgen-show-end -->"
+  },
+  hide: {
+    start: "<!-- docsgen-hide-start -->",
+    end: "<!-- docsgen-hide-end -->"
+  }
+};
+function preprocessContent(s) {
+  let k0 = -1;
+  let k1 = -1;
+  while ((k0 = s.indexOf(marker.show.start, k1)) !== -1 && (k1 = s.indexOf(marker.show.end, k0)) !== -1)
+    s = `${s.slice(0, k0)}${s.slice(k0 + marker.show.start.length, k1)}${s.slice(k1 + marker.show.end.length)}`;
+  while ((k0 = s.indexOf(marker.hide.start, k1)) !== -1 && (k1 = s.indexOf(marker.hide.end, k0)) !== -1)
+    s = `${s.slice(0, k0 + marker.show.start.length - 1)}${s.slice(k0 + marker.show.start.length, k1)}${s.slice(k1 + marker.show.end.length + 2)}`;
+  return s;
+}
+
+// src/bin/parsing/getParsedContent.ts
+var md = new import_markdown_it.default({
+  html: true
+});
 async function getParsedContent(ctx) {
   let { singlePage, linkMap } = ctx;
   let rawContent = await fetchText(getLocation(ctx, "README.md", ctx.source));
-  let content = md.render(rawContent);
-  let dom = new import_jsdom3.JSDOM(content);
+  let content = md.render(preprocessContent(rawContent));
+  let dom = new import_jsdom4.JSDOM(content);
   let { nav, linkMap: navLinkMap } = buildNav(ctx, dom);
   let badges = [];
   let title = "";
@@ -608,26 +660,6 @@ async function getParsedContent(ctx) {
   };
 }
 
-// src/bin/getTitle.ts
-function getTitle(ctx, { cover, originalContent, withPackageURL } = {}) {
-  let { root, name, title: packageTitle, htmlTitle, scope } = ctx;
-  if (originalContent && ![name, packageTitle].includes(originalContent.trim()))
-    return originalContent;
-  if (cover && htmlTitle) return htmlTitle;
-  if (packageTitle) {
-    let escapedTitle = escapeHTML(packageTitle);
-    return withPackageURL ? `<a href="${root}" class="name">${escapedTitle}</a>` : `<span class="name">${escapedTitle}</span>`;
-  }
-  let scopeMatches = name?.match(/^(@[^/]+)\/?(.*)/);
-  if (!scope || !scopeMatches) {
-    let escapedName = escapeHTML(name);
-    return withPackageURL ? `<a href="${root}" class="name">${escapedName}</a>` : `<span class="name">${escapedName}</span>`;
-  }
-  let title = `<a href="${scope}" class="scope">${scopeMatches[1]}</a><span class="sep">/</span>`;
-  title += withPackageURL ? `<a href="${root}" class="name">${scopeMatches[2]}</a>` : `<span class="name">${scopeMatches[2]}</span>`;
-  return title;
-}
-
 // src/bin/toFileContent.ts
 function toFileContent(x) {
   let s = x.replace(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t8/docsgen",
-  "version": "0.1.81",
+  "version": "0.1.82",
   "description": "",
   "main": "dist/bin.js",
   "bin": {

package/src/bin/parsing/buildNav.ts

@@ -0,0 +1,71 @@
+import type { JSDOM } from "jsdom";
+import type { Context } from "../../types/Context";
+import type { NavItem } from "../../types/NavItem";
+import { getSlug } from "../getSlug";
+
+export function buildNav(ctx: Context, dom: JSDOM) {
+  let { root, contentDir, singlePage } = ctx;
+  let linkMap: Record<string, string> = {};
+
+  let navItem: NavItem | null = null;
+  let nav: NavItem[] = [];
+
+  if (singlePage)
+    navItem = {
+      id: "Overview",
+      title: "Overview",
+      items: [],
+    };
+
+  let headings =
+    dom.window.document.body.querySelectorAll("h2, h3, h4, h5, h6");
+
+  for (let element of headings) {
+    let tagName = element.tagName.toLowerCase();
+
+    let isSectionTitle = tagName === "h2";
+    let isSubsectionTitle = tagName === "h3";
+    let slug = getSlug(element.textContent);
+
+    let sectionId = isSectionTitle ? slug : (navItem?.id ?? "");
+    let link = `${root}${contentDir}/${sectionId}`;
+
+    let elementId = element.id || slug.toLowerCase().replace(/_/g, "-");
+
+    if (elementId)
+      linkMap[`#${elementId}`] = `${link}${isSectionTitle ? "" : `#${slug}`}`;
+
+    if (singlePage && isSectionTitle) {
+      if (navItem) {
+        element.id = slug;
+        navItem.items.push({
+          id: slug,
+          title: element.innerHTML.trim(),
+        });
+      }
+    } else if (isSectionTitle) {
+      if (navItem) nav.push(navItem);
+
+      navItem = {
+        id: slug,
+        title: element.innerHTML.trim(),
+        items: [],
+      };
+    } else if (isSubsectionTitle) {
+      if (navItem) {
+        element.id = slug;
+        navItem.items.push({
+          id: slug,
+          title: element.innerHTML.trim(),
+        });
+      }
+    }
+  }
+
+  if (navItem) nav.push(navItem);
+
+  return {
+    nav,
+    linkMap,
+  };
+}

package/src/bin/parsing/getInstallationCode.ts

@@ -0,0 +1,6 @@
+export function getInstallationCode(element: Element) {
+  return element
+    .querySelector("code")
+    ?.innerHTML.trim()
+    .match(/(\S\s*)?(npm (i|install) .*)/)?.[2];
+}

package/src/bin/{getParsedContent.ts → parsing/getParsedContent.ts}

@@ -1,130 +1,23 @@
 import { JSDOM } from "jsdom";
 import Markdown from "markdown-it";
-import type { Context } from "../types/Context";
-import type { NavItem } from "../types/NavItem";
-import { fetchText } from "./fetchText";
-import { getLocation } from "./getLocation";
-import { getSlug } from "./getSlug";
+import type { Context } from "../../types/Context";
+import { fetchText } from "../fetchText";
+import { getLocation } from "../getLocation";
+import { buildNav } from "./buildNav";
+import { getInstallationCode } from "./getInstallationCode";
+import { getSectionPostprocess } from "./getSectionPostprocess";
+import { joinLines } from "./joinLines";
+import { postprocessBadges } from "./postprocessBadges";
+import { preprocessContent } from "./preprocessContent";
 
 const md = new Markdown({
   html: true,
 });
 
-function joinLines(x: string[]) {
-  return x.join("\n").trim();
-}
-
-function buildNav(ctx: Context, dom: JSDOM) {
-  let { root, contentDir, singlePage } = ctx;
-  let linkMap: Record<string, string> = {};
-
-  let navItem: NavItem | null = null;
-  let nav: NavItem[] = [];
-
-  if (singlePage)
-    navItem = {
-      id: "Overview",
-      title: "Overview",
-      items: [],
-    };
-
-  let headings =
-    dom.window.document.body.querySelectorAll("h2, h3, h4, h5, h6");
-
-  for (let element of headings) {
-    let tagName = element.tagName.toLowerCase();
-
-    let isSectionTitle = tagName === "h2";
-    let isSubsectionTitle = tagName === "h3";
-    let slug = getSlug(element.textContent);
-
-    let sectionId = isSectionTitle ? slug : (navItem?.id ?? "");
-    let link = `${root}${contentDir}/${sectionId}`;
-
-    let elementId = element.id || slug.toLowerCase().replace(/_/g, "-");
-
-    if (elementId)
-      linkMap[`#${elementId}`] = `${link}${isSectionTitle ? "" : `#${slug}`}`;
-
-    if (singlePage && isSectionTitle) {
-      if (navItem) {
-        element.id = slug;
-        navItem.items.push({
-          id: slug,
-          title: element.innerHTML.trim(),
-        });
-      }
-    } else if (isSectionTitle) {
-      if (navItem) nav.push(navItem);
-
-      navItem = {
-        id: slug,
-        title: element.innerHTML.trim(),
-        items: [],
-      };
-    } else if (isSubsectionTitle) {
-      if (navItem) {
-        element.id = slug;
-        navItem.items.push({
-          id: slug,
-          title: element.innerHTML.trim(),
-        });
-      }
-    }
-  }
-
-  if (navItem) nav.push(navItem);
-
-  return {
-    nav,
-    linkMap,
-  };
-}
-
-function getInstallationCode(element: Element) {
-  return element
-    .querySelector("code")
-    ?.innerHTML.trim()
-    .match(/(\S\s*)?(npm (i|install) .*)/)?.[2];
-}
-
-function getSectionPostprocess(linkMap: Record<string, string | undefined>) {
-  return (content: string) => {
-    let s = content;
-
-    s = s.replace(/<a href="([^"]+)">/g, (_, url) => {
-      let nextURL = linkMap[url] ?? url;
-      let attrs = /^(https?:)?\/\//.test(nextURL) ? ' target="_blank"' : "";
-
-      return `<a href="${nextURL}"${attrs}>`;
-    });
-
-    return s;
-  };
-}
-
-function postprocessBadges(content: string) {
-  let { document } = new JSDOM(content).window;
-
-  for (let img of document.querySelectorAll("img")) {
-    let parent = img.parentElement;
-
-    if (!parent) continue;
-
-    let container = document.createElement("span");
-    container.className = "badge";
-
-    parent.insertBefore(container, img);
-    container.append(img);
-  }
-
-  return document.body.innerHTML;
-}
-
 export async function getParsedContent(ctx: Context) {
   let { singlePage, linkMap } = ctx;
   let rawContent = await fetchText(getLocation(ctx, "README.md", ctx.source));
-  let content = md.render(rawContent);
+  let content = md.render(preprocessContent(rawContent));
   let dom = new JSDOM(content);
 
   let { nav, linkMap: navLinkMap } = buildNav(ctx, dom);

package/src/bin/parsing/getSectionPostprocess.ts

@@ -0,0 +1,16 @@
+export function getSectionPostprocess(
+  linkMap: Record<string, string | undefined>,
+) {
+  return (content: string) => {
+    let s = content;
+
+    s = s.replace(/<a href="([^"]+)">/g, (_, url) => {
+      let nextURL = linkMap[url] ?? url;
+      let attrs = /^(https?:)?\/\//.test(nextURL) ? ' target="_blank"' : "";
+
+      return `<a href="${nextURL}"${attrs}>`;
+    });
+
+    return s;
+  };
+}

package/src/bin/parsing/joinLines.ts

@@ -0,0 +1,3 @@
+export function joinLines(x: string[]) {
+  return x.join("\n").trim();
+}

package/src/bin/parsing/postprocessBadges.ts

@@ -0,0 +1,19 @@
+import { JSDOM } from "jsdom";
+
+export function postprocessBadges(content: string) {
+  let { document } = new JSDOM(content).window;
+
+  for (let img of document.querySelectorAll("img")) {
+    let parent = img.parentElement;
+
+    if (!parent) continue;
+
+    let container = document.createElement("span");
+    container.className = "badge";
+
+    parent.insertBefore(container, img);
+    container.append(img);
+  }
+
+  return document.body.innerHTML;
+}

package/src/bin/parsing/preprocessContent.ts

@@ -0,0 +1,29 @@
+const marker = {
+  show: {
+    start: "<!-- docsgen-show-start --",
+    end: "-- docsgen-show-end -->",
+  },
+  hide: {
+    start: "<!-- docsgen-hide-start -->",
+    end: "<!-- docsgen-hide-end -->",
+  },
+};
+
+export function preprocessContent(s: string) {
+  let k0 = -1;
+  let k1 = -1;
+
+  while (
+    (k0 = s.indexOf(marker.show.start, k1)) !== -1 &&
+    (k1 = s.indexOf(marker.show.end, k0)) !== -1
+  )
+    s = `${s.slice(0, k0)}${s.slice(k0 + marker.show.start.length, k1)}${s.slice(k1 + marker.show.end.length)}`;
+
+  while (
+    (k0 = s.indexOf(marker.hide.start, k1)) !== -1 &&
+    (k1 = s.indexOf(marker.hide.end, k0)) !== -1
+  )
+    s = `${s.slice(0, k0 + marker.show.start.length - 1)}${s.slice(k0 + marker.show.start.length, k1)}${s.slice(k1 + marker.show.end.length + 2)}`;
+
+  return s;
+}

package/src/bin/setContent.ts

@@ -10,9 +10,9 @@ import { getCounterContent } from "./getCounterContent";
 import { getIcon } from "./getIcon";
 import { getInjectedContent } from "./getInjectedContent";
 import { getNav } from "./getNav";
-import { getParsedContent } from "./getParsedContent";
 import { getRepoLink } from "./getRepoLink";
 import { getTitle } from "./getTitle";
+import { getParsedContent } from "./parsing/getParsedContent";
 import { stripHTML } from "./stripHTML";
 import { toFileContent } from "./toFileContent";