@xylabs/ts-scripts-yarn3 7.4.11 → 7.4.13

package/dist/actions/readme-gen.mjs

@@ -0,0 +1,173 @@
+// src/lib/yarn/workspace/yarnWorkspaces.ts
+import { spawnSync } from "child_process";
+var yarnWorkspaces = () => {
+  const result = spawnSync("yarn", ["workspaces", "list", "--json", "--recursive"], { encoding: "utf8", shell: true });
+  if (result.error) {
+    throw result.error;
+  }
+  return result.stdout.toString().split("\n").slice(0, -1).map((item) => {
+    return JSON.parse(item);
+  });
+};
+
+// src/lib/yarn/workspace/yarnWorkspace.ts
+var yarnWorkspace = (pkg) => {
+  const workspace = yarnWorkspaces().find(({ name }) => name === pkg);
+  if (!workspace) throw new Error(`Workspace ${pkg} not found`);
+  return workspace;
+};
+
+// src/lib/yarn/yarnInitCwd.ts
+var INIT_CWD = () => {
+  if (!process.env.INIT_CWD) console.error("Missing INIT_CWD");
+  return process.env.INIT_CWD;
+};
+
+// src/lib/generateReadmeFiles.ts
+import { execSync } from "child_process";
+import FS from "fs";
+import { readFile, writeFile } from "fs/promises";
+import PATH from "path";
+import chalk from "chalk";
+function fillTemplate(template, data) {
+  const additionalData = { ...data, safeName: data.name.replaceAll("/", "__").replaceAll("@", "") };
+  return template.replaceAll(/\{\{(.*?)\}\}/g, (_, key) => additionalData[key.trim()] ?? "");
+}
+function generateTypedoc(packageLocation, entryPoints) {
+  const tempDir = PATH.join(packageLocation, ".temp-typedoc");
+  try {
+    if (!FS.existsSync(tempDir)) {
+      FS.mkdirSync(tempDir, { recursive: true });
+    }
+    const typedocConfig = {
+      disableSources: true,
+      entryPointStrategy: "expand",
+      entryPoints: entryPoints.map((ep) => PATH.resolve(packageLocation, ep)),
+      excludeExternals: true,
+      excludeInternal: true,
+      excludePrivate: true,
+      githubPages: false,
+      hideBreadcrumbs: true,
+      hideGenerator: true,
+      hidePageTitle: true,
+      out: tempDir,
+      plugin: ["typedoc-plugin-markdown"],
+      readme: "none",
+      skipErrorChecking: true,
+      sort: ["source-order"],
+      theme: "markdown",
+      useCodeBlocks: true
+    };
+    const typedocJsonPath = PATH.join(tempDir, "typedoc.json");
+    FS.writeFileSync(typedocJsonPath, JSON.stringify(typedocConfig, null, 2));
+    try {
+      execSync(`npx typedoc --options ${typedocJsonPath}`, {
+        cwd: process.cwd(),
+        stdio: ["ignore", "pipe", "pipe"]
+      });
+    } catch {
+      return "";
+    }
+    return consolidateMarkdown(tempDir);
+  } catch {
+    return "";
+  } finally {
+    try {
+      FS.rmSync(tempDir, { force: true, recursive: true });
+    } catch {
+    }
+  }
+}
+function consolidateMarkdown(tempDir) {
+  let consolidated = "## Reference\n\n";
+  const mainReadmePath = PATH.join(tempDir, "README.md");
+  if (FS.existsSync(mainReadmePath)) {
+    const mainContent = FS.readFileSync(mainReadmePath, "utf8").replace(/^---(.|\n)*?---\n/, "").replace(/^# .+\n/, "").replaceAll(/\]\((.+?)\.md\)/g, "](#$1)");
+    consolidated += mainContent + "\n\n";
+  }
+  consolidated += processDirectory(tempDir);
+  return consolidated.replaceAll(/\n\n\n+/g, "\n\n").replaceAll(/^#### /gm, "### ").replaceAll(/^##### /gm, "#### ").replaceAll(/^###### /gm, "##### ");
+}
+function processDirectory(dir, level = 0) {
+  const indent = "  ".repeat(level);
+  let content = "";
+  try {
+    const items = FS.readdirSync(dir, { withFileTypes: true });
+    for (const item of items) {
+      if (item.isDirectory()) continue;
+      if (item.name === "README.md" || !item.name.endsWith(".md")) continue;
+      const fileContent = FS.readFileSync(PATH.join(dir, item.name), "utf8").replace(/^---(.|\n)*?---\n/, "");
+      const moduleName = item.name.replace(".md", "");
+      content += `
+
+${indent}### <a id="${moduleName}"></a>${moduleName}
+
+`;
+      content += fileContent.replace(/^# .+\n/, "").replaceAll(/\]\((.+?)\.md\)/g, "](#$1)");
+    }
+    for (const item of items) {
+      if (!item.isDirectory()) continue;
+      if (item.name === "spec" || item.name.includes(".spec")) continue;
+      content += `
+
+${indent}### ${item.name}
+`;
+      content += processDirectory(PATH.join(dir, item.name), level + 1);
+    }
+  } catch {
+  }
+  return content;
+}
+async function generateReadmeFiles({
+  pkg,
+  templatePath,
+  typedoc = false,
+  verbose
+}) {
+  console.log(chalk.green("Generate README Files"));
+  const cwd = INIT_CWD() ?? ".";
+  const resolvedTemplatePath = templatePath ?? PATH.join(cwd, "scripts", "README.template.md");
+  let template;
+  try {
+    template = await readFile(resolvedTemplatePath, "utf8");
+  } catch {
+    console.error(chalk.red(`Template not found: ${resolvedTemplatePath}`));
+    return 1;
+  }
+  const workspaces = pkg ? [yarnWorkspace(pkg)] : yarnWorkspaces();
+  let failed = false;
+  for (const { location, name } of workspaces) {
+    try {
+      const pkgJsonPath = PATH.join(location, "package.json");
+      const pkgJson = JSON.parse(await readFile(pkgJsonPath, "utf8"));
+      const typedocContent = typedoc ? generateTypedoc(location, ["src/index*.ts"]) : "";
+      const readmeContent = fillTemplate(template, { ...pkgJson, typedoc: typedocContent });
+      await writeFile(PATH.join(location, "README.md"), readmeContent);
+      if (verbose) console.log(chalk.green(`  ${name}`));
+    } catch (ex) {
+      const error = ex;
+      console.warn(chalk.yellow(`  Skipped ${location}: ${error.message}`));
+      failed = true;
+    }
+  }
+  return failed ? 1 : 0;
+}
+
+// src/actions/readme-gen.ts
+async function readmeGen({
+  pkg,
+  templatePath,
+  typedoc,
+  verbose
+}) {
+  return await generateReadmeFiles({
+    pkg,
+    templatePath,
+    typedoc,
+    verbose
+  });
+}
+export {
+  readmeGen
+};
+//# sourceMappingURL=readme-gen.mjs.map

package/dist/actions/readme-gen.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/yarn/workspace/yarnWorkspaces.ts","../../src/lib/yarn/workspace/yarnWorkspace.ts","../../src/lib/yarn/yarnInitCwd.ts","../../src/lib/generateReadmeFiles.ts","../../src/actions/readme-gen.ts"],"sourcesContent":["import { spawnSync } from 'node:child_process'\n\nimport type { Workspace } from './Workspace.ts'\n\nexport const yarnWorkspaces = (): Workspace[] => {\n  const result = spawnSync('yarn', ['workspaces', 'list', '--json', '--recursive'], { encoding: 'utf8', shell: true })\n  if (result.error) {\n    throw result.error\n  }\n  return (\n    result.stdout\n      .toString()\n      // NOTE: This probably doesn't work on Windows\n      // TODO: Replace /r/n with /n first\n      .split('\\n')\n      .slice(0, -1)\n      .map((item) => {\n        return JSON.parse(item)\n      })\n  )\n}\n","import type { Workspace } from './Workspace.ts'\nimport { yarnWorkspaces } from './yarnWorkspaces.ts'\n\nexport const yarnWorkspace = (pkg: string): Workspace => {\n  const workspace = yarnWorkspaces().find(({ name }) => name === pkg)\n  if (!workspace) throw new Error(`Workspace ${pkg} not found`)\n  return workspace\n}\n","export const INIT_CWD = () => {\n  if (!process.env.INIT_CWD) console.error('Missing INIT_CWD')\n  return process.env.INIT_CWD\n}\n","import { execSync } from 'node:child_process'\nimport FS from 'node:fs'\nimport { readFile, writeFile } from 'node:fs/promises'\nimport PATH from 'node:path'\n\nimport chalk from 'chalk'\n\nimport {\n  INIT_CWD, yarnWorkspace, yarnWorkspaces,\n} from './yarn/index.ts'\n\ninterface GenerateReadmeFilesParams {\n  pkg?: string\n  templatePath?: string\n  typedoc?: boolean\n  verbose?: boolean\n}\n\nfunction fillTemplate(template: string, data: Record<string, string>): string {\n  const additionalData: Record<string, string> = { ...data, safeName: data.name.replaceAll('/', '__').replaceAll('@', '') }\n  return template.replaceAll(/\\{\\{(.*?)\\}\\}/g, (_, key: string) => additionalData[key.trim()] ?? '')\n}\n\nfunction generateTypedoc(packageLocation: string, entryPoints: string[]): string {\n  const tempDir = PATH.join(packageLocation, '.temp-typedoc')\n\n  try {\n    if (!FS.existsSync(tempDir)) {\n      FS.mkdirSync(tempDir, { recursive: true })\n    }\n\n    const typedocConfig = {\n      disableSources: true,\n      entryPointStrategy: 'expand',\n      entryPoints: entryPoints.map(ep => PATH.resolve(packageLocation, ep)),\n      excludeExternals: true,\n      excludeInternal: true,\n      excludePrivate: true,\n      githubPages: false,\n      hideBreadcrumbs: true,\n      hideGenerator: true,\n      hidePageTitle: true,\n      out: tempDir,\n      plugin: ['typedoc-plugin-markdown'],\n      readme: 'none',\n      skipErrorChecking: true,\n      sort: ['source-order'],\n      theme: 'markdown',\n      useCodeBlocks: true,\n    }\n\n    const typedocJsonPath = PATH.join(tempDir, 'typedoc.json')\n    FS.writeFileSync(typedocJsonPath, JSON.stringify(typedocConfig, null, 2))\n\n    try {\n      execSync(`npx typedoc --options ${typedocJsonPath}`, {\n        cwd: process.cwd(),\n        stdio: ['ignore', 'pipe', 'pipe'],\n      })\n    } catch {\n      return ''\n    }\n\n    return consolidateMarkdown(tempDir)\n  } catch {\n    return ''\n  } finally {\n    try {\n      FS.rmSync(tempDir, { force: true, recursive: true })\n    } catch {\n      // ignore cleanup errors\n    }\n  }\n}\n\nfunction consolidateMarkdown(tempDir: string): string {\n  let consolidated = '## Reference\\n\\n'\n\n  const mainReadmePath = PATH.join(tempDir, 'README.md')\n  if (FS.existsSync(mainReadmePath)) {\n    const mainContent = FS.readFileSync(mainReadmePath, 'utf8')\n      .replace(/^---(.|\\n)*?---\\n/, '')\n      .replace(/^# .+\\n/, '')\n      .replaceAll(/\\]\\((.+?)\\.md\\)/g, '](#$1)')\n\n    consolidated += mainContent + '\\n\\n'\n  }\n\n  consolidated += processDirectory(tempDir)\n\n  return consolidated\n    .replaceAll(/\\n\\n\\n+/g, '\\n\\n')\n    .replaceAll(/^#### /gm, '### ')\n    .replaceAll(/^##### /gm, '#### ')\n    .replaceAll(/^###### /gm, '##### ')\n}\n\nfunction processDirectory(dir: string, level = 0): string {\n  const indent = '  '.repeat(level)\n  let content = ''\n\n  try {\n    const items = FS.readdirSync(dir, { withFileTypes: true })\n\n    for (const item of items) {\n      if (item.isDirectory()) continue\n      if (item.name === 'README.md' || !item.name.endsWith('.md')) continue\n\n      const fileContent = FS.readFileSync(PATH.join(dir, item.name), 'utf8')\n        .replace(/^---(.|\\n)*?---\\n/, '')\n      const moduleName = item.name.replace('.md', '')\n\n      content += `\\n\\n${indent}### <a id=\"${moduleName}\"></a>${moduleName}\\n\\n`\n      content += fileContent\n        .replace(/^# .+\\n/, '')\n        .replaceAll(/\\]\\((.+?)\\.md\\)/g, '](#$1)')\n    }\n\n    for (const item of items) {\n      if (!item.isDirectory()) continue\n      if (item.name === 'spec' || item.name.includes('.spec')) continue\n\n      content += `\\n\\n${indent}### ${item.name}\\n`\n      content += processDirectory(PATH.join(dir, item.name), level + 1)\n    }\n  } catch {\n    // skip unreadable directories\n  }\n\n  return content\n}\n\nexport async function generateReadmeFiles({\n  pkg, templatePath, typedoc = false, verbose,\n}: GenerateReadmeFilesParams): Promise<number> {\n  console.log(chalk.green('Generate README Files'))\n  const cwd = INIT_CWD() ?? '.'\n  const resolvedTemplatePath = templatePath ?? PATH.join(cwd, 'scripts', 'README.template.md')\n\n  let template: string\n  try {\n    template = await readFile(resolvedTemplatePath, 'utf8')\n  } catch {\n    console.error(chalk.red(`Template not found: ${resolvedTemplatePath}`))\n    return 1\n  }\n\n  const workspaces = pkg ? [yarnWorkspace(pkg)] : yarnWorkspaces()\n  let failed = false\n\n  for (const { location, name } of workspaces) {\n    try {\n      const pkgJsonPath = PATH.join(location, 'package.json')\n      const pkgJson = JSON.parse(await readFile(pkgJsonPath, 'utf8'))\n      const typedocContent = typedoc ? generateTypedoc(location, ['src/index*.ts']) : ''\n      const readmeContent = fillTemplate(template, { ...pkgJson, typedoc: typedocContent })\n      await writeFile(PATH.join(location, 'README.md'), readmeContent)\n      if (verbose) console.log(chalk.green(`  ${name}`))\n    } catch (ex) {\n      const error = ex as Error\n      console.warn(chalk.yellow(`  Skipped ${location}: ${error.message}`))\n      failed = true\n    }\n  }\n\n  return failed ? 1 : 0\n}\n","import { generateReadmeFiles } from '../lib/index.ts'\n\nexport interface ReadmeGenParams {\n  pkg?: string\n  templatePath?: string\n  typedoc?: boolean\n  verbose?: boolean\n}\n\nexport async function readmeGen({\n  pkg, templatePath, typedoc, verbose,\n}: ReadmeGenParams): Promise<number> {\n  return await generateReadmeFiles({\n    pkg, templatePath, typedoc, verbose,\n  })\n}\n"],"mappings":";AAAA,SAAS,iBAAiB;AAInB,IAAM,iBAAiB,MAAmB;AAC/C,QAAM,SAAS,UAAU,QAAQ,CAAC,cAAc,QAAQ,UAAU,aAAa,GAAG,EAAE,UAAU,QAAQ,OAAO,KAAK,CAAC;AACnH,MAAI,OAAO,OAAO;AAChB,UAAM,OAAO;AAAA,EACf;AACA,SACE,OAAO,OACJ,SAAS,EAGT,MAAM,IAAI,EACV,MAAM,GAAG,EAAE,EACX,IAAI,CAAC,SAAS;AACb,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB,CAAC;AAEP;;;ACjBO,IAAM,gBAAgB,CAAC,QAA2B;AACvD,QAAM,YAAY,eAAe,EAAE,KAAK,CAAC,EAAE,KAAK,MAAM,SAAS,GAAG;AAClE,MAAI,CAAC,UAAW,OAAM,IAAI,MAAM,aAAa,GAAG,YAAY;AAC5D,SAAO;AACT;;;ACPO,IAAM,WAAW,MAAM;AAC5B,MAAI,CAAC,QAAQ,IAAI,SAAU,SAAQ,MAAM,kBAAkB;AAC3D,SAAO,QAAQ,IAAI;AACrB;;;ACHA,SAAS,gBAAgB;AACzB,OAAO,QAAQ;AACf,SAAS,UAAU,iBAAiB;AACpC,OAAO,UAAU;AAEjB,OAAO,WAAW;AAalB,SAAS,aAAa,UAAkB,MAAsC;AAC5E,QAAM,iBAAyC,EAAE,GAAG,MAAM,UAAU,KAAK,KAAK,WAAW,KAAK,IAAI,EAAE,WAAW,KAAK,EAAE,EAAE;AACxH,SAAO,SAAS,WAAW,kBAAkB,CAAC,GAAG,QAAgB,eAAe,IAAI,KAAK,CAAC,KAAK,EAAE;AACnG;AAEA,SAAS,gBAAgB,iBAAyB,aAA+B;AAC/E,QAAM,UAAU,KAAK,KAAK,iBAAiB,eAAe;AAE1D,MAAI;AACF,QAAI,CAAC,GAAG,WAAW,OAAO,GAAG;AAC3B,SAAG,UAAU,SAAS,EAAE,WAAW,KAAK,CAAC;AAAA,IAC3C;AAEA,UAAM,gBAAgB;AAAA,MACpB,gBAAgB;AAAA,MAChB,oBAAoB;AAAA,MACpB,aAAa,YAAY,IAAI,QAAM,KAAK,QAAQ,iBAAiB,EAAE,CAAC;AAAA,MACpE,kBAAkB;AAAA,MAClB,iBAAiB;AAAA,MACjB,gBAAgB;AAAA,MAChB,aAAa;AAAA,MACb,iBAAiB;AAAA,MACjB,eAAe;AAAA,MACf,eAAe;AAAA,MACf,KAAK;AAAA,MACL,QAAQ,CAAC,yBAAyB;AAAA,MAClC,QAAQ;AAAA,MACR,mBAAmB;AAAA,MACnB,MAAM,CAAC,cAAc;AAAA,MACrB,OAAO;AAAA,MACP,eAAe;AAAA,IACjB;AAEA,UAAM,kBAAkB,KAAK,KAAK,SAAS,cAAc;AACzD,OAAG,cAAc,iBAAiB,KAAK,UAAU,eAAe,MAAM,CAAC,CAAC;AAExE,QAAI;AACF,eAAS,yBAAyB,eAAe,IAAI;AAAA,QACnD,KAAK,QAAQ,IAAI;AAAA,QACjB,OAAO,CAAC,UAAU,QAAQ,MAAM;AAAA,MAClC,CAAC;AAAA,IACH,QAAQ;AACN,aAAO;AAAA,IACT;AAEA,WAAO,oBAAoB,OAAO;AAAA,EACpC,QAAQ;AACN,WAAO;AAAA,EACT,UAAE;AACA,QAAI;AACF,SAAG,OAAO,SAAS,EAAE,OAAO,MAAM,WAAW,KAAK,CAAC;AAAA,IACrD,QAAQ;AAAA,IAER;AAAA,EACF;AACF;AAEA,SAAS,oBAAoB,SAAyB;AACpD,MAAI,eAAe;AAEnB,QAAM,iBAAiB,KAAK,KAAK,SAAS,WAAW;AACrD,MAAI,GAAG,WAAW,cAAc,GAAG;AACjC,UAAM,cAAc,GAAG,aAAa,gBAAgB,MAAM,EACvD,QAAQ,qBAAqB,EAAE,EAC/B,QAAQ,WAAW,EAAE,EACrB,WAAW,oBAAoB,QAAQ;AAE1C,oBAAgB,cAAc;AAAA,EAChC;AAEA,kBAAgB,iBAAiB,OAAO;AAExC,SAAO,aACJ,WAAW,YAAY,MAAM,EAC7B,WAAW,YAAY,MAAM,EAC7B,WAAW,aAAa,OAAO,EAC/B,WAAW,cAAc,QAAQ;AACtC;AAEA,SAAS,iBAAiB,KAAa,QAAQ,GAAW;AACxD,QAAM,SAAS,KAAK,OAAO,KAAK;AAChC,MAAI,UAAU;AAEd,MAAI;AACF,UAAM,QAAQ,GAAG,YAAY,KAAK,EAAE,eAAe,KAAK,CAAC;AAEzD,eAAW,QAAQ,OAAO;AACxB,UAAI,KAAK,YAAY,EAAG;AACxB,UAAI,KAAK,SAAS,eAAe,CAAC,KAAK,KAAK,SAAS,KAAK,EAAG;AAE7D,YAAM,cAAc,GAAG,aAAa,KAAK,KAAK,KAAK,KAAK,IAAI,GAAG,MAAM,EAClE,QAAQ,qBAAqB,EAAE;AAClC,YAAM,aAAa,KAAK,KAAK,QAAQ,OAAO,EAAE;AAE9C,iBAAW;AAAA;AAAA,EAAO,MAAM,cAAc,UAAU,SAAS,UAAU;AAAA;AAAA;AACnE,iBAAW,YACR,QAAQ,WAAW,EAAE,EACrB,WAAW,oBAAoB,QAAQ;AAAA,IAC5C;AAEA,eAAW,QAAQ,OAAO;AACxB,UAAI,CAAC,KAAK,YAAY,EAAG;AACzB,UAAI,KAAK,SAAS,UAAU,KAAK,KAAK,SAAS,OAAO,EAAG;AAEzD,iBAAW;AAAA;AAAA,EAAO,MAAM,OAAO,KAAK,IAAI;AAAA;AACxC,iBAAW,iBAAiB,KAAK,KAAK,KAAK,KAAK,IAAI,GAAG,QAAQ,CAAC;AAAA,IAClE;AAAA,EACF,QAAQ;AAAA,EAER;AAEA,SAAO;AACT;AAEA,eAAsB,oBAAoB;AAAA,EACxC;AAAA,EAAK;AAAA,EAAc,UAAU;AAAA,EAAO;AACtC,GAA+C;AAC7C,UAAQ,IAAI,MAAM,MAAM,uBAAuB,CAAC;AAChD,QAAM,MAAM,SAAS,KAAK;AAC1B,QAAM,uBAAuB,gBAAgB,KAAK,KAAK,KAAK,WAAW,oBAAoB;AAE3F,MAAI;AACJ,MAAI;AACF,eAAW,MAAM,SAAS,sBAAsB,MAAM;AAAA,EACxD,QAAQ;AACN,YAAQ,MAAM,MAAM,IAAI,uBAAuB,oBAAoB,EAAE,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,MAAM,CAAC,cAAc,GAAG,CAAC,IAAI,eAAe;AAC/D,MAAI,SAAS;AAEb,aAAW,EAAE,UAAU,KAAK,KAAK,YAAY;AAC3C,QAAI;AACF,YAAM,cAAc,KAAK,KAAK,UAAU,cAAc;AACtD,YAAM,UAAU,KAAK,MAAM,MAAM,SAAS,aAAa,MAAM,CAAC;AAC9D,YAAM,iBAAiB,UAAU,gBAAgB,UAAU,CAAC,eAAe,CAAC,IAAI;AAChF,YAAM,gBAAgB,aAAa,UAAU,EAAE,GAAG,SAAS,SAAS,eAAe,CAAC;AACpF,YAAM,UAAU,KAAK,KAAK,UAAU,WAAW,GAAG,aAAa;AAC/D,UAAI,QAAS,SAAQ,IAAI,MAAM,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,IACnD,SAAS,IAAI;AACX,YAAM,QAAQ;AACd,cAAQ,KAAK,MAAM,OAAO,aAAa,QAAQ,KAAK,MAAM,OAAO,EAAE,CAAC;AACpE,eAAS;AAAA,IACX;AAAA,EACF;AAEA,SAAO,SAAS,IAAI;AACtB;;;AC7JA,eAAsB,UAAU;AAAA,EAC9B;AAAA,EAAK;AAAA,EAAc;AAAA,EAAS;AAC9B,GAAqC;AACnC,SAAO,MAAM,oBAAoB;AAAA,IAC/B;AAAA,IAAK;AAAA,IAAc;AAAA,IAAS;AAAA,EAC9B,CAAC;AACH;","names":[]}