@tobi-or-not/docpress 0.8.2 → 0.8.3

package/dist/cli.js

@@ -1,23 +1,23 @@
-import { createOption as m, createCommand as J, Command as Pe } from "commander";
-import { readFileSync as S, existsSync as O, mkdirSync as ke, writeFileSync as v, readdirSync as ue, statSync as z, appendFileSync as le, cpSync as B, rmSync as Z, renameSync as Ee } from "node:fs";
-import { resolve as u, basename as y, join as Fe, dirname as _, parse as R } from "node:path";
+import { createOption as m, createCommand as J, Command as ke } from "commander";
+import { readFileSync as S, existsSync as O, mkdirSync as Pe, writeFileSync as v, readdirSync as le, statSync as z, appendFileSync as ue, cpSync as B, rmSync as Z, renameSync as Ee } from "node:fs";
+import { resolve as l, basename as y, join as Fe, dirname as _, parse as R } from "node:path";
 import Te from "axios";
 import { rimrafSync as Oe } from "rimraf";
 import ee from "chalk";
 import { fromError as Re } from "zod-validation-error";
-import { z as l } from "zod";
+import { z as u } from "zod";
 import { Octokit as de } from "@octokit/rest";
 import { simpleGit as _e } from "simple-git";
 import { build as Ae } from "vitepress";
 import { withMermaid as Ie } from "vitepress-plugin-mermaid";
 import { readFile as je } from "node:fs/promises";
 import q from "yaml";
