@t8/docsgen 0.2.29 → 0.2.31

package/dist/bin.js

@@ -451,7 +451,7 @@ function getTitle(ctx, { cover, originalContent, withPackageURL } = {}) {
 }
 
 // src/bin/parsing/getParsedContent.ts
-var import_jsdom4 = require("jsdom");
+var import_jsdom3 = require("jsdom");
 var import_markdown_it = __toESM(require("markdown-it"));
 
 // src/bin/getSlug.ts
@@ -538,26 +538,22 @@ function getSectionPostprocess(linkMap) {
   };
 }
 
+// src/bin/parsing/isBadgeContainer.ts
+var badgeImageSelector = 'img[src^="https://img.shields.io/"], img[src^="https://flat.badgen.net/"]';
+function isBadgeContainer(element) {
+  if (!element.matches("p") || element.children.length === 0) return false;
+  for (let e of element.children) {
+    if (!e.matches(badgeImageSelector) && (!e.matches("a") || e.children.length !== 1 || !e.children[0]?.matches(badgeImageSelector)))
+      return false;
+  }
+  return true;
+}
+
 // 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")) {
-    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;
-}
-
 // src/bin/parsing/preprocessContent.ts
 var marker = {
   show: {
@@ -589,9 +585,9 @@ async function getParsedContent(ctx) {
     getLocation(ctx, "README.md", ctx.source)
   );
   let content = md.render(preprocessContent(rawContent));
-  let dom = new import_jsdom4.JSDOM(content);
+  let dom = new import_jsdom3.JSDOM(content);
   let { nav, linkMap: navLinkMap } = buildNav(ctx, dom);
-  let badges = [];
+  let badges = "";
   let title = "";
   let description = [];
   let descriptionNote = [];
@@ -601,41 +597,50 @@ async function getParsedContent(ctx) {
   let installation = "";
   let section = [];
   let sections = [];
-  let hasTitle = false;
   let hasFeatures = false;
   let indexComplete = false;
-  let element = dom.window.document.body.firstElementChild;
-  while (element !== null) {
-    if (element.matches("h1")) hasTitle = true;
-    else {
-      if (element.matches("h2")) {
-        if (!indexComplete) indexComplete = true;
-        if (!singlePage && section.length !== 0) {
-          sections.push(joinLines(section));
-          section = [];
-        }
-      }
-      let { outerHTML } = element;
-      if (indexComplete) section.push(outerHTML);
-      else if (!hasTitle) {
-        badges.push(outerHTML);
-      } else if (!hasFeatures) {
-        if (element.matches("ul")) {
-          hasFeatures = true;
-          features.push(outerHTML);
-        } else {
-          let installationCode = getInstallationCode(element);
-          if (installationCode) installation = installationCode;
-          else if (description.length === 0) description.push(outerHTML);
-          else intro.push(outerHTML);
-        }
-      } else {
-        let installationCode = getInstallationCode(element);
-        if (installationCode) installation = installationCode;
-        else note.push(outerHTML);
+  for (let element of dom.window.document.body.children) {
+    if (isBadgeContainer(element)) {
+      badges = element.outerHTML;
+      continue;
+    }
+    if (element.matches("h1")) {
+      title = element.innerHTML;
+      continue;
+    }
+    if (element.matches("h2")) {
+      if (!indexComplete) indexComplete = true;
+      if (!singlePage && section.length !== 0) {
+        sections.push(joinLines(section));
+        section = [];
       }
     }
-    element = element.nextElementSibling;
+    let { outerHTML } = element;
+    if (indexComplete) {
+      section.push(outerHTML);
+      continue;
+    }
+    if (hasFeatures) {
+      let installationCode2 = getInstallationCode(element);
+      if (installationCode2) installation = installationCode2;
+      else note.push(outerHTML);
+      continue;
+    }
+    if (element.matches("ul")) {
+      hasFeatures = true;
+      features.push(outerHTML);
+      continue;
+    }
+    let installationCode = getInstallationCode(element);
+    if (installationCode) {
+      installation = installationCode;
+      continue;
+    }
+    if (element.matches("p") && description.length === 0) {
+      description.push(outerHTML);
+      continue;
+    }
+    intro.push(outerHTML);
   }
   if (section.length !== 0) sections.push(joinLines(section));
   let postprocess = getSectionPostprocess({
@@ -647,10 +652,6 @@ async function getParsedContent(ctx) {
     description = [];
   }
   if (intro.at(-1) === "<hr>") intro.pop();
-  if (intro.length === 1) {
-    descriptionNote = intro;
-    intro = [];
-  }
   for (let i = 0; i < intro.length; i++) {
     if (intro[i].includes("<br>") && intro[i].startsWith("<p>") && intro[i].endsWith("</p>")) {
       let s = intro[i].slice(3, -4).replace(/<br>(\r?\n)?(\s*)/g, '</span><br>$1$2<span class="li">');
@@ -658,7 +659,8 @@ async function getParsedContent(ctx) {
     }
   }
   return {
-    badges: postprocessBadges(joinLines(badges)),
+    badges,
+    // postprocessBadges(joinLines(badges)),
     title,
     description: joinLines(description),
     descriptionNote: joinLines(descriptionNote),
@@ -696,7 +698,7 @@ function getDefaultCodeStyleContent(cssRoot) {
     `.trim();
 }
 function tweakTypography(s = "") {
-  return s.replace(/\b(for|in|on|at|with|a|an|the)\s+/gi, "$1\xA0").replace(/\b(React)\s+(apps?)\b/gi, "$1\xA0$2");
+  return s.replace(/\b(for|in|on|at|to|with|a|an|the|its)\s+/gi, "$1\xA0").replace(/\b(React)\s+(apps?)\b/gi, "$1\xA0$2");
 }
 async function setContent(ctx) {
   let {

package/package.json

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

package/src/bin/parsing/getParsedContent.ts

@@ -6,8 +6,8 @@ import { getLocation } from "../getLocation";
 import { buildNav } from "./buildNav";
 import { getInstallationCode } from "./getInstallationCode";
 import { getSectionPostprocess } from "./getSectionPostprocess";
+import { isBadgeContainer } from "./isBadgeContainer";
 import { joinLines } from "./joinLines";
-import { postprocessBadges } from "./postprocessBadges";
 import { preprocessContent } from "./preprocessContent";
 
 const md = new Markdown({
@@ -24,7 +24,7 @@ export async function getParsedContent(ctx: Context) {
 
   let { nav, linkMap: navLinkMap } = buildNav(ctx, dom);
 
-  let badges: string[] = [];
+  let badges = "";
   let title = "";
   let description: string[] = [];
   let descriptionNote: string[] = [];
@@ -36,49 +36,64 @@ export async function getParsedContent(ctx: Context) {
   let section: string[] = [];
   let sections: string[] = [];
 
-  let hasTitle = false;
   let hasFeatures = false;
   let indexComplete = false;
 
-  let element = dom.window.document.body.firstElementChild;
+  for (let element of dom.window.document.body.children) {
+    if (isBadgeContainer(element)) {
+      badges = element.outerHTML;
+      continue;
+    }
 
-  while (element !== null) {
-    if (element.matches("h1")) hasTitle = true;
-    else {
-      if (element.matches("h2")) {
-        if (!indexComplete) indexComplete = true;
+    if (element.matches("h1")) {
+      title = element.innerHTML;
+      continue;
+    }
 
-        if (!singlePage && section.length !== 0) {
-          sections.push(joinLines(section));
-          section = [];
-        }
-      }
+    if (element.matches("h2")) {
+      if (!indexComplete) indexComplete = true;
 
-      let { outerHTML } = element;
-
-      if (indexComplete) section.push(outerHTML);
-      else if (!hasTitle) {
-        badges.push(outerHTML);
-      } else if (!hasFeatures) {
-        if (element.matches("ul")) {
-          hasFeatures = true;
-          features.push(outerHTML);
-        } else {
-          let installationCode = getInstallationCode(element);
-
-          if (installationCode) installation = installationCode;
-          else if (description.length === 0) description.push(outerHTML);
-          else intro.push(outerHTML);
-        }
-      } else {
-        let installationCode = getInstallationCode(element);
-
-        if (installationCode) installation = installationCode;
-        else note.push(outerHTML);
+      if (!singlePage && section.length !== 0) {
+        sections.push(joinLines(section));
+        section = [];
       }
     }
 
-    element = element.nextElementSibling;
+    let { outerHTML } = element;
+
+    if (indexComplete) {
+      section.push(outerHTML);
+      continue;
+    }
+
+    if (hasFeatures) {
+      let installationCode = getInstallationCode(element);
+
+      if (installationCode) installation = installationCode;
+      else note.push(outerHTML);
+
+      continue;
+    }
+
+    if (element.matches("ul")) {
+      hasFeatures = true;
+      features.push(outerHTML);
+      continue;
+    }
+
+    let installationCode = getInstallationCode(element);
+
+    if (installationCode) {
+      installation = installationCode;
+      continue;
+    }
+
+    if (element.matches("p") && description.length === 0) {
+      description.push(outerHTML);
+      continue;
+    }
+
+    intro.push(outerHTML);
   }
 
   if (section.length !== 0) sections.push(joinLines(section));
@@ -99,11 +114,6 @@ export async function getParsedContent(ctx: Context) {
 
   if (intro.at(-1) === "<hr>") intro.pop();
 
-  if (intro.length === 1) {
-    descriptionNote = intro;
-    intro = [];
-  }
-
   for (let i = 0; i < intro.length; i++) {
     if (
       intro[i].includes("<br>") &&
@@ -119,7 +129,7 @@ export async function getParsedContent(ctx: Context) {
   }
 
   return {
-    badges: postprocessBadges(joinLines(badges)),
+    badges, // postprocessBadges(joinLines(badges)),
     title,
     description: joinLines(description),
     descriptionNote: joinLines(descriptionNote),

package/src/bin/parsing/isBadgeContainer.ts

@@ -0,0 +1,18 @@
+let badgeImageSelector =
+  'img[src^="https://img.shields.io/"], img[src^="https://flat.badgen.net/"]';
+
+export function isBadgeContainer(element: Element) {
+  if (!element.matches("p") || element.children.length === 0) return false;
+
+  for (let e of element.children) {
+    if (
+      !e.matches(badgeImageSelector) &&
+      (!e.matches("a") ||
+        e.children.length !== 1 ||
+        !e.children[0]?.matches(badgeImageSelector))
+    )
+      return false;
+  }
+
+  return true;
+}

package/src/bin/setContent.ts

@@ -30,7 +30,7 @@ function getDefaultCodeStyleContent(cssRoot: string) {
 
 function tweakTypography(s = "") {
   return s
-    .replace(/\b(for|in|on|at|with|a|an|the)\s+/gi, "$1\xa0")
+    .replace(/\b(for|in|on|at|to|with|a|an|the|its)\s+/gi, "$1\xa0")
     .replace(/\b(React)\s+(apps?)\b/gi, "$1\xa0$2");
 }