Merge pull request #300 from capralifecycle/add-feedback-messages

feat: add status messages for network operations

Author: joakimen

src/cli/commands/clone.ts

@@ -6,16 +6,19 @@ import { hideBin } from "yargs/helpers"
 import type { Config } from "../../config"
 import { createGitHubService, type GitHubService } from "../../github"
 import { getGroupedRepos, includesTopic } from "../../github/util"
-import { createCacheProvider, createConfig } from "../util"
+import type { Reporter } from "../reporter"
+import { createCacheProvider, createConfig, createReporter } from "../util"
 
 async function generateCloneCommands({
   config,
   github,
+  reporter,
   org,
   ...opt
 }: {
   config: Config
   github: GitHubService
+  reporter: Reporter
   all: boolean
   skipCloned: boolean
   group: string | undefined
@@ -29,6 +32,7 @@ async function generateCloneCommands({
     return
   }
 
+  reporter.status(`Fetching repositories from ${org}...`)
   const repos = await github.getOrgRepoList({ org })
   const groups = getGroupedRepos(repos)
 
@@ -103,6 +107,7 @@ const command: CommandModule = {
       github: await createGitHubService({
         cache: createCacheProvider(config, argv),
       }),
+      reporter: createReporter(),
       all: !!argv.all,
       includeArchived: !!argv["include-archived"],
       name: argv.name as string | undefined,

src/cli/commands/groups.ts

@@ -1,31 +1,58 @@
+import fs from "node:fs"
+import path from "node:path"
+import process from "node:process"
+import { findUp } from "find-up"
+import yaml from "js-yaml"
 import type { CommandModule } from "yargs"
-import { createGitHubService } from "../../github"
-import { getGroupedRepos } from "../../github/util"
-import { createCacheProvider, createConfig, createReporter } from "../util"
+import { DefinitionFile } from "../../definition"
+import { createReporter } from "../util"
+
+const CALS_YAML = ".cals.yaml"
+
+interface CalsManifest {
+  version: 2
+  githubOrganization: string
+  resourcesDefinition: {
+    path: string
+  }
+}
 
 const command: CommandModule = {
   command: "groups",
-  describe: "List available repository groups in a GitHub organization",
-  builder: (yargs) =>
-    yargs.options("org", {
-      alias: "o",
-      default: "capralifecycle",
-      requiresArg: true,
-      describe: "GitHub organization",
-      type: "string",
-    }),
-  handler: async (argv) => {
-    const config = createConfig()
+  describe: "List available project groups from the definition file",
+  builder: (yargs) => yargs,
+  handler: async () => {
     const reporter = createReporter()
-    const github = await createGitHubService({
-      cache: createCacheProvider(config, argv),
-    })
 
-    const repos = await github.getOrgRepoList({ org: argv.org as string })
-    const groups = getGroupedRepos(repos)
+    const manifestPath = await findUp(CALS_YAML)
+    if (manifestPath === undefined) {
+      reporter.error(`File ${CALS_YAML} not found`)
+      process.exitCode = 1
+      return
+    }
+
+    const manifest: CalsManifest = yaml.load(
+      fs.readFileSync(manifestPath, "utf-8"),
+    ) as CalsManifest
+
+    const definitionPath = path.resolve(
+      path.dirname(manifestPath),
+      manifest.resourcesDefinition.path,
+    )
+
+    if (!fs.existsSync(definitionPath)) {
+      reporter.error(`Definition file not found: ${definitionPath}`)
+      process.exitCode = 1
+      return
+    }
+
+    const definition = await new DefinitionFile(definitionPath).getDefinition()
+    const projectNames = definition.projects
+      .map((p) => p.name)
+      .sort((a, b) => a.localeCompare(b))
 
-    for (const group of groups) {
-      reporter.log(group.name)
+    for (const name of projectNames) {
+      reporter.log(name)
     }
   },
 }

src/cli/commands/repos.ts

@@ -41,6 +41,7 @@ async function listRepos({
   csv: boolean
   org: string
 }) {
+  reporter.status(`Fetching repositories from ${org}...`)
   let repos = await github.getOrgRepoList({ org })
 
   if (!includeArchived) {

src/cli/commands/sync.ts

@@ -300,6 +300,7 @@ async function getExpectedRepos(
   expectedRepos: ExpectedRepo[]
   definitionRepo: ExpectedRepo | null
 }> {
+  reporter.status(`Fetching repositories from ${cals.githubOrganization}...`)
   const githubRepos = await github.getOrgRepoList({
     org: cals.githubOrganization,
   })

src/cli/commands/topics.ts

@@ -20,6 +20,7 @@ const command: CommandModule = {
       cache: createCacheProvider(config, argv),
     })
 
+    reporter.status(`Fetching repositories from ${argv.org}...`)
     const repos = await github.getOrgRepoList({ org: argv.org as string })
 
     const topics = new Set<string>()

src/cli/reporter.ts

@@ -105,4 +105,12 @@ export class Reporter {
     clearLine(this.stdout)
     this.stdout.write(`${this.format.blue("info")} ${msg}\n`)
   }
+
+  /**
+   * Write a status message to stderr for feedback during long-running operations.
+   * Writing to stderr ensures it doesn't interfere with piped stdout.
+   */
+  public status(msg: string): void {
+    this.stderr.write(`${this.format.dim(msg)}\n`)
+  }
 }