@aaronshaf/ger 2.0.2 → 2.0.3

package/docs/adr/0023-show-reviewer-list.md

@@ -0,0 +1,42 @@
+# ADR 0023: Surface Reviewers and CCs in `ger show`
+
+## Status
+
+Accepted
+
+## Context
+
+`ger` supports reviewer management (`add-reviewer`, `remove-reviewer`) but did not expose a reliable way to view current reviewers for a change in one command.
+
+This created a workflow gap:
+
+- Users could mutate reviewer state but not inspect it from the CLI.
+- `show` already served as the canonical "single change detail" command and was the best place to surface reviewer assignments.
+
+## Decision
+
+Add reviewer visibility to `ger show` by:
+
+1. Keeping `getChange` lightweight and using a `listChanges` fallback (with detailed account/label options) when reviewer state is not present in the base change response.
+2. Extending `ChangeInfo` schema with Gerrit reviewer state maps (`REVIEWER`, `CC`, `REMOVED`).
+3. Rendering reviewers and CCs in all `show` output formats (pretty, JSON, XML).
+
+## Rationale
+
+- **Single source of truth**: `show` remains the canonical command for full change context.
+- **No new command surface**: avoids adding a narrowly scoped `list-reviewers` command.
+- **Automation-friendly**: JSON/XML consumers can parse reviewer state without scraping text output.
+- **Backward compatible**: reviewer fields are optional and do not break servers or older data shapes.
+
+## Consequences
+
+### Positive
+
+- Users can verify reviewer assignment directly after add/remove operations.
+- Better parity between mutation commands and read visibility.
+- More complete machine-readable change payloads.
+
+### Negative
+
+- Extra `listChanges` request when reviewer data is absent from `getChange`.
+- Additional schema/output maintenance for reviewer state rendering.

package/docs/adr/README.md

@@ -28,3 +28,4 @@ Records of significant architectural decisions with context and rationale. Each
 | [0020](0020-code-coverage-enforcement.md) | 80% coverage threshold in pre-commit |
 | [0021](0021-typescript-isolated-declarations.md) | Explicit return types on exports |
 | [0022](0022-biome-oxlint-tooling.md) | Biome formatter + oxlint linter |
+| [0023](0023-show-reviewer-list.md) | Surface reviewers and CCs in `ger show` |

package/docs/prd/commands.md

@@ -23,11 +23,13 @@ ger show              # Auto-detect from HEAD
 
 **Output includes:**
 - Change metadata (number, project, branch, status)
-- Owner and reviewer information
+- Owner, reviewers, and CC information
 - Submit requirements
 - Full diff
 - All comments with context
 
+Reviewer listing for a specific change is provided by `show` (there is no separate `list-reviewers` command).
+
 ### diff
 
 Get change diff in various formats.

package/docs/prd/data-model.md