-const Le = "0.8.0", Ve = {
+const Le = "0.8.3", Ne = {
   version: Le
-}, C = u(process.cwd(), "docpress");
-u(process.cwd(), "docpress/repositories.json");
-u(process.cwd(), "docpress/owner.json");
-const pe = u(process.cwd(), "docpress/docs"), M = u(process.cwd(), "docpress/docs/index.md"), Ne = u(process.cwd(), "docpress/docs/forks.md"), E = u(process.cwd(), "docpress/.vitepress/config.ts"), De = u(process.cwd(), "docpress/.vitepress/theme"), Ge = u(process.cwd(), "docpress/.vitepress/theme/extras"), te = process.env.NODE_ENV === "development" ? u(import.meta.dirname, "../../public/templates/theme") : u(import.meta.dirname, "./templates/theme"), He = /\[([^\]]+)\]\(\.\.\/([^)]+)\)/g, Me = /\[([^\]]+)\]\((?!\.?\/docs\/|docs\/|http|#)(\.\/)?([^/][^)]+)\)/g, Ue = /\[([^\]]+)\]\((\.?\/docs\/|docs\/)([^)]*)\)/g, We = /^\d{2}-/;
+}, C = l(process.cwd(), "docpress");
+l(process.cwd(), "docpress/repositories.json");
+l(process.cwd(), "docpress/owner.json");
+const pe = l(process.cwd(), "docpress/docs"), M = l(process.cwd(), "docpress/docs/index.md"), Ve = l(process.cwd(), "docpress/docs/forks.md"), E = l(process.cwd(), "docpress/.vitepress/config.ts"), De = l(process.cwd(), "docpress/.vitepress/theme"), Ge = l(process.cwd(), "docpress/.vitepress/theme/extras"), te = process.env.NODE_ENV === "development" ? l(import.meta.dirname, "../../public/templates/theme") : l(import.meta.dirname, "./templates/theme"), He = /\[([^\]]+)\]\(\.\.\/([^)]+)\)/g, Me = /\[([^\]]+)\]\((?!\.?\/docs\/|docs\/|http|#)(\.\/)?([^/][^)]+)\)/g, Ue = /\[([^\]]+)\]\((\.?\/docs\/|docs\/)([^)]*)\)/g, We = /^\d{2}-/;
 async function G(e) {
   try {
     return (await Te.head(e)).status;
@@ -31,7 +31,7 @@ function f(e, t) {
 }
 function F(e, { clean: t } = { clean: !1 }) {
   try {
-    t && O(e) && Oe(`${e}/*`, { glob: !0 }), O(e) || ke(e, { recursive: !0 });
+    t && O(e) && Oe(`${e}/*`, { glob: !0 }), O(e) || Pe(e, { recursive: !0 });
   } catch (r) {
     console.error(r);
   }
@@ -51,7 +51,7 @@ function ze(e) {
   }
 }
 function A(e) {
-  return (Array.isArray(e) ? e : [e]).flatMap((t) => ze(t) ? [t] : Je(t) ? ue(t).flatMap((r) => A(Fe(t, r))) : []);
+  return (Array.isArray(e) ? e : [e]).flatMap((t) => ze(t) ? [t] : Je(t) ? le(t).flatMap((r) => A(Fe(t, r))) : []);
 }
 function fe(e) {
   return A(e).filter((t) => y(t).endsWith(".md"));
@@ -78,13 +78,13 @@ function W(e) {
   if (!e)
     return {};
   try {
-    const t = u(process.cwd(), e), r = S(t, "utf8");
+    const t = l(process.cwd(), e), r = S(t, "utf8");
     return JSON.parse(r);
   } catch {
     return {};
   }
 }
-function k(e) {
+function P(e) {
   return e.split(",");
 }
 function Xe(e, t) {
@@ -110,39 +110,39 @@ function a(e, t = "info", r) {
   const o = r ? ee[r](e) : ee[oe[t].color](e), s = t === "success" ? "info" : t;
   Qe() >= oe[t].level && console[s](o);
 }
-const se = ["github"], d = l.object({
+const se = ["github"], d = u.object({
   // Global
-  usernames: l.string().array().describe("List of comma separated Git provider usernames used to collect data."),
+  usernames: u.string().array().describe("List of comma separated Git provider usernames used to collect data."),
   // Fetch
-  branch: l.string().describe("Branch used to collect Git provider data.").default("main"),
-  gitProvider: l.enum(se).describe(`Git provider used to retrieve data. Values should be ${Be(se)}.`).default("github"),
-  reposFilter: l.string().array().describe("List of comma separated repositories to retrieve from Git provider. Default to all user's public repositories."),
+  branch: u.string().describe("Branch used to collect Git provider data.").default("main"),
+  gitProvider: u.enum(se).describe(`Git provider used to retrieve data. Values should be ${Be(se)}.`).default("github"),
+  reposFilter: u.string().array().describe("List of comma separated repositories to retrieve from Git provider. Default to all user's public repositories."),
   // Prepare
-  extraHeaderPages: l.string().array().describe("List of comma separated additional files or directories to process Vitepress header pages."),
-  extraPublicContent: l.string().array().describe("List of comma separated additional files or directories to process Vitepress public folder."),
-  extraTheme: l.string().array().describe("List of comma separated additional files or directories to use as Vitepress theme."),
-  forks: l.boolean().describe("Whether or not to create the dedicated fork page that aggregate external contributions.").default(!1),
-  vitepressConfig: l.any().describe("Path to the vitepress configuration file."),
-  websiteTitle: l.string().describe("Website title."),
-  websiteTagline: l.string().describe("Website tagline.")
+  extraHeaderPages: u.string().array().describe("List of comma separated additional files or directories to process Vitepress header pages."),
+  extraPublicContent: u.string().array().describe("List of comma separated additional files or directories to process Vitepress public folder."),
+  extraTheme: u.string().array().describe("List of comma separated additional files or directories to use as Vitepress theme."),
+  forks: u.boolean().describe("Whether or not to create the dedicated fork page that aggregate external contributions.").default(!1),
+  vitepressConfig: u.any().describe("Path to the vitepress configuration file."),
+  websiteTitle: u.string().describe("Website title."),
+  websiteTagline: u.string().describe("Website tagline.")
 }), H = d.partial().extend({
-  config: l.string().describe("Path to the docpress configuration file.").optional(),
-  token: l.string().describe("Git provider token used to collect data.").optional(),
-  usernames: l.string().describe(d.shape.usernames.description || "").optional(),
-  reposFilter: l.string().describe(d.shape.reposFilter.description || "").optional(),
-  extraHeaderPages: l.string().describe(d.shape.extraHeaderPages.description || "").optional(),
-  extraPublicContent: l.string().describe(d.shape.extraPublicContent.description || "").optional(),
-  extraTheme: l.string().describe(d.shape.extraTheme.description || "").optional(),
-  vitepressConfig: l.string().describe(d.shape.vitepressConfig.description || "").optional()
+  config: u.string().describe("Path to the docpress configuration file.").optional(),
+  token: u.string().describe("Git provider token used to collect data.").optional(),
+  usernames: u.string().describe(d.shape.usernames.description || "").optional(),
+  reposFilter: u.string().describe(d.shape.reposFilter.description || "").optional(),
+  extraHeaderPages: u.string().describe(d.shape.extraHeaderPages.description || "").optional(),
+  extraPublicContent: u.string().describe(d.shape.extraPublicContent.description || "").optional(),
+  extraTheme: u.string().describe(d.shape.extraTheme.description || "").optional(),
+  vitepressConfig: u.string().describe(d.shape.vitepressConfig.description || "").optional()
 }), I = d.partial().extend({
-  config: l.string().describe("Path to the docpress configuration file.").optional(),
-  token: l.string().describe("Git provider token used to collect data.").optional(),
-  usernames: l.string().describe(d.shape.usernames.description || "").transform(k).optional(),
-  reposFilter: l.string().describe(d.shape.reposFilter.description || "").transform(k).optional(),
-  extraHeaderPages: l.string().describe(d.shape.extraHeaderPages.description || "").transform(k).optional(),
-  extraPublicContent: l.string().describe(d.shape.extraPublicContent.description || "").transform(k).optional(),
-  extraTheme: l.string().describe(d.shape.extraTheme.description || "").transform(k).optional(),
-  vitepressConfig: l.string().describe(d.shape.vitepressConfig.description || "").optional()
+  config: u.string().describe("Path to the docpress configuration file.").optional(),
+  token: u.string().describe("Git provider token used to collect data.").optional(),
+  usernames: u.string().describe(d.shape.usernames.description || "").transform(P).optional(),
+  reposFilter: u.string().describe(d.shape.reposFilter.description || "").transform(P).optional(),
+  extraHeaderPages: u.string().describe(d.shape.extraHeaderPages.description || "").transform(P).optional(),
+  extraPublicContent: u.string().describe(d.shape.extraPublicContent.description || "").transform(P).optional(),
+  extraTheme: u.string().describe(d.shape.extraTheme.description || "").transform(P).optional(),
+  vitepressConfig: u.string().describe(d.shape.vitepressConfig.description || "").optional()
 });
 function Ze(e) {
   return e ? (e.usernames && typeof e.usernames == "string" && (e.usernames = [e.usernames]), e.reposFilter && typeof e.reposFilter == "string" && (e.reposFilter = [e.reposFilter]), e.extraHeaderPages && typeof e.extraHeaderPages == "string" && (e.extraHeaderPages = [e.extraHeaderPages]), e.extraPublicContent && typeof e.extraPublicContent == "string" && (e.extraPublicContent = [e.extraPublicContent]), e.extraTheme && typeof e.extraTheme == "string" && (e.extraTheme = [e.extraTheme]), e) : {};
@@ -292,20 +292,20 @@ async function ct({
   }
   return { source: o.source, contributors: s };
 }
-async function ut(e, t, r, o, s) {
+async function lt(e, t, r, o, s) {
   F(r, { clean: !0 });
   try {
     const i = _e({ baseDir: r });
     await i.init().addConfig("core.sparseCheckout", "true", !0, "local").addRemote("origin", t);
     for (const n of s)
-      a(`   Add '${n}' to '${e}' sparse-checkout file.`, "debug"), le(u(r, ".git/info/sparse-checkout"), `${n}
+      a(`   Add '${n}' to '${e}' sparse-checkout file.`, "debug"), ue(l(r, ".git/info/sparse-checkout"), `${n}
 `, "utf8");
-    a(`   Clone repository '${e}'.`, "info"), await i.pull("origin", o), s.some((n) => n.includes("docs")) && (B(u(r, "docs"), r, { recursive: !0 }), Z(u(r, "docs"), { recursive: !0 })), Z(u(r, ".git"), { recursive: !0 });
+    a(`   Clone repository '${e}'.`, "info"), await i.pull("origin", o), s.some((n) => n.includes("docs")) && (B(l(r, "docs"), r, { recursive: !0 }), Z(l(r, "docs"), { recursive: !0 })), Z(l(r, ".git"), { recursive: !0 });
   } catch (i) {
     a(`   Error when cloning repository: ${i}.`, "error");
   }
 }
-async function lt(e, t, r) {
+async function ut(e, t, r) {
   const o = `https://github.com/${e}/${t}/tree/${r}/README.md`, s = `https://github.com/${e}/${t}/tree/${r}/docs`, i = `https://github.com/${e}/${t}/tree/${r}/docs/01-readme.md`, n = await G(o), c = await G(s), p = await G(i);
   return {
     rootReadmeStatus: n,
@@ -320,7 +320,7 @@ async function pt(e, t, r) {
   const o = [];
   return await Promise.all(
     e.map(async (s) => {
-      const i = t ?? s.default_branch ?? "main", n = u(pe, f(s.name, { removeDot: !0 })), c = me(s, r);
+      const i = t ?? s.default_branch ?? "main", n = l(pe, f(s.name, { removeDot: !0 })), c = me(s, r);
       let p = [];
       !s.fork && !s.private && !c && (p = await ft(s, i)), o.push({
         ...s,
@@ -337,7 +337,7 @@ async function pt(e, t, r) {
   ), o;
 }
 async function ft(e, t) {
-  const r = await lt(e.owner.login, e.name, t), o = [];
+  const r = await ut(e.owner.login, e.name, t), o = [];
   return Object.values(r).every((s) => s === 404) || !e.size ? [] : (r.docsFolderStatus !== 404 && o.push("docs/*"), (r.docsFolderStatus === 404 || r.docsReadmeStatus === 404) && o.push("README.md", "!*/**/README.md"), o);
 }
 async function mt(e, t, r, o) {
@@ -352,7 +352,7 @@ async function gt(e, t) {
   }
   await Promise.all(
     e.filter((r) => !me(r, t)).map(async (r) => {
-      await ut(r.name, r.clone_url, r.docpress.projectPath, r.docpress.branch, r.docpress.includes);
+      await lt(r.name, r.clone_url, r.docpress.projectPath, r.docpress.branch, r.docpress.includes);
     })
   );
 }
@@ -462,37 +462,37 @@ function $t(e, t, r) {
 }
 async function xt({ extraHeaderPages: e, extraPublicContent: t, extraTheme: r, vitepressConfig: o, forks: s, token: i, username: n, websiteTitle: c, websiteTagline: p }) {
   const h = qe(n), b = Ke(n).reduce(({ internals: w, forks: $ }, x) => {
-    const { clone_url: P, private: Se, fork: Y, docpress: Q } = x;
-    if (P && !Se && !Q.filtered) {
+    const { clone_url: k, private: Se, fork: Y, docpress: Q } = x;
+    if (k && !Se && !Q.filtered) {
       if (!Y && Q.includes.length)
         return { internals: [...w, x], forks: $ };
       if (Y)
         return { internals: w, forks: [...$, x] };
     }
     return { internals: w, forks: $ };
-  }, { internals: [], forks: [] }), g = { title: c, tagline: p }, { index: V, sidebar: X } = Ft(b.internals, h, g);
-  let N, D;
+  }, { internals: [], forks: [] }), g = { title: c, tagline: p }, { index: N, sidebar: X } = Ft(b.internals, h, g);
+  let V, D;
   if (O(M) && O(E)) {
     const w = await _t(E), $ = await At(M);
-    N = [
+    V = [
       ...w.themeConfig?.sidebar ?? [],
       ...X
-    ].sort((x, P) => x.text.localeCompare(P.text)), D = {
-      ...V,
+    ].sort((x, k) => x.text.localeCompare(k.text)), D = {
+      ...N,
       features: [
         ...$.features,
-        ...V.features
-      ].sort((x, P) => x.title.localeCompare(P.title))
+        ...N.features
+      ].sort((x, k) => x.title.localeCompare(k.title))
     };
   } else
-    N = X, D = V;
+    V = X, D = N;
   const T = [];
   if (e) {
     const w = Tt(e);
     s ? T.push(...w.filter(($) => $.link !== "/forks")) : T.push(...w);
   }
-  t && (a("   Add extras Vitepress public folder content.", "info"), ae(t, u(C, "public"))), r && (a("   Add extras Vitepress theme files.", "info"), ae(r, u(Ge))), s && n.length && (a("   Add fork page to display external contributions.", "info"), await Rt(b.forks, n, i), T.push({ text: "Forks", link: "/forks" }));
-  const Ce = $t(N, T, o);
+  t && (a("   Add extras Vitepress public folder content.", "info"), ae(t, l(C, "public"))), r && (a("   Add extras Vitepress theme files.", "info"), ae(r, l(Ge))), s && n.length && (a("   Add fork page to display external contributions.", "info"), await Rt(b.forks, n, i), T.push({ text: "Forks", link: "/forks" }));
+  const Ce = $t(V, T, o);
   It(Ce, D);
 }
 function Ct(e, t) {
@@ -501,7 +501,7 @@ function Ct(e, t) {
 
 Take a look at the [project sources](${e}).
 `;
-  le(t, s, "utf8");
+  ue(t, s, "utf8");
 }
 function St(e, t, r) {
   const { name: o, login: s, bio: i } = t, { title: n, tagline: c } = r;
@@ -511,7 +511,7 @@ function St(e, t, r) {
     features: e
   };
 }
-function Pt(e, t, r) {
+function kt(e, t, r) {
   const o = {
     title: f(e, { mode: "capitalize", replaceDash: !0 }),
     details: t,
@@ -519,7 +519,7 @@ function Pt(e, t, r) {
   };
   return r ? [...r, o] : [o];
 }
-function kt(e, t) {
+function Pt(e, t) {
   return {
     text: f(e, { mode: "capitalize", replaceDash: !0 }),
     collapsed: !0,
@@ -528,9 +528,9 @@ function kt(e, t) {
 }
 function we(e, t) {
   return Object.entries(t).flatMap(([r, o]) => r === "$" ? Array.isArray(o) ? o.map((s) => {
-    const i = u(e.docpress.projectPath, s);
+    const i = l(e.docpress.projectPath, s);
     let n = f(y(i), { mode: "lowercase", removeIdx: !0 });
-    return n === "readme.md" && (n = "introduction.md"), n !== y(i) && Ee(i, u(_(i), n)), {
+    return n === "readme.md" && (n = "introduction.md"), n !== y(i) && Ee(i, l(_(i), n)), {
       text: R(n).name === "introduction" ? "Introduction" : f(n, { mode: "capitalize", replaceDash: !0, removeExt: !0 }),
       link: `/${f(e.name, { removeDot: !0 })}/${R(n).name}`
     };
@@ -567,12 +567,12 @@ function Ft(e, t, r) {
     a(`   Replace urls for repository '${n.name}'.`, "info"), fe([n.docpress.projectPath]).forEach((g) => {
       a(`   Processing file '${y(g)}' for repository '${n.name}'.`, "debug"), Xe(g, `https://github.com/${n.owner.login}/${n.name}/tree/${n.docpress.branch}`), y(g).toLowerCase() === "readme.md" && Ye(g, `https://github.com/${n.owner.login}/${n.name}/tree/${n.docpress.branch}`);
     }), a(`   Generate sidebar for repository '${n.name}'.`, "info");
-    const c = ue(n.docpress.projectPath, { recursive: !0 }).filter((g) => z(u(n.docpress.projectPath, g.toString())).isFile() && y(u(n.docpress.projectPath, g.toString())).endsWith(".md"));
+    const c = le(n.docpress.projectPath, { recursive: !0 }).filter((g) => z(l(n.docpress.projectPath, g.toString())).isFile() && y(l(n.docpress.projectPath, g.toString())).endsWith(".md"));
     a(`   Add sources for repository '${n.name}'.`, "info");
     let p;
-    c.length > 1 ? (p = u(n.docpress.projectPath, "sources.md"), c.push("sources.md")) : p = u(n.docpress.projectPath, c[0]), Ct(n.html_url, p);
+    c.length > 1 ? (p = l(n.docpress.projectPath, "sources.md"), c.push("sources.md")) : c.length === 1 && (p = l(n.docpress.projectPath, c[0])), p ? Ct(n.html_url, p) : a(`   No markdown files found for repository '${n.name}', skipping sources.`, "warn");
     const h = ye(c), b = Et(we(n, h));
-    s.push(kt(f(n.name, { removeDot: !0 }), b)), o.push(...Pt(f(n.name, { removeDot: !0 }), n.description || ""));
+    s.push(Pt(f(n.name, { removeDot: !0 }), b)), o.push(...kt(f(n.name, { removeDot: !0 }), n.description || ""));
   }
   a("   Generate index content.", "info");
   const i = St(o.toSorted((n, c) => n.title.localeCompare(c.title)), t, r);
@@ -586,7 +586,7 @@ function Tt(e) {
   a("   Add extras Vitepress headers pages.", "info");
   for (const o of t) {
     a(`   Processing file '${o}'.`, "debug");
-    const s = u(process.cwd(), o), i = u(pe, f(y(o), { mode: "lowercase", removeIdx: !0 }));
+    const s = l(process.cwd(), o), i = l(pe, f(y(o), { mode: "lowercase", removeIdx: !0 }));
     B(s, i), r.push({
       text: f(R(s).name, { replaceDash: !0, removeIdx: !0 }),
       link: `/${f(R(s).name, { removeIdx: !0, mode: "lowercase" })}`
@@ -596,11 +596,11 @@ function Tt(e) {
 }
 function ae(e, t, r) {
   for (const o of Array.isArray(e) ? e : [e]) {
-    const s = u(process.cwd(), o), i = A(s);
+    const s = l(process.cwd(), o), i = A(s);
     for (const n of i) {
       const c = n.replace(s, ".");
       a(`   Processing file '${c}' for entry '${o}'.`, "debug");
-      const p = u(process.cwd(), n), h = u(t, c);
+      const p = l(process.cwd(), n), h = l(t, c);
       B(p, h);
     }
   }
@@ -621,7 +621,7 @@ This page serves as both a portfolio of past work and a resource for revisiting
     const { name: c, owner: p, html_url: h, description: b, stargazers_count: g } = i;
     return { name: c, owner: p.login, html_url: h, description: b, stargazers_count: g, contributions: n };
   });
-  a("   Generate forks page.", "info"), v(Ne, t + r + q.stringify(s) + t + o);
+  a("   Generate forks page.", "info"), v(Ve, t + r + q.stringify(s) + t + o);
 }
 async function Rt(e, t, r) {
   const o = await Promise.all(
@@ -636,11 +636,11 @@ async function Rt(e, t, r) {
   Ot(o);
 }
 async function _t(e) {
-  const { config: t } = await import(u(process.cwd(), e)).catch((r) => r);
+  const { config: t } = await import(l(process.cwd(), e)).catch((r) => r);
   return t;
 }
 async function At(e) {
-  const t = (await je(u(process.cwd(), e))).toString();
+  const t = (await je(l(process.cwd(), e))).toString();
   return q.parse(t);
 }
 function It(e, t) {
@@ -651,7 +651,7 @@ function It(e, t) {
 export default config
 `), a("   Generate index file.", "info"), v(M, r + q.stringify(t)), a("   Add Docpress theme files.", "info"), A(te).forEach((o) => {
     const s = o.replace(`${te}/`, "");
-    vt(o, u(De, s));
+    vt(o, l(De, s));
   });
 }
 const ce = "prepare", $e = [
@@ -680,8 +680,8 @@ function Lt(e) {
     gitProvider: "github"
   };
 }
-function Vt() {
-  const e = new Pe().name("docpress").description("Build your doc website faster than light ⚡️⚡️⚡️").version(`${Ve.version}`).action(async (t, r) => {
+function Nt() {
+  const e = new ke().name("docpress").description("Build your doc website faster than light ⚡️⚡️⚡️").version(`${Ne.version}`).action(async (t, r) => {
     const o = Lt(t), s = K("global", o);
     await he(s), await xe(s), await be();
   }).configureHelp({
@@ -692,10 +692,10 @@ function Vt() {
   return j(e, [...ge, ...$e, ...L]), e;
 }
 function Qt() {
-  Vt().parseAsync(process.argv);
+  Nt().parseAsync(process.argv);
 }
 export {
-  Vt as getProgram,
+  Nt as getProgram,
   Qt as main
 };
 //# sourceMappingURL=cli.js.map