@dafish/gogo-meta 1.2.0 → 1.4.0

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { z } from 'zod';
 export { createProgram } from './cli.js';
 import 'commander';
 
+type ConfigFormat = 'json' | 'yaml';
 declare const CommandConfigObjectSchema: z.ZodObject<{
     cmd: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
@@ -81,14 +82,23 @@ type CommandHandler<T = void> = (options: T) => Promise<void>;
 
 declare const META_FILE = ".gogo";
 declare const LOOPRC_FILE = ".looprc";
+declare const META_FILE_CANDIDATES: readonly [".gogo", ".gogo.yaml", ".gogo.yml"];
 declare class ConfigError extends Error {
     readonly path?: string | undefined;
     constructor(message: string, path?: string | undefined);
 }
+declare function detectFormat(filePath: string): ConfigFormat;
+declare function filenameForFormat(format: ConfigFormat): string;
 declare function fileExists(path: string): Promise<boolean>;
 declare function findFileUp(filename: string, startDir: string): Promise<string | null>;
-declare function readMetaConfig(cwd: string): Promise<MetaConfig>;
-declare function writeMetaConfig(cwd: string, config: MetaConfig): Promise<void>;
+declare function findMetaFileUp(startDir: string): Promise<string | null>;
+interface MetaConfigResult {
+    config: MetaConfig;
+    format: ConfigFormat;
+    metaDir: string;
+}
+declare function readMetaConfig(cwd: string): Promise<MetaConfigResult>;
+declare function writeMetaConfig(cwd: string, config: MetaConfig, format?: ConfigFormat): Promise<void>;
 declare function readLoopRc(cwd: string): Promise<LoopRc | null>;
 declare function getMetaDir(cwd: string): Promise<string | null>;
 declare function createDefaultConfig(): MetaConfig;
@@ -200,4 +210,4 @@ declare function ensureSshHostsKnown(urls: string[]): Promise<{
     failed: string[];
 }>;
 
-export { type CommandConfig, type CommandConfigObject, CommandConfigObjectSchema, CommandConfigSchema, type CommandHandler, ConfigError, type ExecutorOptions, type ExecutorResult, type FilterOptions, LOOPRC_FILE, type LoopContext, type LoopOptions, type LoopRc, LoopRcSchema, type LoopResult, META_FILE, type MetaConfig, MetaConfigSchema, type ProjectInfo, type ResolvedCommand, addHostKey, addProject, addToGitignore, applyFilters, bold, commandOutput, createDefaultConfig, createFilterOptions, dim, ensureSshHostsKnown, error, execute, executeStreaming, executeSync, extractSshHost, extractUniqueSshHosts, fileExists, filterFromLoopRc, findFileUp, formatDuration, getCommand, getExitCode, getMetaDir, getProjectPaths, getProjectUrl, hasFailures, header, info, isHostKnown, listCommands, loop, normalizeCommand, parseFilterList, parseFilterPattern, projectStatus, readLoopRc, readMetaConfig, removeProject, success, summary, symbols, warning, writeMetaConfig };
+export { type CommandConfig, type CommandConfigObject, CommandConfigObjectSchema, CommandConfigSchema, type CommandHandler, ConfigError, type ConfigFormat, type ExecutorOptions, type ExecutorResult, type FilterOptions, LOOPRC_FILE, type LoopContext, type LoopOptions, type LoopRc, LoopRcSchema, type LoopResult, META_FILE, META_FILE_CANDIDATES, type MetaConfig, type MetaConfigResult, MetaConfigSchema, type ProjectInfo, type ResolvedCommand, addHostKey, addProject, addToGitignore, applyFilters, bold, commandOutput, createDefaultConfig, createFilterOptions, detectFormat, dim, ensureSshHostsKnown, error, execute, executeStreaming, executeSync, extractSshHost, extractUniqueSshHosts, fileExists, filenameForFormat, filterFromLoopRc, findFileUp, findMetaFileUp, formatDuration, getCommand, getExitCode, getMetaDir, getProjectPaths, getProjectUrl, hasFailures, header, info, isHostKnown, listCommands, loop, normalizeCommand, parseFilterList, parseFilterPattern, projectStatus, readLoopRc, readMetaConfig, removeProject, success, summary, symbols, warning, writeMetaConfig };

package/dist/index.js

@@ -1,7 +1,8 @@
 import { spawn, execSync } from 'child_process';
 import { z } from 'zod';
-import { mkdir, appendFile, access, writeFile, readFile, unlink, symlink } from 'fs/promises';
+import { unlink, mkdir, appendFile, access, writeFile, readFile, symlink } from 'fs/promises';
 import { dirname, join, basename } from 'path';
+import { stringify, parse } from 'yaml';
 import pc from 'picocolors';
 import { homedir } from 'os';
 import { Command } from 'commander';
@@ -206,6 +207,7 @@ var LoopRcSchema = z.object({
 });
 var META_FILE = ".gogo";
 var LOOPRC_FILE = ".looprc";
+var META_FILE_CANDIDATES = [".gogo", ".gogo.yaml", ".gogo.yml"];
 var ConfigError = class extends Error {
   constructor(message, path) {
     super(message);
@@ -213,6 +215,21 @@ var ConfigError = class extends Error {
     this.name = "ConfigError";
   }
 };
+function detectFormat(filePath) {
+  if (filePath.endsWith(".yaml") || filePath.endsWith(".yml")) {
+    return "yaml";
+  }
+  return "json";
+}
+function filenameForFormat(format) {
+  return format === "yaml" ? ".gogo.yaml" : ".gogo";
+}
+function parseContent(content, format) {
+  return format === "yaml" ? parse(content) : JSON.parse(content);
+}
+function serializeContent(data, format) {
+  return format === "yaml" ? stringify(data, { indent: 2 }) : JSON.stringify(data, null, 2) + "\n";
+}
 async function fileExists(path) {
   try {
     await access(path);
@@ -235,31 +252,53 @@ async function findFileUp(filename, startDir) {
     currentDir = parentDir;
   }
 }
+async function findMetaFileUp(startDir) {
+  let currentDir = startDir;
+  while (true) {
+    for (const candidate of META_FILE_CANDIDATES) {
+      const filePath = join(currentDir, candidate);
+      if (await fileExists(filePath)) {
+        return filePath;
+      }
+    }
+    const parentDir = dirname(currentDir);
+    if (parentDir === currentDir) {
+      return null;
+    }
+    currentDir = parentDir;
+  }
+}
 async function readMetaConfig(cwd) {
-  const metaPath = await findFileUp(META_FILE, cwd);
+  const metaPath = await findMetaFileUp(cwd);
   if (!metaPath) {
     throw new ConfigError(
       `No ${META_FILE} file found. Run 'gogo init' to create one, or navigate to a directory with a ${META_FILE} file.`
     );
   }
+  const format = detectFormat(metaPath);
   try {
     const content = await readFile(metaPath, "utf-8");
-    const parsed = JSON.parse(content);
-    return MetaConfigSchema.parse(parsed);
+    const parsed = parseContent(content, format);
+    const config = MetaConfigSchema.parse(parsed);
+    return { config, format, metaDir: dirname(metaPath) };
   } catch (error2) {
     if (error2 instanceof SyntaxError) {
-      throw new ConfigError(`Invalid JSON in ${META_FILE} file`, metaPath);
+      throw new ConfigError(`Invalid JSON in config file`, metaPath);
+    }
+    if (error2 instanceof Error && error2.name === "YAMLParseError") {
+      throw new ConfigError(`Invalid YAML in config file`, metaPath);
     }
     if (error2 instanceof Error && error2.name === "ZodError") {
-      throw new ConfigError(`Invalid ${META_FILE} file structure: ${error2.message}`, metaPath);
+      throw new ConfigError(`Invalid config file structure: ${error2.message}`, metaPath);
     }
     throw error2;
   }
 }
-async function writeMetaConfig(cwd, config) {
-  const metaPath = join(cwd, META_FILE);
+async function writeMetaConfig(cwd, config, format = "json") {
+  const filename = filenameForFormat(format);
+  const metaPath = join(cwd, filename);
   const validated = MetaConfigSchema.parse(config);
-  const content = JSON.stringify(validated, null, 2) + "\n";
+  const content = serializeContent(validated, format);
   await writeFile(metaPath, content, "utf-8");
 }
 async function readLoopRc(cwd) {
@@ -276,7 +315,7 @@ async function readLoopRc(cwd) {
   }
 }
 function getMetaDir(cwd) {
-  return findFileUp(META_FILE, cwd).then((path) => path ? dirname(path) : null);
+  return findMetaFileUp(cwd).then((path) => path ? dirname(path) : null);
 }
 function createDefaultConfig() {
   return {
@@ -643,22 +682,36 @@ async function ensureSshHostsKnown(urls) {
 }
 async function initCommand(options = {}) {
   const cwd = process.cwd();
-  const metaPath = join(cwd, META_FILE);
-  if (await fileExists(metaPath)) {
+  const format = options.format === "yaml" ? "yaml" : "json";
+  const existingFiles = [];
+  for (const candidate of META_FILE_CANDIDATES) {
+    const candidatePath = join(cwd, candidate);
+    if (await fileExists(candidatePath)) {
+      existingFiles.push(candidate);
+    }
+  }
+  if (existingFiles.length > 0) {
     if (!options.force) {
       throw new Error(
-        `${META_FILE} file already exists. Use --force to overwrite.`
+        `${existingFiles[0]} file already exists. Use --force to overwrite.`
       );
     }
-    warning(`Overwriting existing ${META_FILE} file`);
+    for (const candidate of existingFiles) {
+      await unlink(join(cwd, candidate));
+    }
+    warning(`Overwriting existing config file`);
   }
   const config = createDefaultConfig();
-  await writeMetaConfig(cwd, config);
-  success(`Created ${META_FILE} file in ${cwd}`);
+  await writeMetaConfig(cwd, config, format);
+  const filename = filenameForFormat(format);
+  success(`Created ${filename} file in ${cwd}`);
   info("Add projects with: gogo project import <folder> <repo-url>");
 }
 function registerInitCommand(program) {
-  program.command("init").description("Initialize a new gogo-meta repository").option("-f, --force", "Overwrite existing .gogo file").action(async (options) => {
+  program.command("init").description("Initialize a new gogo-meta repository").option("-f, --force", "Overwrite existing config file").option("--format <format>", "Config file format (json or yaml)", "json").action(async (options) => {
+    if (options.format && !["json", "yaml"].includes(options.format)) {
+      throw new Error(`Invalid format "${options.format}". Use "json" or "yaml".`);
+    }
     await initCommand(options);
   });
 }
@@ -670,7 +723,7 @@ async function execCommand(command, options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   info(`Executing: ${bold(command)}`);
   const results = await loop(command, { config, metaDir }, {
@@ -712,7 +765,7 @@ async function runCommand(name, options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   if (options.list || name === void 0) {
     formatCommandList(listCommands(config));
     return;
@@ -773,12 +826,12 @@ async function cloneCommand(url, options = {}) {
     return;
   }
   success(`Cloned meta repository to ${repoName}`);
-  const metaPath = join(targetDir, ".gogo");
-  if (!await fileExists(metaPath)) {
-    warning("No .gogo file found in cloned repository");
+  const metaPath = await findMetaFileUp(targetDir);
+  if (!metaPath) {
+    warning("No config file found in cloned repository");
     return;
   }
-  const config = await readMetaConfig(targetDir);
+  const { config } = await readMetaConfig(targetDir);
   const projects = Object.entries(config.projects);
   if (projects.length === 0) {
     info("No child repositories defined in .gogo");
@@ -828,7 +881,7 @@ async function updateCommand(options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   let projectEntries = Object.entries(config.projects);
   const projectPaths = projectEntries.map(([path]) => path);
@@ -908,7 +961,7 @@ async function statusCommand(options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   info("Checking git status across repositories...");
   const results = await loop("git status --short --branch", { config, metaDir }, {
@@ -928,7 +981,7 @@ async function pullCommand(options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   info("Pulling changes across repositories...");
   const results = await loop("git pull", { config, metaDir }, {
@@ -949,7 +1002,7 @@ async function pushCommand(options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   info("Pushing changes across repositories...");
   const results = await loop("git push", { config, metaDir }, {
@@ -969,7 +1022,7 @@ async function branchCommand(name, options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   let command;
   let actionMessage;
@@ -1003,7 +1056,7 @@ async function checkoutCommand(branch, options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   const flag = options.create ? "-b " : "";
   const command = `git checkout ${flag}"${branch}"`;
@@ -1026,7 +1079,7 @@ async function commitCommand(options) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   const escapedMessage = options.message.replace(/"/g, '\\"');
   const command = `git commit -m "${escapedMessage}"`;
@@ -1092,9 +1145,9 @@ async function createCommand(folder, url) {
   if (remoteResult.exitCode !== 0) {
     throw new Error(`Failed to add remote: ${remoteResult.stderr}`);
   }
-  const config = await readMetaConfig(metaDir);
+  const { config, format } = await readMetaConfig(metaDir);
   const updatedConfig = addProject(config, folder, url);
-  await writeMetaConfig(metaDir, updatedConfig);
+  await writeMetaConfig(metaDir, updatedConfig, format);
   const gitignorePath = join(metaDir, ".gitignore");
   if (await fileExists(gitignorePath)) {
     await appendFile(gitignorePath, `
@@ -1136,9 +1189,9 @@ async function importCommand(folder, url, options = {}) {
       info(`Existing: ${existingUrl}`);
       info(`Provided: ${url}`);
     }
-    const config = await readMetaConfig(metaDir);
+    const { config, format } = await readMetaConfig(metaDir);
     const updatedConfig = addProject(config, folder, finalUrl);
-    await writeMetaConfig(metaDir, updatedConfig);
+    await writeMetaConfig(metaDir, updatedConfig, format);
     success(`Imported existing project "${folder}"`);
     info(`Repository URL: ${finalUrl}`);
   } else {
@@ -1146,9 +1199,9 @@ async function importCommand(folder, url, options = {}) {
       throw new Error("URL is required when importing a non-existent project");
     }
     if (options.noClone) {
-      const config2 = await readMetaConfig(metaDir);
+      const { config: config2, format: format2 } = await readMetaConfig(metaDir);
       const updatedConfig2 = addProject(config2, folder, url);
-      await writeMetaConfig(metaDir, updatedConfig2);
+      await writeMetaConfig(metaDir, updatedConfig2, format2);
       const added2 = await addToGitignore(metaDir, folder);
       success(`Registered project "${folder}" (not cloned)`);
       if (added2) {
@@ -1166,9 +1219,9 @@ async function importCommand(folder, url, options = {}) {
     if (cloneResult.exitCode !== 0) {
       throw new Error(`Failed to clone repository: ${cloneResult.stderr}`);
     }
-    const config = await readMetaConfig(metaDir);
+    const { config, format } = await readMetaConfig(metaDir);
     const updatedConfig = addProject(config, folder, url);
-    await writeMetaConfig(metaDir, updatedConfig);
+    await writeMetaConfig(metaDir, updatedConfig, format);
     success(`Imported project "${folder}"`);
   }
   const added = await addToGitignore(metaDir, folder);
@@ -1195,7 +1248,7 @@ async function installCommand(variant, options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   const command = `npm ${variant}`;
   info(`Running "${command}" across repositories...`);
@@ -1241,7 +1294,7 @@ async function linkCommand(options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   let projectPaths = Object.keys(config.projects);
   projectPaths = applyFilters(projectPaths, filterOptions);
@@ -1319,7 +1372,7 @@ async function runCommand2(script, options = {}) {
   if (!metaDir) {
     throw new Error('Not in a gogo-meta repository. Run "gogo init" first.');
   }
-  const config = await readMetaConfig(cwd);
+  const { config } = await readMetaConfig(cwd);
   const filterOptions = createFilterOptions(options);
   info(`Running "npm run ${script}" across repositories...`);
   const command = options.ifPresent ? async (dir, _projectPath) => {
@@ -1411,6 +1464,6 @@ async function main() {
 }
 main();
 
-export { CommandConfigObjectSchema, CommandConfigSchema, ConfigError, LOOPRC_FILE, LoopRcSchema, META_FILE, MetaConfigSchema, addHostKey, addProject, addToGitignore, applyFilters, bold, commandOutput, createDefaultConfig, createFilterOptions, createProgram, dim, ensureSshHostsKnown, error, execute, executeStreaming, executeSync, extractSshHost, extractUniqueSshHosts, fileExists, filterFromLoopRc, findFileUp, formatDuration, getCommand, getExitCode, getMetaDir, getProjectPaths, getProjectUrl, hasFailures, header, info, isHostKnown, listCommands, loop, normalizeCommand, parseFilterList, parseFilterPattern, projectStatus, readLoopRc, readMetaConfig, removeProject, success, summary, symbols, warning, writeMetaConfig };
+export { CommandConfigObjectSchema, CommandConfigSchema, ConfigError, LOOPRC_FILE, LoopRcSchema, META_FILE, META_FILE_CANDIDATES, MetaConfigSchema, addHostKey, addProject, addToGitignore, applyFilters, bold, commandOutput, createDefaultConfig, createFilterOptions, createProgram, detectFormat, dim, ensureSshHostsKnown, error, execute, executeStreaming, executeSync, extractSshHost, extractUniqueSshHosts, fileExists, filenameForFormat, filterFromLoopRc, findFileUp, findMetaFileUp, formatDuration, getCommand, getExitCode, getMetaDir, getProjectPaths, getProjectUrl, hasFailures, header, info, isHostKnown, listCommands, loop, normalizeCommand, parseFilterList, parseFilterPattern, projectStatus, readLoopRc, readMetaConfig, removeProject, success, summary, symbols, warning, writeMetaConfig };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map