@@ -14,25 +14,36 @@ const ChangeInfo = Schema.Struct({
   _number: Schema.Number,         // Numeric change ID
   project: Schema.String,         // Project name
   branch: Schema.String,          // Target branch
+  change_id: Schema.String,       // Gerrit Change-Id
   topic: Schema.optional(Schema.String),
   subject: Schema.String,         // First line of commit message
   status: Schema.Literal('NEW', 'MERGED', 'ABANDONED', 'DRAFT'),
-  created: Schema.String,         // ISO timestamp
-  updated: Schema.String,         // ISO timestamp
-  submitted: Schema.optional(Schema.String),
-  submitter: Schema.optional(AccountInfo),
-  owner: AccountInfo,
+  created: Schema.optional(Schema.String),
+  updated: Schema.optional(Schema.String),
+  owner: Schema.optional(AccountInfo),
   current_revision: Schema.optional(Schema.String),
   revisions: Schema.optional(Schema.Record(Schema.String, RevisionInfo)),
   labels: Schema.optional(Schema.Record(Schema.String, LabelInfo)),
-  reviewers: Schema.optional(ReviewerMap),
-  messages: Schema.optional(Schema.Array(ChangeMessage)),
-  mergeable: Schema.optional(Schema.Boolean),
+  reviewers: Schema.optional(ReviewerStateMap),
+  submittable: Schema.optional(Schema.Boolean),
+  work_in_progress: Schema.optional(Schema.Boolean),
   insertions: Schema.optional(Schema.Number),
   deletions: Schema.optional(Schema.Number),
 })
 ```
 
+### ReviewerStateMap
+
+Reviewer assignments grouped by Gerrit reviewer state.
+
+```typescript
+const ReviewerStateMap = Schema.Struct({
+  REVIEWER: Schema.optional(Schema.Array(AccountInfo)),
+  CC: Schema.optional(Schema.Array(AccountInfo)),
+  REMOVED: Schema.optional(Schema.Array(AccountInfo)),
+})
+```
+
 ### AccountInfo
 
 User account information.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aaronshaf/ger",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Gerrit CLI and SDK - A modern CLI tool and TypeScript SDK for Gerrit Code Review, built with Effect-TS",
   "keywords": [
     "gerrit",

package/src/cli/commands/show.ts

@@ -7,7 +7,6 @@ import { formatDiffPretty } from '@/utils/diff-formatters'
 import { sanitizeCDATA, escapeXML } from '@/utils/shell-safety'
 import { formatDate } from '@/utils/formatters'
 import { getChangeIdFromHead, GitError, NoChangeIdError } from '@/utils/git-commit'
-import { writeFileSync } from 'node:fs'
 
 export const SHOW_HELP_TEXT = `
 Examples:
@@ -34,6 +33,13 @@ interface ShowOptions {
   json?: boolean
 }
 
