@t8/docsgen 0.1.18 → 0.1.20

package/dist/bin.js

@@ -104,6 +104,15 @@ function getLocation(ctx, path, preferredLocation) {
   return path;
 }
 
+// src/bin/stripHTML.ts
+var import_jsdom = require("jsdom");
+function stripHTML(content) {
+  try {
+    return new import_jsdom.JSDOM(content).window.document.body.textContent;
+  } catch {
+  }
+}
+
 // src/bin/toRepoURL.ts
 function toRepoURL(x) {
   if (!x) return "";
@@ -143,6 +152,22 @@ async function addMetadata(config2) {
     return config2;
   }
 }
+function deriveMissingProps(config2) {
+  let { dir, root, title, htmlTitle } = config2;
+  if (htmlTitle && !title) title = stripHTML(htmlTitle);
+  if (dir && !root) root = `/${dir}/`;
+  if (!root?.endsWith("/")) root = `${root ?? ""}/`;
+  return {
+    ...config2,
+    dir,
+    root,
+    title,
+    htmlTitle
+  };
+}
+async function reviseConfig(config2) {
+  return deriveMissingProps(await addMetadata(config2));
+}
 var config = null;
 async function getConfig() {
   if (config) return config;
@@ -165,9 +190,8 @@ async function getConfig() {
     ...A(args)
   };
   if (config.entries)
-    config.entries = await Promise.all(config.entries.map(addMetadata));
-  else await addMetadata(config);
-  if (!config.root?.endsWith("/")) config.root = `${config.root ?? ""}/`;
+    config.entries = await Promise.all(config.entries.map(reviseConfig));
+  else config = await reviseConfig(config);
   return config;
 }
 
@@ -267,8 +291,21 @@ function getIcon({ favicon, faviconType }) {
   return icon;
 }
 
+// src/bin/getInjectedContent.ts
+function getInjectedContent(ctx, page, target, mode = "append") {
+  let injectedContent = ctx[mode]?.[target];
+  if (!injectedContent) return "";
+  return (Array.isArray(injectedContent) ? injectedContent : [injectedContent]).reduce((s, item) => {
+    if (item === void 0) return s;
+    if (typeof item === "string") return `${s}${s ? "\n" : ""}${item}`;
+    let { content, pages } = item;
+    if (!content || pages && !pages.includes(page)) return s;
+    return `${s}${s ? "\n" : ""}${content}`;
+  }, "");
+}
+
 // src/bin/getNav.ts
