@xylabs/ts-scripts-yarn3 7.4.11 → 7.4.13

package/dist/bin/xy.mjs

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 
 // src/xy/xy.ts
-import chalk29 from "chalk";
+import chalk30 from "chalk";
 
 // src/actions/build.ts
-import chalk8 from "chalk";
+import chalk9 from "chalk";
 
 // src/lib/checkResult.ts
 import chalk from "chalk";
@@ -326,8 +326,138 @@ var generateIgnoreFiles = (filename3, pkg) => {
   return succeeded ? 0 : 1;
 };
 
-// src/lib/loadConfig.ts
+// src/lib/generateReadmeFiles.ts
+import { execSync as execSync2 } from "child_process";
+import FS from "fs";
+import { readFile, writeFile } from "fs/promises";
+import PATH2 from "path";
 import chalk5 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 = PATH2.join(packageLocation, ".temp-typedoc");
+  try {
+    if (!FS.existsSync(tempDir)) {
+      FS.mkdirSync(tempDir, { recursive: true });
+    }
+    const typedocConfig = {
+      disableSources: true,
+      entryPointStrategy: "expand",
+      entryPoints: entryPoints.map((ep) => PATH2.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 = PATH2.join(tempDir, "typedoc.json");
+    FS.writeFileSync(typedocJsonPath, JSON.stringify(typedocConfig, null, 2));
+    try {
+      execSync2(`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 = PATH2.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(PATH2.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(PATH2.join(dir, item.name), level + 1);
+    }
+  } catch {
+  }
+  return content;
+}
+async function generateReadmeFiles({
+  pkg,
+  templatePath,
+  typedoc = false,
+  verbose
+}) {
+  console.log(chalk5.green("Generate README Files"));
+  const cwd = INIT_CWD() ?? ".";
+  const resolvedTemplatePath = templatePath ?? PATH2.join(cwd, "scripts", "README.template.md");
+  let template;
+  try {
+    template = await readFile(resolvedTemplatePath, "utf8");
+  } catch {
+    console.error(chalk5.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 = PATH2.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(PATH2.join(location, "README.md"), readmeContent);
+      if (verbose) console.log(chalk5.green(`  ${name}`));
+    } catch (ex) {
+      const error = ex;
+      console.warn(chalk5.yellow(`  Skipped ${location}: ${error.message}`));
+      failed = true;
+    }
+  }
+  return failed ? 1 : 0;
+}
+
+// src/lib/loadConfig.ts
+import chalk6 from "chalk";
 import { cosmiconfig } from "cosmiconfig";
 import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
 import deepmerge from "deepmerge";
@@ -338,9 +468,9 @@ var loadConfig = async (params) => {
     config = cosmicConfigResult?.config;
     const configFilePath = cosmicConfigResult?.filepath;
     if (configFilePath !== void 0) {
-      console.log(chalk5.green(`Loaded config from ${configFilePath}`));
+      console.log(chalk6.green(`Loaded config from ${configFilePath}`));
       if (config.verbose) {
-        console.log(chalk5.gray(`${JSON.stringify(config, null, 2)}`));
+        console.log(chalk6.gray(`${JSON.stringify(config, null, 2)}`));
       }
     }
   }
@@ -358,15 +488,15 @@ var parsedPackageJSON = (path8) => {
 // src/lib/runSteps.ts
 import { spawnSync as spawnSync3 } from "child_process";
 import { existsSync as existsSync2 } from "fs";
-import chalk6 from "chalk";
+import chalk7 from "chalk";
 var runSteps = (name, steps, exitOnFail = true, messages) => {
   return safeExit(() => {
     const pkgName = process.env.npm_package_name;
-    console.log(chalk6.green(`${name} [${pkgName}]`));
+    console.log(chalk7.green(`${name} [${pkgName}]`));
     let totalStatus = 0;
     for (const [i, [command, args, config2]] of steps.entries()) {
       if (messages?.[i]) {
-        console.log(chalk6.gray(messages?.[i]));
+        console.log(chalk7.gray(messages?.[i]));
       }
       const argList = Array.isArray(args) ? args : args.split(" ");
       if (command === "node" && !existsSync2(argList[0])) {
@@ -389,12 +519,12 @@ var runSteps = (name, steps, exitOnFail = true, messages) => {
 // src/lib/runStepsAsync.ts
 import { spawn } from "child_process";
 import { existsSync as existsSync3 } from "fs";
-import chalk7 from "chalk";
+import chalk8 from "chalk";
 var runStepAsync = (name, step, exitOnFail = true, message) => {
   return new Promise((resolve) => {
     const [command, args, config2] = step;
     if (message) {
-      console.log(chalk7.gray(message));
+      console.log(chalk8.gray(message));
     }
     const argList = Array.isArray(args) ? args : args.split(" ");
     if (command === "node" && !existsSync3(argList[0])) {
@@ -408,8 +538,8 @@ var runStepAsync = (name, step, exitOnFail = true, message) => {
     }).on("close", (code) => {
       if (code) {
         console.error(
-          chalk7.red(
-            `Command Exited With Non-Zero Result [${chalk7.gray(code)}] | ${chalk7.yellow(command)} ${chalk7.white(
+          chalk8.red(
+            `Command Exited With Non-Zero Result [${chalk8.gray(code)}] | ${chalk8.yellow(command)} ${chalk8.white(
               Array.isArray(args) ? args.join(" ") : args
             )}`
           )
@@ -425,7 +555,7 @@ var runStepAsync = (name, step, exitOnFail = true, message) => {
 var runStepsAsync = async (name, steps, exitOnFail = true, messages) => {
   return await safeExitAsync(async () => {
     const pkgName = process.env.npm_package_name;
-    console.log(chalk7.green(`${name} [${pkgName}]`));
+    console.log(chalk8.green(`${name} [${pkgName}]`));
     let result = 0;
     for (const [i, step] of steps.entries()) {
       result += await runStepAsync(name, step, exitOnFail, messages?.[i]);
@@ -449,7 +579,7 @@ var build = async ({
   const targetOptions = target === void 0 ? [] : ["-t", target];
   const jobsOptions = jobs === void 0 ? [] : ["-j", `${jobs}`];
   if (jobs !== void 0) {
-    console.log(chalk8.blue(`Jobs set to [${jobs}]`));
+    console.log(chalk9.blue(`Jobs set to [${jobs}]`));
   }
   const result = await runStepsAsync(`Build${incremental ? "-Incremental" : ""} [${pkg ?? "All"}]`, [
     ["yarn", ["xy", "compile", ...pkgOptions, ...targetOptions, ...verboseOptions, ...jobsOptions, ...incrementalOptions, "--types", "tsup"]],
@@ -457,7 +587,7 @@ var build = async ({
     ["yarn", ["xy", "deplint", ...pkgOptions, ...verboseOptions, ...jobsOptions, ...incrementalOptions]],
     ["yarn", ["xy", "lint", ...pkgOptions, ...verboseOptions, ...incrementalOptions]]
   ]);
-  console.log(`${chalk8.gray("Built in")} [${chalk8.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk8.gray("seconds")}`);
+  console.log(`${chalk9.gray("Built in")} [${chalk9.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk9.gray("seconds")}`);
   return result;
 };
 
@@ -470,15 +600,15 @@ import {
   unlinkSync,
   writeFileSync as writeFileSync2
 } from "fs";
-import PATH2 from "path";
-import chalk9 from "chalk";
+import PATH3 from "path";
+import chalk10 from "chalk";
 var syncCommandFiles = (commandsDir) => {
   const templates = claudeCommandTemplates();
   const templateNames = new Set(Object.keys(templates));
   let updated = 0;
   let created = 0;
   for (const [filename3, content] of Object.entries(templates)) {
-    const targetPath = PATH2.resolve(commandsDir, filename3);
+    const targetPath = PATH3.resolve(commandsDir, filename3);
     const existing = existsSync4(targetPath) ? readFileSync4(targetPath, "utf8") : void 0;
     if (existing === content) continue;
     writeFileSync2(targetPath, content, "utf8");
@@ -499,7 +629,7 @@ var removeStaleCommands = (commandsDir, templateNames) => {
   let removed = 0;
   for (const file of existingCommands) {
     if (!templateNames.has(file)) {
-      unlinkSync(PATH2.resolve(commandsDir, file));
+      unlinkSync(PATH3.resolve(commandsDir, file));
       removed++;
     }
   }
@@ -512,14 +642,14 @@ var logCommandsResult = (created, updated, removed) => {
       updated ? `${updated} updated` : "",
       removed ? `${removed} removed` : ""
     ].filter(Boolean);
-    console.log(chalk9.green(`.claude/commands/${XYLABS_COMMANDS_PREFIX}*.md: ${parts.join(", ")}`));
+    console.log(chalk10.green(`.claude/commands/${XYLABS_COMMANDS_PREFIX}*.md: ${parts.join(", ")}`));
   } else {
-    console.log(chalk9.gray(`.claude/commands/${XYLABS_COMMANDS_PREFIX}*.md: already up to date`));
+    console.log(chalk10.gray(`.claude/commands/${XYLABS_COMMANDS_PREFIX}*.md: already up to date`));
   }
 };
 var claudeCommands = () => {
   const cwd = INIT_CWD() ?? process.cwd();
-  const commandsDir = PATH2.resolve(cwd, ".claude", "commands");
+  const commandsDir = PATH3.resolve(cwd, ".claude", "commands");
   mkdirSync(commandsDir, { recursive: true });
   const {
     created,
@@ -540,15 +670,15 @@ import {
   unlinkSync as unlinkSync2,
   writeFileSync as writeFileSync3
 } from "fs";
-import PATH3 from "path";
-import chalk10 from "chalk";
+import PATH4 from "path";
+import chalk11 from "chalk";
 var syncRuleFiles = (rulesDir) => {
   const templates = claudeMdRuleTemplates();
   const templateNames = new Set(Object.keys(templates));
   let updated = 0;
   let created = 0;
   for (const [filename3, content] of Object.entries(templates)) {
-    const targetPath = PATH3.resolve(rulesDir, filename3);
+    const targetPath = PATH4.resolve(rulesDir, filename3);
     const existing = existsSync5(targetPath) ? readFileSync5(targetPath, "utf8") : void 0;
     if (existing === content) continue;
     writeFileSync3(targetPath, content, "utf8");
@@ -569,7 +699,7 @@ var removeStaleRules = (rulesDir, templateNames) => {
   let removed = 0;
   for (const file of existingRules) {
     if (!templateNames.has(file)) {
-      unlinkSync2(PATH3.resolve(rulesDir, file));
+      unlinkSync2(PATH4.resolve(rulesDir, file));
       removed++;
     }
   }
@@ -582,26 +712,26 @@ var logRulesResult = (created, updated, removed) => {
       updated ? `${updated} updated` : "",
       removed ? `${removed} removed` : ""
     ].filter(Boolean);
-    console.log(chalk10.green(`.claude/rules/${XYLABS_RULES_PREFIX}*.md: ${parts.join(", ")}`));
+    console.log(chalk11.green(`.claude/rules/${XYLABS_RULES_PREFIX}*.md: ${parts.join(", ")}`));
   } else {
-    console.log(chalk10.gray(`.claude/rules/${XYLABS_RULES_PREFIX}*.md: already up to date`));
+    console.log(chalk11.gray(`.claude/rules/${XYLABS_RULES_PREFIX}*.md: already up to date`));
   }
 };
 var ensureProjectClaudeMd = (cwd, force) => {
-  const projectPath = PATH3.resolve(cwd, "CLAUDE.md");
+  const projectPath = PATH4.resolve(cwd, "CLAUDE.md");
   if (!existsSync5(projectPath) || force) {
     if (force && existsSync5(projectPath)) {
-      console.log(chalk10.yellow("Overwriting existing CLAUDE.md"));
+      console.log(chalk11.yellow("Overwriting existing CLAUDE.md"));
     }
     writeFileSync3(projectPath, claudeMdProjectTemplate(), "utf8");
-    console.log(chalk10.green("Generated CLAUDE.md"));
+    console.log(chalk11.green("Generated CLAUDE.md"));
   } else {
-    console.log(chalk10.gray("CLAUDE.md already exists (skipped)"));
+    console.log(chalk11.gray("CLAUDE.md already exists (skipped)"));
   }
 };
 var claudeRules = ({ force } = {}) => {
   const cwd = INIT_CWD() ?? process.cwd();
-  const rulesDir = PATH3.resolve(cwd, ".claude", "rules");
+  const rulesDir = PATH4.resolve(cwd, ".claude", "rules");
   mkdirSync2(rulesDir, { recursive: true });
   const {
     created,
@@ -628,16 +758,16 @@ var cleanAll = ({ verbose }) => {
 
 // src/actions/clean-docs.ts
 import path from "path";
-import chalk11 from "chalk";
+import chalk12 from "chalk";
 var cleanDocs = () => {
   const pkgName = process.env.npm_package_name;
-  console.log(chalk11.green(`Cleaning Docs [${pkgName}]`));
+  console.log(chalk12.green(`Cleaning Docs [${pkgName}]`));
   for (const { location } of yarnWorkspaces()) deleteGlob(path.join(location, "docs"));
   return 0;
 };
 
 // src/actions/compile.ts
-import chalk12 from "chalk";
+import chalk13 from "chalk";
 var compile = ({
   verbose,
   target,
@@ -678,7 +808,7 @@ var compileAll = ({
   const incrementalOptions = incremental ? ["--since", "-Ap", "--topological-dev"] : ["--parallel", "-Ap", "--topological-dev"];
   const jobsOptions = jobs ? ["-j", `${jobs}`] : [];
   if (jobs) {
-    console.log(chalk12.blue(`Jobs set to [${jobs}]`));
+    console.log(chalk13.blue(`Jobs set to [${jobs}]`));
   }
   const result = runSteps(`Compile${incremental ? "-Incremental" : ""} [All]`, [
     ["yarn", [
@@ -692,13 +822,13 @@ var compileAll = ({
       ...targetOptions
     ]]
   ]);
-  console.log(`${chalk12.gray("Compiled in")} [${chalk12.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk12.gray("seconds")}`);
+  console.log(`${chalk13.gray("Compiled in")} [${chalk13.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk13.gray("seconds")}`);
   return result;
 };
 
 // src/actions/copy-assets.ts
 import path2 from "path/posix";
-import chalk13 from "chalk";
+import chalk14 from "chalk";
 import cpy from "cpy";
 var copyPackageTargetAssets = async (target, name, location) => {
   try {
@@ -721,7 +851,7 @@ var copyPackageTargetAssets = async (target, name, location) => {
 };
 var copyTargetAssets = async (target, pkg) => {
   const workspaces = yarnWorkspaces();
-  console.log(chalk13.green(`Copying Assets [${target.toUpperCase()}]`));
+  console.log(chalk14.green(`Copying Assets [${target.toUpperCase()}]`));
   const workspaceList = workspaces.filter(({ name }) => {
     return pkg === void 0 || name === pkg;
   });
@@ -805,7 +935,7 @@ var dead = () => {
 };
 
 // src/actions/deplint/deplint.ts
-import chalk19 from "chalk";
+import chalk20 from "chalk";
 
 // src/actions/deplint/findFiles.ts
 import fs2 from "fs";
@@ -1007,37 +1137,44 @@ function getExternalImportsFromFiles({
 
 // src/actions/deplint/checkPackage/getUnlistedDependencies.ts
 import { builtinModules } from "module";
-import chalk14 from "chalk";
-function isListedOrBuiltin(imp, name, dependencies, peerDependencies) {
-  return dependencies.includes(imp) || imp === name || dependencies.includes(`@types/${imp}`) || peerDependencies.includes(imp) || peerDependencies.includes(`@types/${imp}`) || builtinModules.includes(imp) || builtinModules.includes(`@types/${imp}`);
+import chalk15 from "chalk";
+function isRuntimeImportListed(imp, name, dependencies, peerDependencies) {
+  return dependencies.includes(imp) || imp === name || peerDependencies.includes(imp) || builtinModules.includes(imp);
+}
+function isTypeImportListed(imp, name, dependencies, devDependencies, peerDependencies) {
+  return dependencies.includes(imp) || imp === name || dependencies.includes(`@types/${imp}`) || peerDependencies.includes(imp) || peerDependencies.includes(`@types/${imp}`) || devDependencies.includes(`@types/${imp}`) || builtinModules.includes(imp);
 }
 function logMissing(name, imp, importPaths) {
-  console.log(`[${chalk14.blue(name)}] Missing dependency in package.json: ${chalk14.red(imp)}`);
+  console.log(`[${chalk15.blue(name)}] Missing dependency in package.json: ${chalk15.red(imp)}`);
   if (importPaths[imp]) {
     console.log(`  ${importPaths[imp].join("\n ")}`);
   }
 }
-function getUnlistedDependencies({ name, location }, { dependencies, peerDependencies }, {
+function getUnlistedDependencies({ name, location }, {
+  dependencies,
+  devDependencies,
+  peerDependencies
+}, {
   externalDistImports,
   externalDistTypeImports,
   distImportPaths
 }) {
   let unlistedDependencies = 0;
   for (const imp of externalDistImports) {
-    if (!isListedOrBuiltin(imp, name, dependencies, peerDependencies)) {
+    if (!isRuntimeImportListed(imp, name, dependencies, peerDependencies)) {
       unlistedDependencies++;
       logMissing(name, imp, distImportPaths);
     }
   }
   for (const imp of externalDistTypeImports) {
-    if (!isListedOrBuiltin(imp, name, dependencies, peerDependencies)) {
+    if (!isTypeImportListed(imp, name, dependencies, devDependencies, peerDependencies)) {
       unlistedDependencies++;
       logMissing(name, imp, distImportPaths);
     }
   }
   if (unlistedDependencies > 0) {
     const packageLocation = `${location}/package.json`;
-    console.log(`  ${chalk14.yellow(packageLocation)}
+    console.log(`  ${chalk15.yellow(packageLocation)}
 `);
   }
   return unlistedDependencies;
@@ -1045,7 +1182,7 @@ function getUnlistedDependencies({ name, location }, { dependencies, peerDepende
 
 // src/actions/deplint/checkPackage/getUnlistedDevDependencies.ts
 import { builtinModules as builtinModules2 } from "module";
-import chalk15 from "chalk";
+import chalk16 from "chalk";
 function getUnlistedDevDependencies({ name, location }, {
   devDependencies,
   dependencies,
@@ -1059,7 +1196,7 @@ function getUnlistedDevDependencies({ name, location }, {
   for (const imp of externalAllImports) {
     if (!distImports.includes(imp) && imp !== name && !dependencies.includes(imp) && !dependencies.includes(`@types/${imp}`) && !peerDependencies.includes(imp) && !peerDependencies.includes(`@types/${imp}`) && !devDependencies.includes(imp) && !devDependencies.includes(`@types/${imp}`) && !builtinModules2.includes(imp)) {
       unlistedDevDependencies++;
-      console.log(`[${chalk15.blue(name)}] Missing devDependency in package.json: ${chalk15.red(imp)}`);
+      console.log(`[${chalk16.blue(name)}] Missing devDependency in package.json: ${chalk16.red(imp)}`);
       if (allImportPaths[imp]) {
         console.log(`  ${allImportPaths[imp].join("\n ")}`);
       }
@@ -1067,14 +1204,14 @@ function getUnlistedDevDependencies({ name, location }, {
   }
   if (unlistedDevDependencies > 0) {
     const packageLocation = `${location}/package.json`;
-    console.log(`  ${chalk15.yellow(packageLocation)}
+    console.log(`  ${chalk16.yellow(packageLocation)}
 `);
   }
   return unlistedDevDependencies;
 }
 
 // src/actions/deplint/checkPackage/getUnusedDependencies.ts
-import chalk16 from "chalk";
+import chalk17 from "chalk";
 function getUnusedDependencies({ name, location }, { dependencies }, {
   externalDistImports,
   externalDistTypeImports,
@@ -1086,22 +1223,22 @@ function getUnusedDependencies({ name, location }, { dependencies }, {
     if (!externalDistImports.includes(dep) && !externalDistImports.includes(dep.replace(/^@types\//, "")) && !externalDistTypeImports.includes(dep) && !externalDistTypeImports.includes(dep.replace(/^@types\//, ""))) {
       unusedDependencies++;
       if (externalAllImports.includes(dep)) {
-        console.log(`[${chalk16.blue(name)}] dependency should be devDependency in package.json: ${chalk16.red(dep)}`);
+        console.log(`[${chalk17.blue(name)}] dependency should be devDependency in package.json: ${chalk17.red(dep)}`);
       } else {
-        console.log(`[${chalk16.blue(name)}] Unused dependency in package.json: ${chalk16.red(dep)}`);
+        console.log(`[${chalk17.blue(name)}] Unused dependency in package.json: ${chalk17.red(dep)}`);
       }
     }
   }
   if (unusedDependencies > 0) {
     const packageLocation = `${location}/package.json`;
-    console.log(`  ${chalk16.yellow(packageLocation)}
+    console.log(`  ${chalk17.yellow(packageLocation)}
 `);
   }
   return unusedDependencies;
 }
 
 // src/actions/deplint/checkPackage/getUnusedDevDependencies.ts
-import chalk17 from "chalk";
+import chalk18 from "chalk";
 
 // src/actions/deplint/getCliReferencedPackagesFromFiles.ts
 import fs8 from "fs";
@@ -1385,19 +1522,19 @@ function getUnusedDevDependencies({ name, location }, {
     if (dependencies.includes(dep) || peerDependencies.includes(dep)) continue;
     if (!isDevDepUsed(dep, allImports, implicitDeps, requiredPeers, scriptRefs, cliRefs)) {
       unusedDevDependencies++;
-      console.log(`[${chalk17.blue(name)}] Unused devDependency in package.json: ${chalk17.red(dep)}`);
+      console.log(`[${chalk18.blue(name)}] Unused devDependency in package.json: ${chalk18.red(dep)}`);
     }
   }
   if (unusedDevDependencies > 0) {
     const packageLocation = `${location}/package.json`;
-    console.log(`  ${chalk17.yellow(packageLocation)}
+    console.log(`  ${chalk18.yellow(packageLocation)}
 `);
   }
   return unusedDevDependencies;
 }
 
 // src/actions/deplint/checkPackage/getUnusedPeerDependencies.ts
-import chalk18 from "chalk";
+import chalk19 from "chalk";
 function getUnusedPeerDependencies({ name, location }, { peerDependencies, dependencies }, { externalDistImports, externalDistTypeImports }, exclude) {
   let unusedDependencies = 0;
   for (const dep of peerDependencies) {
@@ -1405,15 +1542,15 @@ function getUnusedPeerDependencies({ name, location }, { peerDependencies, depen
     if (!externalDistImports.includes(dep) && !externalDistImports.includes(dep.replace(/^@types\//, "")) && !externalDistTypeImports.includes(dep) && !externalDistTypeImports.includes(dep.replace(/^@types\//, ""))) {
       unusedDependencies++;
       if (dependencies.includes(dep)) {
-        console.log(`[${chalk18.blue(name)}] Unused peerDependency [already a dependency] in package.json: ${chalk18.red(dep)}`);
+        console.log(`[${chalk19.blue(name)}] Unused peerDependency [already a dependency] in package.json: ${chalk19.red(dep)}`);
       } else {
-        console.log(`[${chalk18.blue(name)}] Unused peerDependency in package.json: ${chalk18.red(dep)}`);
+        console.log(`[${chalk19.blue(name)}] Unused peerDependency in package.json: ${chalk19.red(dep)}`);
       }
     }
   }
   if (unusedDependencies > 0) {
     const packageLocation = `${location}/package.json`;
-    console.log(`  ${chalk18.yellow(packageLocation)}
+    console.log(`  ${chalk19.yellow(packageLocation)}
 `);
   }
   return unusedDependencies;
@@ -1508,9 +1645,9 @@ var deplint = async ({
     });
   }
   if (totalErrors > 0) {
-    console.warn(`Deplint: Found ${chalk19.red(totalErrors)} dependency problems. ${chalk19.red("\u2716")}`);
+    console.warn(`Deplint: Found ${chalk20.red(totalErrors)} dependency problems. ${chalk20.red("\u2716")}`);
   } else {
-    console.info(`Deplint: Found no dependency problems. ${chalk19.green("\u2714")}`);
+    console.info(`Deplint: Found no dependency problems. ${chalk20.green("\u2714")}`);
   }
   return 0;
 };
@@ -1612,22 +1749,22 @@ var deployNext = () => {
 };
 
 // src/actions/dupdeps.ts
-import chalk20 from "chalk";
+import chalk21 from "chalk";
 var dupdeps = () => {
-  console.log(chalk20.green("Checking all Dependencies for Duplicates"));
+  console.log(chalk21.green("Checking all Dependencies for Duplicates"));
   const allDependencies = parsedPackageJSON()?.dependencies;
   const dependencies = Object.entries(allDependencies).map(([k]) => k);
   return detectDuplicateDependencies(dependencies);
 };
 
 // src/actions/lint.ts
-import chalk21 from "chalk";
+import chalk22 from "chalk";
 var lintPackage = ({
   pkg,
   fix: fix2,
   verbose
 }) => {
-  console.log(chalk21.gray(`${fix2 ? "Fix" : "Lint"} [${pkg}]`));
+  console.log(chalk22.gray(`${fix2 ? "Fix" : "Lint"} [${pkg}]`));
   const start = Date.now();
   const result = runSteps(`${fix2 ? "Fix" : "Lint"}  [${pkg}]`, [
     ["yarn", [
@@ -1637,7 +1774,7 @@ var lintPackage = ({
       fix2 ? "package-fix" : verbose ? "package-lint-verbose" : "package-lint"
     ]]
   ]);
-  console.log(chalk21.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk21.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk21.gray("seconds")}`));
+  console.log(chalk22.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk22.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk22.gray("seconds")}`));
   return result;
 };
 var lint = ({
@@ -1657,13 +1794,13 @@ var lint = ({
   });
 };
 var lintAllPackages = ({ fix: fix2 = false } = {}) => {
-  console.log(chalk21.gray(`${fix2 ? "Fix" : "Lint"} [All-Packages]`));
+  console.log(chalk22.gray(`${fix2 ? "Fix" : "Lint"} [All-Packages]`));
   const start = Date.now();
   const fixOptions = fix2 ? ["--fix"] : [];
   const result = runSteps(`${fix2 ? "Fix" : "Lint"}  [All-Packages]`, [
     ["yarn", ["eslint", "--cache", "--cache-location", ".eslintcache", "--cache-strategy", "content", ...fixOptions]]
   ]);
-  console.log(chalk21.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk21.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk21.gray("seconds")}`));
+  console.log(chalk22.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk22.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk22.gray("seconds")}`));
   return result;
 };
 
@@ -1691,7 +1828,7 @@ var filename = ".gitignore";
 var gitignoreGen = (pkg) => generateIgnoreFiles(filename, pkg);
 
 // src/actions/gitlint.ts
-import chalk22 from "chalk";
+import chalk23 from "chalk";
 import ParseGitConfig from "parse-git-config";
 var gitlint = () => {
   console.log(`
@@ -1702,7 +1839,7 @@ Gitlint Start [${process.cwd()}]
   const errors = 0;
   const gitConfig = ParseGitConfig.sync();
   const warn = (message) => {
-    console.warn(chalk22.yellow(`Warning: ${message}`));
+    console.warn(chalk23.yellow(`Warning: ${message}`));
     warnings++;
   };
   if (gitConfig.core.ignorecase) {
@@ -1722,13 +1859,13 @@ Gitlint Start [${process.cwd()}]
   }
   const resultMessages = [];
   if (valid > 0) {
-    resultMessages.push(chalk22.green(`Passed: ${valid}`));
+    resultMessages.push(chalk23.green(`Passed: ${valid}`));
   }
   if (warnings > 0) {
-    resultMessages.push(chalk22.yellow(`Warnings: ${warnings}`));
+    resultMessages.push(chalk23.yellow(`Warnings: ${warnings}`));
   }
   if (errors > 0) {
-    resultMessages.push(chalk22.red(` Errors: ${errors}`));
+    resultMessages.push(chalk23.red(` Errors: ${errors}`));
   }
   console.warn(`Gitlint Finish [ ${resultMessages.join(" | ")} ]
 `);
@@ -1736,8 +1873,8 @@ Gitlint Start [${process.cwd()}]
 };
 
 // src/actions/gitlint-fix.ts
-import { execSync as execSync2 } from "child_process";
-import chalk23 from "chalk";
+import { execSync as execSync3 } from "child_process";
+import chalk24 from "chalk";
 import ParseGitConfig2 from "parse-git-config";
 var gitlintFix = () => {
   console.log(`
@@ -1745,16 +1882,16 @@ Gitlint Fix Start [${process.cwd()}]
 `);
   const gitConfig = ParseGitConfig2.sync();
   if (gitConfig.core.ignorecase) {
-    execSync2("git config core.ignorecase false", { stdio: "inherit" });
-    console.warn(chalk23.yellow("\nGitlint Fix: Updated core.ignorecase to be false\n"));
+    execSync3("git config core.ignorecase false", { stdio: "inherit" });
+    console.warn(chalk24.yellow("\nGitlint Fix: Updated core.ignorecase to be false\n"));
   }
   if (gitConfig.core.autocrlf !== false) {
-    execSync2("git config core.autocrlf false", { stdio: "inherit" });
-    console.warn(chalk23.yellow("\nGitlint Fix: Updated core.autocrlf to be false\n"));
+    execSync3("git config core.autocrlf false", { stdio: "inherit" });
+    console.warn(chalk24.yellow("\nGitlint Fix: Updated core.autocrlf to be false\n"));
   }
   if (gitConfig.core.eol !== "lf") {
-    execSync2("git config core.eol lf", { stdio: "inherit" });
-    console.warn(chalk23.yellow('\nGitlint Fix: Updated core.eol to be "lf"\n'));
+    execSync3("git config core.eol lf", { stdio: "inherit" });
+    console.warn(chalk24.yellow('\nGitlint Fix: Updated core.eol to be "lf"\n'));
   }
   return 1;
 };
@@ -1765,7 +1902,7 @@ var knip = () => {
 };
 
 // src/actions/license.ts
-import chalk24 from "chalk";
+import chalk25 from "chalk";
 import { init } from "license-checker";
 var license = async (pkg) => {
   const workspaces = yarnWorkspaces();
@@ -1790,18 +1927,18 @@ var license = async (pkg) => {
     "LGPL-3.0-or-later",
     "Python-2.0"
   ]);
-  console.log(chalk24.green("License Checker"));
+  console.log(chalk25.green("License Checker"));
   return (await Promise.all(
     workspaceList.map(({ location, name }) => {
       return new Promise((resolve) => {
         init({ production: true, start: location }, (error, packages) => {
           if (error) {
-            console.error(chalk24.red(`License Checker [${name}] Error`));
-            console.error(chalk24.gray(error));
+            console.error(chalk25.red(`License Checker [${name}] Error`));
+            console.error(chalk25.gray(error));
             console.log("\n");
             resolve(1);
           } else {
-            console.log(chalk24.green(`License Checker [${name}]`));
+            console.log(chalk25.green(`License Checker [${name}]`));
             let count = 0;
             for (const [name2, info] of Object.entries(packages)) {
               const licenses = Array.isArray(info.licenses) ? info.licenses : [info.licenses];
@@ -1817,7 +1954,7 @@ var license = async (pkg) => {
                   }
                   if (!orLicenseFound) {
                     count++;
-                    console.warn(chalk24.yellow(`${name2}: Package License not allowed [${license2}]`));
+                    console.warn(chalk25.yellow(`${name2}: Package License not allowed [${license2}]`));
                   }
                 }
               }
@@ -1852,6 +1989,21 @@ var publish = () => {
   return runSteps("Publish", [["npm", ["publish", "--workspaces"]]]);
 };
 
+// src/actions/readme-gen.ts
+async function readmeGen({
+  pkg,
+  templatePath,
+  typedoc,
+  verbose
+}) {
+  return await generateReadmeFiles({
+    pkg,
+    templatePath,
+    typedoc,
+    verbose
+  });
+}
+
 // src/actions/rebuild.ts
 var rebuild = ({ target }) => {
   return runSteps("Rebuild", [
@@ -1861,7 +2013,7 @@ var rebuild = ({ target }) => {
 };
 
 // src/actions/recompile.ts
-import chalk25 from "chalk";
+import chalk26 from "chalk";
 var recompile = async ({
   verbose,
   target,
@@ -1897,7 +2049,7 @@ var recompileAll = async ({
   const incrementalOptions = incremental ? ["--since", "-Apt", "--topological-dev"] : ["--parallel", "-Apt", "--topological-dev"];
   const jobsOptions = jobs ? ["-j", `${jobs}`] : [];
   if (jobs) {
-    console.log(chalk25.blue(`Jobs set to [${jobs}]`));
+    console.log(chalk26.blue(`Jobs set to [${jobs}]`));
   }
   const result = await runStepsAsync(`Recompile${incremental ? "-Incremental" : ""} [All]`, [
     [
@@ -1928,7 +2080,7 @@ var recompileAll = async ({
     ]
   ]);
   console.log(
-    `${chalk25.gray("Recompiled in")} [${chalk25.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk25.gray("seconds")}`
+    `${chalk26.gray("Recompiled in")} [${chalk26.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk26.gray("seconds")}`
   );
   return result;
 };
@@ -1959,13 +2111,13 @@ var reinstall = () => {
 };
 
 // src/actions/relint.ts
-import chalk26 from "chalk";
+import chalk27 from "chalk";
 var relintPackage = ({
   pkg,
   fix: fix2,
   verbose
 }) => {
-  console.log(chalk26.gray(`${fix2 ? "Fix" : "Lint"} [${pkg}]`));
+  console.log(chalk27.gray(`${fix2 ? "Fix" : "Lint"} [${pkg}]`));
   const start = Date.now();
   const result = runSteps(`${fix2 ? "Fix" : "Lint"}  [${pkg}]`, [
     ["yarn", [
@@ -1975,7 +2127,7 @@ var relintPackage = ({
       fix2 ? "package-fix" : verbose ? "package-lint-verbose" : "package-lint"
     ]]
   ]);
-  console.log(chalk26.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk26.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk26.gray("seconds")}`));
+  console.log(chalk27.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk27.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk27.gray("seconds")}`));
   return result;
 };
 var relint = ({
@@ -1995,13 +2147,13 @@ var relint = ({
   });
 };
 var relintAllPackages = ({ fix: fix2 = false } = {}) => {
-  console.log(chalk26.gray(`${fix2 ? "Fix" : "Lint"} [All-Packages]`));
+  console.log(chalk27.gray(`${fix2 ? "Fix" : "Lint"} [All-Packages]`));
   const start = Date.now();
   const fixOptions = fix2 ? ["--fix"] : [];
   const result = runSteps(`${fix2 ? "Fix" : "Lint"}  [All-Packages]`, [
     ["yarn", ["eslint", ...fixOptions]]
   ]);
-  console.log(chalk26.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk26.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk26.gray("seconds")}`));
+  console.log(chalk27.gray(`${fix2 ? "Fixed in" : "Linted in"} [${chalk27.magenta(((Date.now() - start) / 1e3).toFixed(2))}] ${chalk27.gray("seconds")}`));
   return result;
 };
 
@@ -2019,10 +2171,10 @@ var sonar = () => {
 };
 
 // src/actions/statics.ts
-import chalk27 from "chalk";
+import chalk28 from "chalk";
 var DefaultDependencies = ["axios", "@xylabs/pixel", "react", "graphql", "react-router", "@mui/material", "@mui/system"];
 var statics = () => {
-  console.log(chalk27.green("Check Required Static Dependencies"));
+  console.log(chalk28.green("Check Required Static Dependencies"));
   const statics2 = parsedPackageJSON()?.xy?.deps?.statics;
   return detectDuplicateDependencies(statics2, DefaultDependencies);
 };
@@ -2266,6 +2418,29 @@ var xyCommonCommands = (args) => {
       if (argv.verbose) console.log("NpmIgnore Gen");
       process.exitCode = npmignoreGen();
     }
+  ).command(
+    "readme-gen [package]",
+    "Readme Gen - Generate README.md files from template",
+    (yargs2) => {
+      return packagePositionalParam(yargs2).option("template", {
+        alias: "t",
+        description: "Path to README.template.md",
+        type: "string"
+      }).option("typedoc", {
+        default: false,
+        description: "Generate TypeDoc reference sections",
+        type: "boolean"
+      });
+    },
+    async (argv) => {
+      if (argv.verbose) console.log("Readme Gen");
+      process.exitCode = await readmeGen({
+        pkg: argv.package,
+        templatePath: argv.template,
+        typedoc: argv.typedoc,
+        verbose: !!argv.verbose
+      });
+    }
   ).command(
     "retest",
     "Re-Test - Run Jest Tests with cleaned cache",
@@ -2445,7 +2620,7 @@ var xyInstallCommands = (args) => {
 };
 
 // src/xy/xyLintCommands.ts
-import chalk28 from "chalk";
+import chalk29 from "chalk";
 var xyLintCommands = (args) => {
   return args.command(
     "cycle [package]",
@@ -2457,7 +2632,7 @@ var xyLintCommands = (args) => {
       const start = Date.now();
       if (argv.verbose) console.log("Cycle");
       process.exitCode = await cycle({ pkg: argv.package });
-      console.log(chalk28.blue(`Finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Finished in ${Date.now() - start}ms`));
     }
   ).command(
     "lint [package]",
@@ -2487,7 +2662,7 @@ var xyLintCommands = (args) => {
         cache: argv.cache,
         verbose: !!argv.verbose
       });
-      console.log(chalk28.blue(`Finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Finished in ${Date.now() - start}ms`));
     }
   ).command(
     "deplint [package]",
@@ -2526,7 +2701,7 @@ var xyLintCommands = (args) => {
         peerDeps: !!argv.peerDeps,
         verbose: !!argv.verbose
       });
-      console.log(chalk28.blue(`Finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Finished in ${Date.now() - start}ms`));
     }
   ).command(
     "fix [package]",
@@ -2538,7 +2713,7 @@ var xyLintCommands = (args) => {
       const start = Date.now();
       if (argv.verbose) console.log("Fix");
       process.exitCode = fix();
-      console.log(chalk28.blue(`Finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Finished in ${Date.now() - start}ms`));
     }
   ).command(
     "relint [package]",
@@ -2550,7 +2725,7 @@ var xyLintCommands = (args) => {
       if (argv.verbose) console.log("Relinting");
       const start = Date.now();
       process.exitCode = relint();
-      console.log(chalk28.blue(`Finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Finished in ${Date.now() - start}ms`));
     }
   ).command(
     "publint [package]",
@@ -2562,7 +2737,7 @@ var xyLintCommands = (args) => {
       if (argv.verbose) console.log("Publint");
       const start = Date.now();
       process.exitCode = await publint({ pkg: argv.package, verbose: !!argv.verbose });
-      console.log(chalk28.blue(`Finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Finished in ${Date.now() - start}ms`));
     }
   ).command(
     "knip",
@@ -2574,7 +2749,7 @@ var xyLintCommands = (args) => {
       if (argv.verbose) console.log("Knip");
       const start = Date.now();
       process.exitCode = knip();
-      console.log(chalk28.blue(`Knip finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Knip finished in ${Date.now() - start}ms`));
     }
   ).command(
     "sonar",
@@ -2586,7 +2761,7 @@ var xyLintCommands = (args) => {
       const start = Date.now();
       if (argv.verbose) console.log("Sonar Check");
       process.exitCode = sonar();
-      console.log(chalk28.blue(`Finished in ${Date.now() - start}ms`));
+      console.log(chalk29.blue(`Finished in ${Date.now() - start}ms`));
     }
   );
 };
@@ -2622,8 +2797,8 @@ var xyParseOptions = () => {
 var xy = async () => {
   const options = xyParseOptions();
   return await xyBuildCommands(xyCommonCommands(xyInstallCommands(xyDeployCommands(xyLintCommands(options))))).demandCommand(1).command("*", "", () => {
-    console.error(chalk29.yellow(`Command not found [${chalk29.magenta(process.argv[2])}]`));
-    console.log(chalk29.gray("Try 'yarn xy --help' for list of commands"));
+    console.error(chalk30.yellow(`Command not found [${chalk30.magenta(process.argv[2])}]`));
+    console.log(chalk30.gray("Try 'yarn xy --help' for list of commands"));
   }).version().help().argv;
 };