gitx.do 0.0.1 → 0.0.3

package/dist/cli/commands/review.d.ts

@@ -0,0 +1,457 @@
+/**
+ * @fileoverview Git Review Command - PR-style Diff Review
+ *
+ * This module implements the `gitx review` command which provides an interactive
+ * PR-style review experience for comparing branches or commits. Features include:
+ * - File-by-file navigation with keyboard shortcuts
+ * - Collapsible diff sections
+ * - Split (side-by-side) and unified view modes
+ * - Summary statistics (files changed, insertions, deletions)
+ * - Vim-style navigation (j/k) and arrow key support
+ *
+ * @module cli/commands/review
+ *
+ * @example
+ * // Get review diff between branches
+ * const result = await getReviewDiff(repoPath, 'main', 'feature/auth')
+ * console.log(formatSummary(result.summary))
+ *
+ * @example
+ * // Create interactive UI state
+ * const state = createReviewUIState(result.files)
+ * // Navigate down
+ * const newState = handleArrowNavigation(state, 'down', result.files.length)
+ */
+import type { CommandContext } from '../index';
+/**
+ * Options for the review command.
+ *
+ * @description Configuration options controlling the review behavior
+ * including which branches/commits to compare and display options.
+ *
+ * @property base - Base branch or commit SHA to compare from
+ * @property head - Head branch or commit SHA to compare to
+ * @property interactive - Enable interactive terminal UI
+ * @property split - Use side-by-side split view instead of unified diff
+ */
+export interface ReviewOptions {
+    /** Base branch/commit to compare from */
+    base?: string;
+    /** Head branch/commit to compare to */
+    head?: string;
+    /** Enable interactive mode */
+    interactive?: boolean;
+    /** Split view for side-by-side comparison */
+    split?: boolean;
+}
+/**
+ * Complete result of a review diff operation.
+ *
+ * @description Contains all information needed to display a PR-style review
+ * including file changes, summary statistics, and commit range info.
+ *
+ * @property files - Array of changed files with their diffs
+ * @property summary - Aggregated statistics across all files
+ * @property commitRange - Information about the compared commits/branches
+ */
+export interface ReviewResult {
+    /** Changed files with stats */
+    files: ReviewFile[];
+    /** Summary statistics */
+    summary: ReviewSummary;
+    /** Commit range information */
+    commitRange: CommitRange;
+}
+/**
+ * Information about a single changed file in the review.
+ *
+ * @description Contains the file's change status, line statistics,
+ * UI state (collapsed/expanded), and the actual diff content.
+ *
+ * @property path - File path relative to repository root
+ * @property status - Type of change (added, modified, deleted, renamed)
+ * @property additions - Number of lines added
+ * @property deletions - Number of lines deleted
+ * @property collapsed - Whether the file's diff is collapsed in the UI
+ * @property diff - Raw diff content for the file
+ */
+export interface ReviewFile {
+    /** File path */
+    path: string;
+    /** Change status */
+    status: 'added' | 'modified' | 'deleted' | 'renamed';
+    /** Lines added */
+    additions: number;
+    /** Lines deleted */
+    deletions: number;
+    /** Is file collapsed in UI */
+    collapsed: boolean;
+    /** Diff content */
+    diff: string;
+}
+/**
+ * Summary statistics for a review.
+ *
+ * @description Aggregated statistics across all files in the review,
+ * similar to the summary line in `git diff --stat`.
+ *
+ * @property filesChanged - Total number of files with changes
+ * @property insertions - Total lines added across all files
+ * @property deletions - Total lines deleted across all files
+ */
+export interface ReviewSummary {
+    /** Total files changed */
+    filesChanged: number;
+    /** Total insertions */
+    insertions: number;
+    /** Total deletions */
+    deletions: number;
+}
+/**
+ * Information about the commit range being reviewed.
+ *
+ * @description Contains the resolved commit SHAs and optional branch names
+ * for the base and head of the comparison.
+ *
+ * @property baseCommit - Full SHA of the base commit
+ * @property headCommit - Full SHA of the head commit
+ * @property baseBranch - Branch name if base was a branch (undefined if SHA)
+ * @property headBranch - Branch name if head was a branch (undefined if SHA)
+ * @property commitCount - Number of commits between base and head
+ */
+export interface CommitRange {
+    /** Base commit SHA */
+    baseCommit: string;
+    /** Head commit SHA */
+    headCommit: string;
+    /** Base branch name (if applicable) */
+    baseBranch?: string;
+    /** Head branch name (if applicable) */
+    headBranch?: string;
+    /** Number of commits in range */
+    commitCount: number;
+}
+/**
+ * State for the interactive review UI.
+ *
+ * @description Tracks the current UI state including selection, collapsed
+ * files, view mode, and scroll position. Used for keyboard navigation.
+ *
+ * @property selectedIndex - Index of the currently selected file (0-based)
+ * @property collapsedFiles - Set of file indices that are collapsed
+ * @property viewMode - Current view mode (unified or split)
+ * @property scrollPosition - Current scroll offset for the view
+ */
+export interface ReviewUIState {
+    /** Currently selected file index */
+    selectedIndex: number;
+    /** Collapsed file indices */
+    collapsedFiles: Set<number>;
+    /** View mode */
+    viewMode: 'unified' | 'split';
+    /** Scroll position */
+    scrollPosition: number;
+}
+/**
+ * Definition of a keyboard shortcut for the interactive UI.
+ *
+ * @description Maps a key to an action description and handler function.
+ * Used for help display and key event handling.
+ *
+ * @property key - Key name (e.g., 'j', 'k', 'enter', 'up', 'down')
+ * @property action - Human-readable description of the action
+ * @property handler - Function to call when key is pressed
+ */
+export interface KeyboardShortcut {
+    /** Key name */
+    key: string;
+    /** Action description */
+    action: string;
+    /** Handler function */
+    handler: () => void;
+}
+/**
+ * Execute the review command from the CLI.
+ *
+ * @description Main entry point for the `gitx review` command. Parses
+ * command-line options and displays an interactive PR-style diff review.
+ *
+ * @param _ctx - Command context (unused in current implementation)
+ * @returns Promise that resolves when review is complete
+ * @throws {Error} Always throws "Not implemented" - command not yet implemented
+ *
+ * @example
+ * // CLI usage
+ * // gitx review main..feature/auth
+ * // gitx review --split main feature/auth
+ * // gitx review --interactive
+ */
+export declare function reviewCommand(_ctx: CommandContext): Promise<void>;
+/**
+ * Get review diff between two branches.
+ *
+ * @description Computes a complete PR-style diff between two branches or commits.
+ * Returns all changed files with their diffs, summary statistics, and commit range.
+ *
+ * @param repoPath - Path to the git repository
+ * @param baseBranch - Base branch or commit SHA (the "before" state)
+ * @param headBranch - Head branch or commit SHA (the "after" state)
+ * @returns Promise resolving to complete review result
+ *
+ * @example
+ * const result = await getReviewDiff('/path/to/repo', 'main', 'feature/auth')
+ * console.log(`${result.summary.filesChanged} files changed`)
+ * console.log(`+${result.summary.insertions} -${result.summary.deletions}`)
+ */
+export declare function getReviewDiff(repoPath: string, baseBranch: string, headBranch: string): Promise<ReviewResult>;
+/**
+ * List changed files with statistics.
+ *
+ * @description Gets a list of all files that differ between two branches/commits
+ * with their change status and line statistics.
+ *
+ * @param _repoPath - Path to the git repository (unused in current impl)
+ * @param baseBranch - Base branch or commit SHA
+ * @param headBranch - Head branch or commit SHA
+ * @returns Promise resolving to array of changed files, sorted by path
+ *
+ * @example
+ * const files = await listChangedFiles(repoPath, 'main', 'feature')
+ * for (const file of files) {
+ *   console.log(`${file.status}: ${file.path} (+${file.additions}, -${file.deletions})`)
+ * }
+ */
+export declare function listChangedFiles(_repoPath: string, baseBranch: string, headBranch: string): Promise<ReviewFile[]>;
+/**
+ * Get commit range information.
+ *
+ * @description Resolves branch names to commit SHAs and returns information
+ * about the commit range being compared.
+ *
+ * @param repoPath - Path to the git repository
+ * @param baseBranch - Base branch name or commit SHA
+ * @param headBranch - Head branch name or commit SHA
+ * @returns Promise resolving to commit range information
+ *
+ * @example
+ * const range = await getCommitRange(repoPath, 'main', 'feature')
+ * console.log(`Comparing ${range.baseCommit}..${range.headCommit}`)
+ * console.log(`${range.commitCount} commits`)
+ */
+export declare function getCommitRange(repoPath: string, baseBranch: string, headBranch: string): Promise<CommitRange>;
+/**
+ * Calculate review summary from changed files.
+ *
+ * @description Aggregates statistics from all changed files into a summary.
+ *
+ * @param files - Array of changed files
+ * @returns Summary with total files, insertions, and deletions
+ *
+ * @example
+ * const summary = calculateSummary(files)
+ * console.log(`${summary.filesChanged} files, +${summary.insertions}, -${summary.deletions}`)
+ */
+export declare function calculateSummary(files: ReviewFile[]): ReviewSummary;
+/**
+ * Create initial interactive review UI state.
+ *
+ * @description Initializes UI state with first file selected, all files expanded,
+ * unified view mode, and scroll position at top.
+ *
+ * @param _files - Array of files (used for validation, currently unused)
+ * @returns Initial UI state ready for interaction
+ *
+ * @example
+ * const state = createReviewUIState(result.files)
+ * // state.selectedIndex === 0
+ * // state.viewMode === 'unified'
+ */
+export declare function createReviewUIState(_files: ReviewFile[]): ReviewUIState;
+/**
+ * Handle arrow key navigation.
+ *
+ * @description Updates the selected file index based on arrow key input.
+ * Clamps the index to valid bounds (0 to fileCount-1).
+ *
+ * @param state - Current UI state
+ * @param direction - Navigation direction ('up' or 'down')
+ * @param fileCount - Total number of files (for bounds checking)
+ * @returns New UI state with updated selectedIndex
+ *
+ * @example
+ * let state = createReviewUIState(files)
+ * state = handleArrowNavigation(state, 'down', files.length) // selectedIndex: 1
+ * state = handleArrowNavigation(state, 'up', files.length)   // selectedIndex: 0
+ */
+export declare function handleArrowNavigation(state: ReviewUIState, direction: 'up' | 'down', fileCount: number): ReviewUIState;
+/**
+ * Toggle file collapse/expand state.
+ *
+ * @description Toggles whether a file's diff is collapsed or expanded.
+ * Collapsed files show only the header, expanded files show the full diff.
+ *
+ * @param state - Current UI state
+ * @param fileIndex - Index of file to toggle
+ * @returns New UI state with updated collapsedFiles set
+ *
+ * @example
+ * let state = createReviewUIState(files)
+ * state = toggleFileCollapse(state, 0) // File 0 is now collapsed
+ * state = toggleFileCollapse(state, 0) // File 0 is now expanded
+ */
+export declare function toggleFileCollapse(state: ReviewUIState, fileIndex: number): ReviewUIState;
+/**
+ * Handle vim-style navigation (j/k keys).
+ *
+ * @description Provides vim-style navigation where 'j' moves down and 'k' moves up.
+ * Delegates to handleArrowNavigation for actual implementation.
+ *
+ * @param state - Current UI state
+ * @param key - Vim navigation key ('j' for down, 'k' for up)
+ * @param fileCount - Total number of files
+ * @returns New UI state with updated selectedIndex
+ *
+ * @example
+ * let state = createReviewUIState(files)
+ * state = handleVimNavigation(state, 'j', files.length) // Move down
+ * state = handleVimNavigation(state, 'k', files.length) // Move up
+ */
+export declare function handleVimNavigation(state: ReviewUIState, key: 'j' | 'k', fileCount: number): ReviewUIState;
+/**
+ * Handle quit shortcut (q key).
+ *
+ * @description Exits the interactive review mode. In the current implementation,
+ * this is a no-op placeholder for the quit functionality.
+ *
+ * @example
+ * // When 'q' is pressed in interactive mode
+ * handleQuit()
+ */
+export declare function handleQuit(): void;
+/**
+ * Get list of available keyboard shortcuts.
+ *
+ * @description Returns all keyboard shortcuts available in the interactive
+ * review mode for display in help or key handling.
+ *
+ * @returns Array of keyboard shortcut definitions
+ *
+ * @example
+ * const shortcuts = getKeyboardShortcuts()
+ * for (const shortcut of shortcuts) {
+ *   console.log(`${shortcut.key}: ${shortcut.action}`)
+ * }
+ */
+export declare function getKeyboardShortcuts(): KeyboardShortcut[];
+/**
+ * Render split view (side-by-side comparison).
+ *
+ * @description Renders a file diff in split view mode with old content on
+ * the left and new content on the right, separated by a vertical bar.
+ *
+ * @param file - File with diff content to render
+ * @param terminalWidth - Terminal width in characters for column sizing
+ * @returns Array of formatted lines for display
+ *
+ * @example
+ * const lines = renderSplitView(file, 120)
+ * for (const line of lines) {
+ *   console.log(line) // "old content      | new content"
+ * }
+ */
+export declare function renderSplitView(file: ReviewFile, terminalWidth: number): string[];
+/**
+ * Render unified view.
+ *
+ * @description Renders a file diff in unified view mode with additions and
+ * deletions interspersed (like standard `git diff` output).
+ *
+ * @param file - File with diff content to render
+ * @returns Array of non-empty diff lines
+ *
+ * @example
+ * const lines = renderUnifiedView(file)
+ * for (const line of lines) {
+ *   console.log(line) // "+added line" or "-removed line" or " context"
+ * }
+ */
+export declare function renderUnifiedView(file: ReviewFile): string[];
+/**
+ * Toggle between split and unified view modes.
+ *
+ * @description Switches the view mode between 'unified' (interleaved) and
+ * 'split' (side-by-side) diff display.
+ *
+ * @param state - Current UI state
+ * @returns New UI state with toggled viewMode
+ *
+ * @example
+ * let state = createReviewUIState(files) // viewMode: 'unified'
+ * state = toggleViewMode(state)          // viewMode: 'split'
+ * state = toggleViewMode(state)          // viewMode: 'unified'
+ */
+export declare function toggleViewMode(state: ReviewUIState): ReviewUIState;
+/**
+ * Format summary for display.
+ *
+ * @description Formats the review summary as a human-readable string similar
+ * to the summary line in GitHub PR diffs.
+ *
+ * @param summary - Review summary with statistics
+ * @returns Formatted string like "3 files changed, +150, -42"
+ *
+ * @example
+ * const formatted = formatSummary({ filesChanged: 3, insertions: 150, deletions: 42 })
+ * // "3 files changed, +150, -42"
+ */
+export declare function formatSummary(summary: ReviewSummary): string;
+/**
+ * Format file statistics line.
+ *
+ * @description Formats a single file's change statistics as a human-readable
+ * string showing path and line counts.
+ *
+ * @param file - File with change statistics
+ * @returns Formatted string like "src/index.ts | +25 -10"
+ *
+ * @example
+ * const formatted = formatFileStats(file)
+ * // "src/index.ts | +25 -10"
+ */
+export declare function formatFileStats(file: ReviewFile): string;
+/**
+ * Handle no changes between branches.
+ *
+ * @description Returns a message indicating there are no differences between
+ * the specified branches.
+ *
+ * @param baseBranch - Base branch name
+ * @param headBranch - Head branch name
+ * @returns Message string indicating no changes
+ *
+ * @example
+ * const message = handleNoChanges('main', 'feature')
+ * // "No changes between main and feature"
+ */
+export declare function handleNoChanges(baseBranch: string, headBranch: string): string;
+/**
+ * Check if branches have changes between them.
+ *
+ * @description Determines whether there are any differences between two
+ * branches by comparing their resolved commit SHAs.
+ *
+ * @param repoPath - Path to the git repository
+ * @param baseBranch - Base branch or commit SHA
+ * @param headBranch - Head branch or commit SHA
+ * @returns Promise resolving to true if branches differ, false if identical
+ *
+ * @example
+ * if (await hasChanges(repoPath, 'main', 'feature')) {
+ *   const result = await getReviewDiff(repoPath, 'main', 'feature')
+ *   // Display diff...
+ * } else {
+ *   console.log('Branches are identical')
+ * }
+ */
+export declare function hasChanges(repoPath: string, baseBranch: string, headBranch: string): Promise<boolean>;
+//# sourceMappingURL=review.d.ts.map