+interface ReviewerIdentity {
+  accountId?: number
+  name?: string
+  email?: string
+  username?: string
+}
+
 interface ChangeDetails {
   id: string
   number: number
@@ -49,6 +55,24 @@ interface ChangeDetails {
   updated?: string
   commitMessage: string
   topic?: string
+  reviewers: ReviewerIdentity[]
+  ccs: ReviewerIdentity[]
+}
+
+const formatReviewerLabel = (reviewer: ReviewerIdentity): string => {
+  const preferredIdentity = reviewer.name || reviewer.email || reviewer.username
+  if (!preferredIdentity) {
+    if (reviewer.accountId !== undefined) {
+      return `Account ${reviewer.accountId}`
+    }
+    return 'Unknown Reviewer'
+  }
+
+  if (reviewer.email && reviewer.name && reviewer.name !== reviewer.email) {
+    return `${reviewer.name} <${reviewer.email}>`
+  }
+
+  return preferredIdentity
 }
 
 const getChangeDetails = (
@@ -58,6 +82,21 @@ const getChangeDetails = (
     const gerritApi = yield* GerritApiService
     const change = yield* gerritApi.getChange(changeId)
 
+    let reviewerMap = change.reviewers
+    const shouldFetchReviewerFallback =
+      reviewerMap === undefined ||
+      (reviewerMap.REVIEWER === undefined && reviewerMap.CC === undefined)
+
+    if (shouldFetchReviewerFallback) {
+      const detailedChanges = yield* gerritApi
+        .listChanges(`change:${change._number}`)
+        .pipe(Effect.catchAll(() => Effect.succeed([])))
+      const detailedChange =
+        detailedChanges.find((candidate) => candidate._number === change._number) ||
+        detailedChanges[0]
+      reviewerMap = detailedChange?.reviewers
+    }
+
     return {
       id: change.change_id,
       number: change._number,
@@ -73,6 +112,18 @@ const getChangeDetails = (
       updated: change.updated,
       commitMessage: change.subject, // For now, using subject as commit message
       topic: change.topic,
+      reviewers: (reviewerMap?.REVIEWER ?? []).map((reviewer) => ({
+        accountId: reviewer._account_id,
+        name: reviewer.name,
+        email: reviewer.email,
+        username: reviewer.username,
+      })),
+      ccs: (reviewerMap?.CC ?? []).map((cc) => ({
+        accountId: cc._account_id,
+        name: cc.name,
+        email: cc.email,
+        username: cc.username,
+      })),
     }
   })
 
@@ -154,6 +205,14 @@ const formatShowPretty = (
   console.log(
     `   Updated: ${changeDetails.updated ? formatDate(changeDetails.updated) : 'Unknown'}`,
   )
+  if (changeDetails.reviewers.length > 0) {
+    console.log(
+      `   Reviewers: ${changeDetails.reviewers.map((reviewer) => formatReviewerLabel(reviewer)).join(', ')}`,
+    )
+  }
+  if (changeDetails.ccs.length > 0) {
+    console.log(`   CCs: ${changeDetails.ccs.map((cc) => formatReviewerLabel(cc)).join(', ')}`)
+  }
   console.log(`   Change-Id: ${changeDetails.id}`)
   console.log()
 
@@ -227,6 +286,22 @@ const formatShowJson = async (
       branch: changeDetails.branch,
       topic: changeDetails.topic,
       owner: removeUndefined(changeDetails.owner),
+      reviewers: changeDetails.reviewers.map((reviewer) =>
+        removeUndefined({
+          account_id: reviewer.accountId,
+          name: reviewer.name,
+          email: reviewer.email,
+          username: reviewer.username,
+        }),
+      ),
+      ccs: changeDetails.ccs.map((cc) =>
+        removeUndefined({
+          account_id: cc.accountId,
+          name: cc.name,
+          email: cc.email,
+          username: cc.username,
+        }),
+      ),
       created: changeDetails.created,
       updated: changeDetails.updated,
     }),
@@ -318,6 +393,44 @@ const formatShowXml = async (
     xmlParts.push(`      <email>${escapeXML(changeDetails.owner.email)}</email>`)
   }
   xmlParts.push(`    </owner>`)
+  xmlParts.push(`    <reviewers>`)
+  xmlParts.push(`      <count>${changeDetails.reviewers.length}</count>`)
+  for (const reviewer of changeDetails.reviewers) {
+    xmlParts.push(`      <reviewer>`)
+    if (reviewer.accountId !== undefined) {
+      xmlParts.push(`        <account_id>${reviewer.accountId}</account_id>`)
+    }
+    if (reviewer.name) {
+      xmlParts.push(`        <name><![CDATA[${sanitizeCDATA(reviewer.name)}]]></name>`)
+    }
+    if (reviewer.email) {
+      xmlParts.push(`        <email>${escapeXML(reviewer.email)}</email>`)
+    }
+    if (reviewer.username) {
+      xmlParts.push(`        <username>${escapeXML(reviewer.username)}</username>`)
+    }
+    xmlParts.push(`      </reviewer>`)
+  }
+  xmlParts.push(`    </reviewers>`)
+  xmlParts.push(`    <ccs>`)
+  xmlParts.push(`      <count>${changeDetails.ccs.length}</count>`)
+  for (const cc of changeDetails.ccs) {
+    xmlParts.push(`      <cc>`)
+    if (cc.accountId !== undefined) {
+      xmlParts.push(`        <account_id>${cc.accountId}</account_id>`)
+    }
+    if (cc.name) {
+      xmlParts.push(`        <name><![CDATA[${sanitizeCDATA(cc.name)}]]></name>`)
+    }
+    if (cc.email) {
+      xmlParts.push(`        <email>${escapeXML(cc.email)}</email>`)
+    }
+    if (cc.username) {
+      xmlParts.push(`        <username>${escapeXML(cc.username)}</username>`)
+    }
+    xmlParts.push(`      </cc>`)
+  }
+  xmlParts.push(`    </ccs>`)
   xmlParts.push(`    <created>${escapeXML(changeDetails.created || '')}</created>`)
   xmlParts.push(`    <updated>${escapeXML(changeDetails.updated || '')}</updated>`)
   xmlParts.push(`  </change>`)

package/src/schemas/gerrit.ts

@@ -1,6 +1,5 @@
 import { Schema } from '@effect/schema'
 
-// Authentication schemas
 export const GerritCredentials: Schema.Schema<{
   readonly host: string
   readonly username: string
@@ -21,7 +20,6 @@ export const GerritCredentials: Schema.Schema<{
 })
 export type GerritCredentials = Schema.Schema.Type<typeof GerritCredentials>
 
-// Forward declare RevisionInfo type for use in ChangeInfo
 export interface RevisionInfoType {
   readonly kind?: string
   readonly _number: number
@@ -65,7 +63,22 @@ export interface RevisionInfoType {
   >
 }
 
-// Change schemas
+type ChangeReviewerAccount = {
+  readonly _account_id?: number
+  readonly name?: string
+  readonly email?: string
+  readonly username?: string
+}
+const ChangeReviewerAccountInfo: Schema.Schema<ChangeReviewerAccount> = Schema.Struct({
+  _account_id: Schema.optional(Schema.Number),
+  name: Schema.optional(Schema.String),
+  email: Schema.optional(Schema.String),
+  username: Schema.optional(Schema.String),
+})
+type ChangeReviewerMap = Partial<
+  Record<'REVIEWER' | 'CC' | 'REMOVED', ReadonlyArray<ChangeReviewerAccount>>
+>
+
 export const ChangeInfo: Schema.Schema<{
   readonly id: string
   readonly project: string
@@ -119,6 +132,7 @@ export const ChangeInfo: Schema.Schema<{
   readonly current_revision?: string
   readonly revisions?: Record<string, RevisionInfoType>
   readonly topic?: string
+  readonly reviewers?: ChangeReviewerMap
 }> = Schema.Struct({
   id: Schema.String,
   project: Schema.String,
@@ -184,10 +198,16 @@ export const ChangeInfo: Schema.Schema<{
   current_revision: Schema.optional(Schema.String),
   revisions: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Any })),
   topic: Schema.optional(Schema.String),
+  reviewers: Schema.optional(
+    Schema.Struct({
+      REVIEWER: Schema.optional(Schema.Array(ChangeReviewerAccountInfo)),
+      CC: Schema.optional(Schema.Array(ChangeReviewerAccountInfo)),
+      REMOVED: Schema.optional(Schema.Array(ChangeReviewerAccountInfo)),
+    }),
+  ),
 })
 export type ChangeInfo = Schema.Schema.Type<typeof ChangeInfo>
 
-// Comment schemas
 export const CommentInput: Schema.Schema<{
   readonly message: string
   readonly unresolved?: boolean
@@ -200,7 +220,6 @@ export const CommentInput: Schema.Schema<{
 })
 export type CommentInput = Schema.Schema.Type<typeof CommentInput>
 
-// Comment info returned from API
 export const CommentInfo: Schema.Schema<{
   readonly id: string
   readonly path?: string
@@ -246,7 +265,6 @@ export const CommentInfo: Schema.Schema<{
 })
 export type CommentInfo = Schema.Schema.Type<typeof CommentInfo>
 
-// Message info for review messages
 export const MessageInfo: Schema.Schema<{
   readonly id: string
   readonly message: string
@@ -319,7 +337,6 @@ export const ReviewInput: Schema.Schema<{
 })
 export type ReviewInput = Schema.Schema.Type<typeof ReviewInput>
 
-// Project schema
 export const ProjectInfo: Schema.Schema<{
   readonly id: string
   readonly name: string
@@ -333,7 +350,6 @@ export const ProjectInfo: Schema.Schema<{
 })
 export type ProjectInfo = Schema.Schema.Type<typeof ProjectInfo>
 
-// File and diff schemas
 export const FileInfo: Schema.Schema<{
   readonly status?: 'A' | 'D' | 'R' | 'C' | 'M'
   readonly lines_inserted?: number

package/tests/show.test.ts

@@ -95,6 +95,27 @@ describe('show command', () => {
       name: 'John Doe',
       email: 'john@example.com',
     },
+    reviewers: {
+      REVIEWER: [
+        {
+          _account_id: 2001,
+          name: 'Jane Reviewer',
+          email: 'jane.reviewer@example.com',
+          username: 'jreviewer',
+        },
+        {
+          email: 'second.reviewer@example.com',
+          username: 'sreviewer',
+        },
+      ],
+      CC: [
+        {
+          _account_id: 2003,
+          name: 'Team Observer',
+          email: 'observer@example.com',
+        },
+      ],
+    },
   })
 
   const mockDiff = `--- a/src/auth.js
@@ -194,6 +215,9 @@ describe('show command', () => {
     expect(output).toContain('Branch: main')
     expect(output).toContain('Status: NEW')
     expect(output).toContain('Owner: John Doe')
+    expect(output).toContain('Reviewers: Jane Reviewer <jane.reviewer@example.com>')
+    expect(output).toContain('second.reviewer@example.com')
+    expect(output).toContain('CCs: Team Observer <observer@example.com>')
     expect(output).toContain('Change-Id: I123abc456def')
     expect(output).toContain('🔍 Diff:')
     expect(output).toContain('💬 Inline Comments:')
@@ -234,6 +258,13 @@ describe('show command', () => {
     expect(output).toContain('<owner>')
     expect(output).toContain('<name><![CDATA[John Doe]]></name>')
     expect(output).toContain('<email>john@example.com</email>')
+    expect(output).toContain('<reviewers>')
+    expect(output).toContain('<count>2</count>')
+    expect(output).toContain('<name><![CDATA[Jane Reviewer]]></name>')
+    expect(output).toContain('<ccs>')
+    expect(output).toContain('<count>1</count>')
+    expect(output).toContain('<name><![CDATA[Team Observer]]></name>')
+    expect(output).not.toContain('<account_id>undefined</account_id>')
     expect(output).toContain('<diff><![CDATA[')
     expect(output).toContain('<comments>')
     expect(output).toContain('<count>3</count>')
@@ -482,6 +513,14 @@ describe('show command', () => {
     expect(parsed.change.branch).toBe('main')
     expect(parsed.change.owner.name).toBe('John Doe')
     expect(parsed.change.owner.email).toBe('john@example.com')
+    expect(Array.isArray(parsed.change.reviewers)).toBe(true)
+    expect(parsed.change.reviewers.length).toBe(2)
+    expect(parsed.change.reviewers[0].name).toBe('Jane Reviewer')
+    expect(parsed.change.reviewers[1].email).toBe('second.reviewer@example.com')
+    expect(parsed.change.reviewers[1].account_id).toBeUndefined()
+    expect(Array.isArray(parsed.change.ccs)).toBe(true)
+    expect(parsed.change.ccs.length).toBe(1)
+    expect(parsed.change.ccs[0].name).toBe('Team Observer')
 
     // Check diff is present
     expect(parsed.diff).toContain('src/auth.js')
@@ -611,6 +650,93 @@ describe('show command', () => {
     expect(parsed.messages[0].revision).toBe(2)
   })
 
+  test('should fetch reviewers from listChanges when getChange lacks reviewer data', async () => {
+    let listChangesOptions: string[] = []
+    let listChangesQuery = ''
+
+    const changeWithoutReviewers = {
+      ...mockChange,
+      reviewers: undefined,
+    }
+
+    server.use(
+      http.get('*/a/changes/:changeId', ({ request }) => {
+        const url = new URL(request.url)
+        if (url.searchParams.get('o') === 'MESSAGES') {
+          return HttpResponse.text(`)]}'\n${JSON.stringify({ messages: [] })}`)
+        }
+        return HttpResponse.text(`)]}'\n${JSON.stringify(changeWithoutReviewers)}`)
+      }),
+      http.get('*/a/changes/', ({ request }) => {
+        const url = new URL(request.url)
+        listChangesOptions = url.searchParams.getAll('o')
+        listChangesQuery = url.searchParams.get('q') || ''
+        return HttpResponse.text(`)]}'\n${JSON.stringify([mockChange])}`)
+      }),
+      http.get('*/a/changes/:changeId/revisions/current/patch', () => {
+        return HttpResponse.text(btoa(mockDiff))
+      }),
+      http.get('*/a/changes/:changeId/revisions/current/comments', () => {
+        return HttpResponse.text(`)]}'\n${JSON.stringify(mockComments)}`)
+      }),
+    )
+
+    const mockConfigLayer = createMockConfigLayer()
+    const program = showCommand('12345', {}).pipe(
+      Effect.provide(GerritApiServiceLive),
+      Effect.provide(mockConfigLayer),
+    )
+
+    await Effect.runPromise(program)
+
+    expect(listChangesQuery).toBe('change:12345')
+    expect(listChangesOptions).toContain('LABELS')
+    expect(listChangesOptions).toContain('DETAILED_LABELS')
+    expect(listChangesOptions).toContain('DETAILED_ACCOUNTS')
+  })
+
+  test('should not fetch listChanges when reviewer data is explicitly present but empty', async () => {
+    let listChangesCalled = false
+
+    const changeWithEmptyReviewerLists = {
+      ...mockChange,
+      reviewers: {
+        REVIEWER: [],
+        CC: [],
+      },
+    }
+
+    server.use(
+      http.get('*/a/changes/:changeId', ({ request }) => {
+        const url = new URL(request.url)
+        if (url.searchParams.get('o') === 'MESSAGES') {
+          return HttpResponse.text(`)]}'\n${JSON.stringify({ messages: [] })}`)
+        }
+        return HttpResponse.text(`)]}'\n${JSON.stringify(changeWithEmptyReviewerLists)}`)
+      }),
+      http.get('*/a/changes/', () => {
+        listChangesCalled = true
+        return HttpResponse.text(`)]}'\n[]`)
+      }),
+      http.get('*/a/changes/:changeId/revisions/current/patch', () => {
+        return HttpResponse.text(btoa(mockDiff))
+      }),
+      http.get('*/a/changes/:changeId/revisions/current/comments', () => {
+        return HttpResponse.text(`)]}'\n${JSON.stringify(mockComments)}`)
+      }),
+    )
+
+    const mockConfigLayer = createMockConfigLayer()
+    const program = showCommand('12345', {}).pipe(
+      Effect.provide(GerritApiServiceLive),
+      Effect.provide(mockConfigLayer),
+    )
+
+    await Effect.runPromise(program)
+
+    expect(listChangesCalled).toBe(false)
+  })
+
   test('should handle large JSON output without truncation', async () => {
     // Create a large diff to simulate output > 64KB
     const largeDiff = '--- a/large-file.js\n+++ b/large-file.js\n' + 'x'.repeat(100000)

package/tests/submit.test.ts

@@ -132,6 +132,34 @@ describe('submit command', () => {
     expect(output).toContain('Status: MERGED')
   })
 
+  it('should fetch change without detailed reviewer options', async () => {
+    let requestedOptions: string[] = []
+
+    server.use(
+      http.get('*/a/changes/12345', ({ request }) => {
+        const url = new URL(request.url)
+        requestedOptions = url.searchParams.getAll('o')
+        return HttpResponse.text(`)]}'\n${JSON.stringify(mockSubmittableChange)}`)
+      }),
+      http.post('*/a/changes/12345/submit', () => {
+        return HttpResponse.text(`)]}'\n${JSON.stringify(mockSubmitResponse)}`)
+      }),
+    )
+
+    const mockConfigLayer = Layer.succeed(ConfigService, createMockConfigService())
+    const program = submitCommand('12345', {}).pipe(
+      Effect.provide(GerritApiServiceLive),
+      Effect.provide(mockConfigLayer),
+    )
+
+    await Effect.runPromise(program)
+
+    expect(requestedOptions).toContain('CURRENT_REVISION')
+    expect(requestedOptions).toContain('CURRENT_COMMIT')
+    expect(requestedOptions).not.toContain('DETAILED_LABELS')
+    expect(requestedOptions).not.toContain('DETAILED_ACCOUNTS')
+  })
+
   it('should output XML format when --xml flag is used', async () => {
     server.use(
       http.get('*/a/changes/12345', () => {