-var import_jsdom = require("jsdom");
+var import_jsdom2 = require("jsdom");
 
 // src/bin/getRepoLink.ts
 function getRepoLink({ repo }, className) {
@@ -283,7 +320,7 @@ async function getNav(ctx, navItems) {
   let navContent = await fetchText(nav);
   let s = "";
   if (navContent) {
-    let navDom = new import_jsdom.JSDOM(navContent).window.document.body;
+    let navDom = new import_jsdom2.JSDOM(navContent).window.document.body;
     for (let link of navDom.querySelectorAll("a")) {
       if (link.dataset.name === name) {
         let parent = link.parentElement;
@@ -331,7 +368,7 @@ ${navContent}
 }
 
 // src/bin/getParsedContent.ts
-var import_jsdom2 = require("jsdom");
+var import_jsdom3 = require("jsdom");
 var import_markdown_it = __toESM(require("markdown-it"));
 
 // src/bin/getSlug.ts
@@ -415,7 +452,7 @@ function getSectionPostprocess(linkMap) {
   };
 }
 function postprocessBadges(content) {
-  let { document } = new import_jsdom2.JSDOM(content).window;
+  let { document } = new import_jsdom3.JSDOM(content).window;
   for (let img of document.querySelectorAll("img")) {
     let parent = img.parentElement;
     if (!parent) continue;
@@ -430,7 +467,7 @@ async function getParsedContent(ctx) {
   let { singlePage } = ctx;
   let rawContent = await fetchText(getLocation(ctx, "README.md", ctx.source));
   let content = md.render(rawContent);
-  let dom = new import_jsdom2.JSDOM(content);
+  let dom = new import_jsdom3.JSDOM(content);
   let { nav, linkMap } = buildNav(ctx, dom);
   let badges = [];
   let title = "";
@@ -511,7 +548,7 @@ function getTitle(ctx, { cover, originalContent, withPackageURL } = {}) {
 
 // src/bin/toFileContent.ts
 function toFileContent(x) {
-  return `${x.trim()}
+  return `${x.replace(/\s+(<\/(head|body)>)/g, "\n$1").trim()}
 `;
 }
 
@@ -552,9 +589,11 @@ async function setContent(ctx) {
   <meta name="viewport" content="width=device-width">
   <meta http-equiv="refresh" content="0; URL=${escapedRedirect}">
   ${iconTag}
+  ${getInjectedContent(ctx, "redirect", "head")}
 </head>
 <body>
 ${counterContent}
+${getInjectedContent(ctx, "redirect", "body")}
 <script>window.location.replace("${escapedRedirect}");</script>
 </body>
 </html>
@@ -592,6 +631,7 @@ ${counterContent}
   ${iconTag}
   ${nav[i + 1]?.id ? `<link rel="prefetch" href="${root}${contentDir}/${nav[i + 1]?.id}">` : ""}
   ${nav[i - 1]?.id ? `<link rel="prefetch" href="${root}${contentDir}/${nav[i - 1]?.id}">` : ""}
+  ${getInjectedContent(ctx, "section", "head")}
 </head>
 <body>
 <div class="layout">
@@ -626,6 +666,7 @@ ${content.includes("<pre><code ") ? `
 <script>hljs.highlightAll()</script>
 `.trim() : ""}
 ${counterContent}
+${getInjectedContent(ctx, "section", "body")}
 </body>
 </html>
         `)
@@ -646,6 +687,7 @@ ${counterContent}
   ${iconTag}
   <link rel="prefetch" href="${root}start">
   ${nav[0] ? `<link rel="prefetch" href="${root}${contentDir}/${nav[0]?.id ?? ""}">` : ""}
+  ${getInjectedContent(ctx, "index", "head")}
 </head>
 <body>
 <div class="layout">
@@ -685,6 +727,7 @@ ${[description, features].some((s) => s.includes("<pre><code ")) ? `
 <script>hljs.highlightAll()</script>
 `.trim() : ""}
 ${counterContent}
+${getInjectedContent(ctx, "index", "body")}
 </body>
 </html>
             `)
@@ -702,6 +745,7 @@ ${counterContent}
   <link rel="stylesheet" href="${packageUrl}/dist/css/base.css">
   ${iconTag}
   <script>window.location.replace("${root}${contentDir}/${nav[0]?.id}");</script>
+  ${getInjectedContent(ctx, "start", "head")}
 </head>
 <body>
 <div class="layout">
@@ -709,6 +753,7 @@ ${counterContent}
 </div>
 
 ${counterContent}
+${getInjectedContent(ctx, "start", "body")}
 </body>
 </html>
             `)

package/package.json

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

package/src/bin/getConfig.ts

@@ -4,6 +4,7 @@ import type { EntryConfig } from "../types/EntryConfig";
 import type { PackageMetadata } from "../types/PackageMetadata";
 import { fetchText } from "./fetchText";
 import { getLocation } from "./getLocation";
+import { stripHTML } from "./stripHTML";
 import { toConfig } from "./toConfig";
 
 async function addMetadata(config: EntryConfig) {
@@ -20,6 +21,26 @@ async function addMetadata(config: EntryConfig) {
   }
 }
 
+function deriveMissingProps(config: EntryConfig) {
+  let { dir, root, title, htmlTitle } = config;
+
+  if (htmlTitle && !title) title = stripHTML(htmlTitle);
+  if (dir && !root) root = `/${dir}/`;
+  if (!root?.endsWith("/")) root = `${root ?? ""}/`;
+
+  return {
+    ...config,
+    dir,
+    root,
+    title,
+    htmlTitle,
+  };
+}
+
+async function reviseConfig(config: EntryConfig) {
+  return deriveMissingProps(await addMetadata(config));
+}
+
 let config: BinConfig | null = null;
 
 export async function getConfig(): Promise<BinConfig> {
@@ -48,10 +69,8 @@ export async function getConfig(): Promise<BinConfig> {
   };
 
   if (config.entries)
-    config.entries = await Promise.all(config.entries.map(addMetadata));
-  else await addMetadata(config);
-
-  if (!config.root?.endsWith("/")) config.root = `${config.root ?? ""}/`;
+    config.entries = await Promise.all(config.entries.map(reviseConfig));
+  else config = await reviseConfig(config);
 
   return config;
 }

package/src/bin/getInjectedContent.ts

@@ -0,0 +1,28 @@
+import type { ContentInjectionTarget } from "../types/ContentInjectionTarget";
+import type { Context } from "../types/Context";
+import type { Page } from "../types/Page";
+
+export function getInjectedContent(
+  ctx: Context,
+  page: Page,
+  target: ContentInjectionTarget,
+  mode: "append" | undefined = "append",
+) {
+  let injectedContent = ctx[mode]?.[target];
+
+  if (!injectedContent) return "";
+
+  return (
+    Array.isArray(injectedContent) ? injectedContent : [injectedContent]
+  ).reduce((s, item) => {
+    if (item === undefined) return s;
+
+    if (typeof item === "string") return `${s}${s ? "\n" : ""}${item}`;
+
+    let { content, pages } = item;
+
+    if (!content || (pages && !pages.includes(page))) return s;
+
+    return `${s}${s ? "\n" : ""}${content}`;
+  }, "");
+}

package/src/bin/setContent.ts

@@ -8,6 +8,7 @@ import { escapeHTML } from "../utils/escapeHTML";
 import { escapeRegExp } from "../utils/escapeRegExp";
 import { getCounterContent } from "./getCounterContent";
 import { getIcon } from "./getIcon";
+import { getInjectedContent } from "./getInjectedContent";
 import { getNav } from "./getNav";
 import { getParsedContent } from "./getParsedContent";
 import { getRepoLink } from "./getRepoLink";
@@ -65,9 +66,11 @@ export async function setContent(ctx: Context) {
   <meta name="viewport" content="width=device-width">
   <meta http-equiv="refresh" content="0; URL=${escapedRedirect}">
   ${iconTag}
+  ${getInjectedContent(ctx, "redirect", "head")}
 </head>
 <body>
 ${counterContent}
+${getInjectedContent(ctx, "redirect", "body")}
 <script>window.location.replace("${escapedRedirect}");</script>
 </body>
 </html>
@@ -112,6 +115,7 @@ ${counterContent}
   ${iconTag}
   ${nav[i + 1]?.id ? `<link rel="prefetch" href="${root}${contentDir}/${nav[i + 1]?.id}">` : ""}
   ${nav[i - 1]?.id ? `<link rel="prefetch" href="${root}${contentDir}/${nav[i - 1]?.id}">` : ""}
+  ${getInjectedContent(ctx, "section", "head")}
 </head>
 <body>
 <div class="layout">
@@ -150,6 +154,7 @@ ${
     : ""
 }
 ${counterContent}
+${getInjectedContent(ctx, "section", "body")}
 </body>
 </html>
         `),
@@ -170,6 +175,7 @@ ${counterContent}
   ${iconTag}
   <link rel="prefetch" href="${root}start">
   ${nav[0] ? `<link rel="prefetch" href="${root}${contentDir}/${nav[0]?.id ?? ""}">` : ""}
+  ${getInjectedContent(ctx, "index", "head")}
 </head>
 <body>
 <div class="layout">
@@ -217,6 +223,7 @@ ${
     : ""
 }
 ${counterContent}
+${getInjectedContent(ctx, "index", "body")}
 </body>
 </html>
             `),
@@ -234,6 +241,7 @@ ${counterContent}
   <link rel="stylesheet" href="${packageUrl}/dist/css/base.css">
   ${iconTag}
   <script>window.location.replace("${root}${contentDir}/${nav[0]?.id}");</script>
+  ${getInjectedContent(ctx, "start", "head")}
 </head>
 <body>
 <div class="layout">
@@ -241,6 +249,7 @@ ${counterContent}
 </div>
 
 ${counterContent}
+${getInjectedContent(ctx, "start", "body")}
 </body>
 </html>
             `),

package/src/bin/stripHTML.ts

@@ -0,0 +1,7 @@
+import { JSDOM } from "jsdom";
+
+export function stripHTML(content: string) {
+  try {
+    return new JSDOM(content).window.document.body.textContent;
+  } catch {}
+}

package/src/bin/toFileContent.ts

@@ -1,3 +1,3 @@
 export function toFileContent(x: string) {
-  return `${x.trim()}\n`;
+  return `${x.replace(/\s+(<\/(head|body)>)/g, "\n$1").trim()}\n`;
 }

package/src/types/ContentInjectionMap.ts

@@ -0,0 +1,14 @@
+import type { ContentInjectionTarget } from "./ContentInjectionTarget";
+import type { Page } from "./Page";
+
+type InjectedContent =
+  | string
+  | undefined
+  | {
+      content?: string | undefined;
+      pages?: Page[];
+    };
+
+export type ContentInjectionMap<T extends ContentInjectionTarget> = Partial<
+  Record<T, InjectedContent | InjectedContent[]>
+>;

package/src/types/ContentInjectionTarget.ts

@@ -0,0 +1 @@
+export type ContentInjectionTarget = "head" | "body";

package/src/types/EntryConfig.ts

@@ -1,3 +1,4 @@
+import type { ContentInjectionMap } from "./ContentInjectionMap";
 import type { Theme } from "./Theme";
 
 export type EntryConfig = {
@@ -58,4 +59,5 @@ export type EntryConfig = {
    */
   jsorg?: boolean | string;
   ymid?: number | string;
+  append?: ContentInjectionMap<"head" | "body">;
 };

package/src/types/Page.ts

@@ -0,0 +1 @@
+export type Page = "index" | "start" | "section" | "redirect";