@visulima/cerebro 3.0.0-alpha.9 → 3.0.0

package/dist/commands/readme-command.js

@@ -1,265 +1,36 @@
-import { createRequire as __cjs_createRequire } from "node:module";
-
-const __cjs_require = __cjs_createRequire(import.meta.url);
-
-const __cjs_getProcess = typeof globalThis !== "undefined" && typeof globalThis.process !== "undefined" ? globalThis.process : process;
-
-const __cjs_getBuiltinModule = (module) => {
-    // Check if we're in Node.js and version supports getBuiltinModule
-    if (typeof __cjs_getProcess !== "undefined" && __cjs_getProcess.versions && __cjs_getProcess.versions.node) {
-        const [major, minor] = __cjs_getProcess.versions.node.split(".").map(Number);
-        // Node.js 20.16.0+ and 22.3.0+
-        if (major > 22 || (major === 22 && minor >= 3) || (major === 20 && minor >= 16)) {
-            return __cjs_getProcess.getBuiltinModule(module);
-        }
-    }
-    // Fallback to createRequire
-    return __cjs_require(module);
-};
-
-const {
-  existsSync
-} = __cjs_getBuiltinModule("node:fs");
-const {
-  readFile,
-  mkdir,
-  writeFile
-} = __cjs_getBuiltinModule("node:fs/promises");
-const {
-  resolve,
-  join,
-  dirname
-} = __cjs_getBuiltinModule("node:path");
-import GithubSlugger from 'github-slugger';
-import { c as commandLineUsage } from '../packem_shared/index-C2-8b3A4.js';
-import { g as getCwd, a as getVersions, b as getPlatform, c as getArch } from '../packem_shared/runtime-process-B6ZplyWn.js';
-
-const slugger = new GithubSlugger();
-const slugify = slugger.slug;
-const compact = (array) => array.filter(Boolean);
-const uniqBy = (array, keyFunction) => {
-  const seen = /* @__PURE__ */ new Set();
-  const result = [];
-  for (const item of array) {
-    const key = keyFunction(item);
-    if (!seen.has(key)) {
-      seen.add(key);
-      result.push(item);
-    }
-  }
-  return result;
-};
-const formatCommandUsage = (command, cliName) => {
-  const fullPath = command.commandPath ? [...command.commandPath, command.name] : [command.name];
-  const commandId = fullPath.join(" ");
-  if (command.argument) {
-    const argumentName = command.argument.name?.toUpperCase() ?? "ARG";
-    const argumentString = command.argument.required ? argumentName : `[${argumentName}]`;
-    return `${cliName} ${commandId} ${argumentString}`;
-  }
-  return `${cliName} ${commandId}`;
-};
-const addEnvironmentVariables = (command, usageGroups) => {
-  if (!Array.isArray(command.env) || command.env.length === 0) {
-    return;
-  }
-  const visibleEnvVariables = command.env.filter((envVariable) => !envVariable.hidden);
-  if (visibleEnvVariables.length > 0) {
-    usageGroups.push({
-      content: visibleEnvVariables.map((envVariable) => [envVariable.name, envVariable.description ?? ""]),
-      header: " Environment Variables "
-    });
-  }
-};
-const formatCommandHelp = (command, cliName) => {
-  const usageGroups = [];
-  const fullCommandPath = command.commandPath ? [...command.commandPath, command.name] : [command.name];
-  const commandDisplay = fullCommandPath.join(" ");
-  const hasArgument = Boolean(command.argument);
-  const hasOptions = Boolean(command.options);
-  usageGroups.push({
-    content: `${cliName} ${commandDisplay}${hasArgument ? " [positional arguments]" : ""}${hasOptions ? " [options]" : ""}`,
-    header: " Usage "
-  });
-  if (command.description) {
-    usageGroups.push({ content: command.description, header: " Description " });
-  }
-  if (command.argument) {
-    usageGroups.push({ header: "Command Positional Arguments", isArgument: true, optionList: [command.argument] });
-  }
-  if (Array.isArray(command.options) && command.options.length > 0) {
-    usageGroups.push({
-      header: " Command Options ",
-      optionList: command.options.filter(
-        (option) => typeof option === "object" && option !== null && (!("hidden" in option) || !option.hidden)
-      )
-    });
-  }
-  addEnvironmentVariables(command, usageGroups);
-  if (command.alias !== void 0 && command.alias.length > 0) {
-    const alias = Array.isArray(command.alias) ? command.alias : [command.alias];
-    usageGroups.splice(1, 0, {
-      content: alias,
-      header: "Alias(es)"
-    });
-  }
-  if (Array.isArray(command.examples) && command.examples.length > 0) {
-    usageGroups.push({
-      content: command.examples,
-      header: "Examples"
-    });
-  }
-  return commandLineUsage(usageGroups);
-};
-const renderCommand = (command, cliName) => {
-  const title = command.description?.trim().split("\n")[0] ?? "";
-  const usage = formatCommandUsage(command, cliName);
-  const helpText = formatCommandHelp(command, cliName);
-  return compact([`## \`${usage}\``, title, `\`\`\`
-${helpText.trim()}
-\`\`\``]).join("\n\n");
-};
-const generateUsage = (cliName, packageName, version, nodeVersion) => {
-  const versionFlags = ["--version", "-V"];
-  const versionFlagsString = `(${versionFlags.join("|")})`;
-  const platform = getPlatform();
-  const arch = getArch();
-  return `\`\`\`sh-session
-$ npm install -g ${packageName}
-$ ${cliName} COMMAND
+import{createRequire as x}from"node:module";import{r as L}from"../packem_shared/index-B7-8G-9s.js";import{g as N,a as V,b as q}from"../packem_shared/runtime-process-Dmz0vCJy.js";const S=x(import.meta.url),h=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,O=e=>{if(typeof h<"u"&&h.versions&&h.versions.node){const[n,t]=h.versions.node.split(".").map(Number);if(n>22||n===22&&t>=3||n===20&&t>=16)return h.getBuiltinModule(e)}return S(e)},{resolve:P,join:k,dirname:B}=O("node:path"),v=async(e,n)=>{try{return await e.access(n),!0}catch{return!1}},G=async()=>{const{default:e}=await import("github-slugger"),n=new e;return t=>n.slug(t)},T=e=>e.filter(Boolean),U=(e,n)=>{const t=new Set,a=[];for(const r of e){const o=n(r);t.has(o)||(t.add(o),a.push(r))}return a},M=(e,n)=>{const t=(e.commandPath?[...e.commandPath,e.name]:[e.name]).join(" ");if(e.argument){const a=e.argument.name.toUpperCase(),r=e.argument.required?a:`[${a}]`;return`${n} ${t} ${r}`}return`${n} ${t}`},F=(e,n)=>{if(!Array.isArray(e.env)||e.env.length===0)return;const t=e.env.filter(a=>!a.hidden);t.length>0&&n.push({content:t.map(a=>[a.name,a.description??""]),header:" Environment Variables "})},I=(e,n)=>{const t=[],a=(e.commandPath?[...e.commandPath,e.name]:[e.name]).join(" "),r=!!e.argument,o=!!e.options;if(t.push({content:`${n} ${a}${r?" [positional arguments]":""}${o?" [options]":""}`,header:" Usage "}),e.description&&t.push({content:e.description,header:" Description "}),e.argument&&t.push({header:"Command Positional Arguments",isArgument:!0,optionList:[e.argument]}),Array.isArray(e.options)&&e.options.length>0&&t.push({header:" Command Options ",optionList:e.options.filter(i=>!i.hidden)}),F(e,t),e.alias!==void 0&&e.alias.length>0){const i=Array.isArray(e.alias)?e.alias:[e.alias];t.splice(1,0,{content:i,header:"Alias(es)"})}return Array.isArray(e.examples)&&e.examples.length>0&&t.push({content:e.examples,header:"Examples"}),L(t)},W=(e,n)=>{const t=e.description?.trim().split(`
+`)[0]??"",a=M(e,n),r=I(e,n);return T([`## \`${a}\``,t,`\`\`\`
+${r.trim()}
+\`\`\``]).join(`
+
+`)},z=(e,n,t,a)=>{const r=`(${["--version","-V"].join("|")})`,o=V(),i=q();return`\`\`\`sh-session
+$ npm install -g ${n}
+$ ${e} COMMAND
 running command...
-$ ${cliName} ${versionFlagsString}
-${packageName}/${version ?? "unknown"} ${platform}-${arch} node-v${nodeVersion}
-$ ${cliName} --help [COMMAND]
+$ ${e} ${r}
+${n}/${t??"unknown"} ${o}-${i} node-v${a}
+$ ${e} --help [COMMAND]
 USAGE
-  $ ${cliName} COMMAND
+  $ ${e} COMMAND
 ...
 \`\`\`
-`;
-};
-const generateCommands = async (commands, cliName, _options) => {
-  const commandList = await Promise.all(
-    commands.map(async (command) => {
-      const usage = formatCommandUsage(command, cliName);
-      return `* [\`${usage}\`](#${await slugify(usage)})`;
-    })
-  );
-  const commandDocumentation = commands.map((command) => renderCommand(command, cliName)).map((s) => `${s.trim()}
-`);
-  return [...commandList, "", ...commandDocumentation].join("\n").trim();
-};
-const writeFileWithDirectory = async (filePath, content) => {
-  const directory = dirname(filePath);
-  if (!existsSync(directory)) {
-    await mkdir(directory, { recursive: true });
-  }
-  await writeFile(filePath, content, "utf8");
-};
-const generateMultiCommands = async (commands, outputDirectory, cliName, options) => {
-  const groupedCommands = /* @__PURE__ */ new Map();
-  for (const command of commands) {
-    const group = command.group ?? "__Other";
-    const groupCommands = groupedCommands.get(group) ?? [];
-    groupCommands.push(command);
-    groupedCommands.set(group, groupCommands);
-  }
-  const groups = [...groupedCommands.entries()].map(([group, groupCommands]) => {
-    if (group === "__Other") {
-      return ["Other", groupCommands];
-    }
-    return [group, groupCommands];
-  });
-  await Promise.all(
-    groups.map(async ([group, groupCommands]) => {
-      const groupPath = group.replaceAll(":", "/");
-      const filePath = join(".", outputDirectory, `${groupPath}.md`);
-      const bin = `\`${cliName} ${group}\``;
-      const document = `${[
-        bin,
-        "=".repeat(bin.length),
-        "",
-        `Commands in the ${group} group.`,
-        "",
-        await generateCommands(groupCommands, cliName)
-      ].join("\n").trim()}
-`;
-      if (!options.dryRun) {
-        await writeFileWithDirectory(resolve(getCwd(), filePath), document);
-      }
-    })
-  );
-  const topicLinks = groups.map(([group]) => {
-    const groupPath = group.replaceAll(":", "/");
-    return `* [\`${cliName} ${group}\`](${outputDirectory}/${groupPath}.md)`;
-  });
-  return `${["# Command Topics\n", ...topicLinks].join("\n").trim()}
-`;
-};
-const normalizeLineEndings = (text) => text.replaceAll("\r\n", "\n").replaceAll("\r", "\n");
-const generateTableOfContents = async (readme) => {
-  const normalizedReadme = normalizeLineEndings(readme);
-  const toc = await Promise.all(
-    normalizedReadme.split("\n").filter((line) => line.startsWith("# ")).map((line) => line.trim().slice(2)).map(async (line) => `* [${line}](#${await slugify(line)})`)
-  );
-  return toc.join("\n");
-};
-const escapeRegex = (string_) => string_.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`);
-const replaceTag = (readme, tag, body) => {
-  const normalizedReadme = normalizeLineEndings(readme);
-  const tagStart = `<!-- ${tag} -->`;
-  const tagStop = `<!-- ${tag}stop -->`;
-  if (normalizedReadme.includes(tagStart) && normalizedReadme.includes(tagStop)) {
-    const escapedStart = escapeRegex(tagStart);
-    const escapedStop = escapeRegex(tagStop);
-    const tagPattern = new RegExp(String.raw`${escapedStart}(.|\n)*${escapedStop}`, "m");
-    return normalizedReadme.replace(tagPattern, `${tagStart}
-${body}
-${tagStop}`);
-  }
-  return normalizedReadme.replace(tagStart, `${tagStart}
-${body}
-${tagStop}`);
-};
-const readmeCommand = {
-  description: "Generate README documentation for CLI commands",
-  execute: async ({ logger, options, runtime }) => {
-    const cliName = runtime.getCliName();
-    const packageName = runtime.getPackageName() ?? cliName;
-    const packageVersion = runtime.getPackageVersion();
-    const versions = getVersions();
-    const nodeVersion = versions.node ?? "unknown";
-    const readmeOptions = {
-      aliases: options?.aliases,
-      dryRun: options?.dryRun,
-      multi: options?.multi,
-      outputDir: options?.outputDir ?? "docs",
-      readmePath: options?.readmePath ?? "README.md",
-      version: options?.version ?? packageVersion ?? void 0
-    };
-    const commandsMap = runtime.getCommands();
-    const commands = [...commandsMap.values()].filter((c) => !c.hidden).filter((c) => {
-      if (readmeOptions.aliases) {
-        return true;
-      }
-      return c.name === commandsMap.get(c.name)?.name;
-    }).toSorted((a, b) => {
-      const aPath = a.commandPath ? [...a.commandPath, a.name].join(" ") : a.name;
-      const bPath = b.commandPath ? [...b.commandPath, b.name].join(" ") : b.name;
-      return aPath.localeCompare(bPath);
-    });
-    const uniqueCommands = uniqBy(commands, (c) => {
-      const path = c.commandPath ? [...c.commandPath, c.name].join(" ") : c.name;
-      return path;
-    });
-    logger.debug(`Processing ${uniqueCommands.length} commands for README generation`);
-    let readme;
-    const readmePath = resolve(getCwd(), readmeOptions.readmePath ?? "README.md");
-    if (existsSync(readmePath)) {
-      const rawReadme = await readFile(readmePath, "utf8");
-      readme = normalizeLineEndings(rawReadme);
-    } else {
-      logger.warn(`README file not found at ${readmePath}, creating template`);
-      readme = `# ${packageName}
+`},R=(e,n,t,a)=>{const r=e.map(i=>{const p=M(i,n);return`* [\`${p}\`](#${a(p)})`}),o=e.map(i=>W(i,n)).map(i=>`${i.trim()}
+`);return[...r,"",...o].join(`
+`).trim()},j=async(e,n,t)=>{const a=B(n);await v(e,a)||await e.mkdir(a,{recursive:!0}),await e.writeFile(n,t,"utf8")},H=async(e,n,t,a,r,o,i)=>{const p=new Map;for(const m of t){const s=m.group??"__Other",u=p.get(s)??[];u.push(m),p.set(s,u)}const d=Array.from(p.entries(),([m,s])=>m==="__Other"?["Other",s]:[m,s]);return await Promise.all(d.map(async([m,s])=>{const u=m.replaceAll(":","/"),y=k(".",a,`${u}.md`),g=`\`${r} ${m}\``,l=`${[g,"=".repeat(g.length),"",`Commands in the ${m} group.`,"",R(s,r,o,i)].join(`
+`).trim()}
+`;o.dryRun||await j(e,P(n,y),l)})),`${[`# Command Topics
+`,...d.map(([m])=>{const s=m.replaceAll(":","/");return`* [\`${r} ${m}\`](${a}/${s}.md)`})].join(`
+`).trim()}
+`},A=e=>e.replaceAll(`\r
+`,`
+`).replaceAll("\r",`
+`),J=(e,n)=>A(e).split(`
+`).filter(t=>t.startsWith("# ")).map(t=>t.trim().slice(2)).map(t=>`* [${t}](#${n(t)})`).join(`
+`),E=e=>e.replaceAll(/[.*+?^${}()|[\]\\]/g,String.raw`\$&`),w=(e,n,t)=>{const a=A(e),r=`<!-- ${n} -->`,o=`<!-- ${n}stop -->`;if(a.includes(r)&&a.includes(o)){const i=E(r),p=E(o),d=new RegExp(String.raw`${i}(.|\n)*${p}`,"m");return a.replace(d,`${r}
+${t}
+${o}`)}return a.replace(r,`${r}
+${t}
+${o}`)},Y={description:"Generate README documentation for CLI commands",execute:async({fs:e,logger:n,options:t,process:a,runtime:r})=>{const o=r.getCliName(),i=r.getPackageName()??o,p=r.getPackageVersion(),d=N().node??"unknown",m=await G(),s={aliases:t.aliases,dryRun:t.dryRun,multi:t.multi,outputDir:t.outputDir??"docs",readmePath:t.readmePath??"README.md",version:t.version??p??void 0},u=r.getCommands(),y=[...u.values()].filter(c=>!c.hidden).filter(c=>s.aliases?!0:c.name===u.get(c.name)?.name).toSorted((c,f)=>{const b=c.commandPath?[...c.commandPath,c.name].join(" "):c.name,C=f.commandPath?[...f.commandPath,f.name].join(" "):f.name;return b.localeCompare(C)}),g=U(y,c=>c.commandPath?[...c.commandPath,c.name].join(" "):c.name);n.debug(`Processing ${String(g.length)} commands for README generation`);let l;const $=P(a.cwd,s.readmePath??"README.md");if(await v(e,$)){const c=await e.readFile($,"utf8");l=A(c)}else n.warn(`README file not found at ${$}, creating template`),l=`# ${i}
 
 <!-- usage -->
 <!-- usagestop -->
@@ -269,75 +40,6 @@ const readmeCommand = {
 
 <!-- toc -->
 <!-- tocstop -->
-`;
-    }
-    const outputDirectory = readmeOptions.outputDir ?? "docs";
-    const version = readmeOptions.version ?? packageVersion ?? "unknown";
-    readme = replaceTag(readme, "usage", generateUsage(cliName, packageName, version, nodeVersion));
-    readme = replaceTag(
-      readme,
-      "commands",
-      readmeOptions.multi ? await generateMultiCommands(uniqueCommands, outputDirectory, cliName, readmeOptions) : await generateCommands(uniqueCommands, cliName)
-    );
-    readme = replaceTag(readme, "toc", await generateTableOfContents(readme));
-    readme = `${readme.trimEnd()}
-`;
-    if (readmeOptions.dryRun) {
-      logger.info("Dry run mode - README not written");
-      logger.info(`Generated README content:
-${readme}`);
-    } else {
-      await writeFileWithDirectory(readmePath, readme);
-      logger.info(`README generated successfully at ${readmePath}`);
-    }
-  },
-  name: "readme",
-  options: [
-    {
-      description: "Include aliases in command list",
-      name: "aliases",
-      type: Boolean
-    },
-    {
-      description: "Show what would be generated without writing files",
-      name: "dry-run",
-      type: Boolean
-    },
-    {
-      description: "Generate multi-file documentation by command groups",
-      name: "multi",
-      type: Boolean
-    },
-    {
-      description: "Maximum depth for nested topics when using multi-file mode",
-      name: "nested-topics-depth",
-      type: Number
-    },
-    {
-      description: "Output directory for multi-file documentation",
-      name: "output-dir",
-      type: String,
-      typeLabel: "{underline directory}"
-    },
-    {
-      description: "Path to README file to generate",
-      name: "readme-path",
-      type: String,
-      typeLabel: "{underline path}"
-    },
-    {
-      description: "Repository prefix for code links",
-      name: "repository-prefix",
-      type: String,
-      typeLabel: "{underline prefix}"
-    },
-    {
-      description: "Version to use in generated documentation",
-      name: "version",
-      type: String,
-      typeLabel: "{underline version}"
-    }
-  ]
-};
-
-export { readmeCommand as default };
+`;const D=s.outputDir??"docs",_=s.version??p??"unknown";l=w(l,"usage",z(o,i,_,d)),l=w(l,"commands",s.multi?await H(e,a.cwd,g,D,o,s,m):R(g,o,s,m)),l=w(l,"toc",J(l,m)),l=`${l.trimEnd()}
+`,s.dryRun?(n.info("Dry run mode - README not written"),n.info(`Generated README content:
+${l}`)):(await j(e,$,l),n.info(`README generated successfully at ${$}`))},name:"readme",options:[{description:"Include aliases in command list",name:"aliases",type:Boolean},{description:"Show what would be generated without writing files",name:"dry-run",type:Boolean},{description:"Generate multi-file documentation by command groups",name:"multi",type:Boolean},{description:"Maximum depth for nested topics when using multi-file mode",name:"nested-topics-depth",type:Number},{description:"Output directory for multi-file documentation",name:"output-dir",type:String,typeLabel:"{underline directory}"},{description:"Path to README file to generate",name:"readme-path",type:String,typeLabel:"{underline path}"},{description:"Repository prefix for code links",name:"repository-prefix",type:String,typeLabel:"{underline prefix}"},{description:"Version to use in generated documentation",name:"version",type:String,typeLabel:"{underline version}"}]};export{Y as default};

package/dist/commands/version-command.d.ts

@@ -1,3 +1,4 @@
-import type { Command as ICommand } from "../types/command.d.ts";
-declare const _default: ICommand;
-export default _default;
+import { C as Command } from "../packem_shared/command.d-DbhtfXF4.js";
+import '@visulima/tabular';
+declare const _default: Command;
+export { _default as default };

package/dist/commands/version-command.js

@@ -1,18 +1 @@
-const versionCommand = {
-  alias: ["v", "V"],
-  description: "Output the version number",
-  execute: ({ logger, runtime }) => {
-    const version = runtime.getPackageVersion();
-    if (version === void 0) {
-      logger.warn("Unknown version");
-      logger.debug("The version number was not provided by the cli constructor.");
-    } else {
-      logger.info(version);
-    }
-  },
-  name: "version",
-  options: [],
-  usage: []
-};
-
-export { versionCommand as default };
+const r={alias:["v","V"],description:"Output the version number",execute:({logger:e,runtime:o})=>{const n=o.getPackageVersion();n===void 0?(e.warn("Unknown version"),e.debug("The version number was not provided by the cli constructor.")):e.info(n)},name:"version",options:[],usage:[]};export{r as default};