package/dist/cli/commands/review.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/review.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAQ9C;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa;IAC5B,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8BAA8B;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,yBAAyB;IACzB,OAAO,EAAE,aAAa,CAAA;IACtB,+BAA+B;IAC/B,WAAW,EAAE,WAAW,CAAA;CACzB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,UAAU;IACzB,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,oBAAoB;IACpB,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAA;IACpD,kBAAkB;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,8BAA8B;IAC9B,SAAS,EAAE,OAAO,CAAA;IAClB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAA;IACpB,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,WAAW;IAC1B,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa;IAC5B,oCAAoC;IACpC,aAAa,EAAE,MAAM,CAAA;IACrB,6BAA6B;IAC7B,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC3B,gBAAgB;IAChB,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAA;IAC7B,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB;IAC/B,eAAe;IACf,GAAG,EAAE,MAAM,CAAA;IACX,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,uBAAuB;IACvB,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB;AAsFD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvE;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,aAAa,CACjC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,YAAY,CAAC,CAUvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,gBAAgB,CACpC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,EAAE,CAAC,CAYvB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,cAAc,CAClC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,WAAW,CAAC,CActB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,aAAa,CAcnE;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,aAAa,CAOvE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,IAAI,GAAG,MAAM,EACxB,SAAS,EAAE,MAAM,GAChB,aAAa,CAaf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,MAAM,GAChB,aAAa,CAaf;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,aAAa,EACpB,GAAG,EAAE,GAAG,GAAG,GAAG,EACd,SAAS,EAAE,MAAM,GAChB,aAAa,CAGf;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,IAAI,IAAI,CAGjC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,IAAI,gBAAgB,EAAE,CASzD;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,UAAU,EAChB,aAAa,EAAE,MAAM,GACpB,MAAM,EAAE,CAoBV;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE,CAG5D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,CAKlE;AAMD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAExD;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,MAAM,CAER;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,UAAU,CAC9B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,OAAO,CAAC,CAWlB"}