pi-diff-review 0.1.15 → 0.1.17

package/README.md

@@ -62,6 +62,7 @@ Review a branch or commit range by passing any `git diff` arguments after `/diff
 - `/diff --cached` reviews staged changes
 - `/diff main...HEAD` reviews changes on the current branch relative to `main`
 - `/diff <git-diff-args>` passes arguments through to `git diff`
+- `h` toggles the command help modal
 - `j/k` or arrow keys to move
 - `g/G` to jump to the top or bottom of the diff
 - `ctrl-u` / `ctrl-d` to move up/down by half a page
@@ -79,21 +80,6 @@ Review a branch or commit range by passing any `git diff` arguments after `/diff
 - Comments are cached per session and restored when reopening the same diff
 - `q` to exit
 
-## Development
+## Contributing
 
-Install [pre-commit](https://pre-commit.com/) and enable the repository hooks to run typechecking, tests, and formatting checks before each commit:
-
-```bash
-pre-commit install
-```
-
-Run the same checks manually with either:
-
-```bash
-pre-commit run --all-files
-npm run precommit
-```
-
-## Release
-
-See [RELEASE.md](./RELEASE.md).
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development and release instructions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-diff-review",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "description": "Local diff review TUI extension for pi",
   "license": "MIT",
   "type": "module",

package/src/{diff-parser.ts → diff/parser.ts}

@@ -5,7 +5,7 @@ import type {
   FileDiffMetadata,
   Hunk,
 } from "@pierre/diffs";
-import type { ReviewLine } from "./types.ts";
+import type { ReviewLine } from "../review/types.ts";
 
 export function parseDiff(diffText: string): ReviewLine[] {
   try {

package/src/{diff-source.ts → diff/source.ts}

@@ -1,5 +1,5 @@
 import { spawnSync } from "node:child_process";
-import type { DiffSource } from "./types.ts";
+import type { DiffSource } from "../review/types.ts";
 
 export function parseDiffSource(args: string): DiffSource {
   const trimmed = args.trim();

package/src/{split-diff.ts → diff/split.ts}

@@ -1,4 +1,8 @@
-import type { ReviewLine, SplitDiffCell, SplitDiffRow } from "./types.ts";
+import type {
+  ReviewLine,
+  SplitDiffCell,
+  SplitDiffRow,
+} from "../review/types.ts";
 
 export type SplitDiffRowsResult = {
   rows: SplitDiffRow[];

package/src/{explanation-controller.ts → explanation/controller.ts}

@@ -2,8 +2,8 @@ import type {
   DiffExplainer,
   ExplanationScope,
   ExplanationState,
-} from "./explain.ts";
-import type { ReviewLine, ReviewTui } from "./types.ts";
+} from "./explainer.ts";
+import type { ReviewLine, ReviewTui } from "../review/types.ts";
 
 const LOADING_FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
 

package/src/index.ts

@@ -3,12 +3,16 @@ import type {
   ExtensionAPI,
   ExtensionCommandContext,
 } from "@earendil-works/pi-coding-agent";
-import { getDiff, parseDiffSource } from "./diff-source.ts";
-import { parseDiff } from "./diff-parser.ts";
-import { PiModelDiffExplainer } from "./explain.ts";
-import { buildReviewPrompt } from "./prompt.ts";
-import { ReviewComponent } from "./review-component.ts";
-import type { DiffSource, ReviewComment, ReviewResult } from "./types.ts";
+import { getDiff, parseDiffSource } from "./diff/source.ts";
+import { parseDiff } from "./diff/parser.ts";
+import { PiModelDiffExplainer } from "./explanation/explainer.ts";
+import { buildReviewPrompt } from "./review/prompt.ts";
+import { ReviewComponent } from "./review/component.ts";
+import type {
+  DiffSource,
+  ReviewComment,
+  ReviewResult,
+} from "./review/types.ts";
 
 const DIFF_REVIEW_CACHE_ENTRY = "pi-diff-review-cache";
 const DIFF_REVIEW_EXPLANATION_CACHE_ENTRY = "pi-diff-review-explanation-cache";

package/src/{review-component.ts → review/component.ts}

@@ -9,22 +9,23 @@ import {
   visibleWidth,
   wrapTextWithAnsi,
 } from "@earendil-works/pi-tui";
-import type { DiffExplainer } from "./explain.ts";
+import type { DiffExplainer } from "../explanation/explainer.ts";
 import {
   GLOBAL_COMMENT_KEY,
   buildCommentFromSelection,
   buildCommentLineKeys,
   buildGlobalComment,
   getSelectionKey,
-} from "./comment-manager.ts";
+} from "./comments.ts";
 import {
   ExplanationController,
   getCurrentHunkScope,
-} from "./explanation-controller.ts";
+} from "../explanation/controller.ts";
 import { formatCommentLocation, formatLocation } from "./prompt.ts";
-import { ReviewNavigationState } from "./review-navigation.ts";
-import { padToWidth, lineNumberCell } from "./render-utils.ts";
-import { buildSplitDiffRows } from "./split-diff.ts";
+import { ReviewNavigationState } from "./navigation.ts";
+import { ReviewSearchState } from "./search.ts";
+import { padToWidth, lineNumberCell } from "../render/utils.ts";
+import { buildSplitDiffRows } from "../diff/split.ts";
 import type {
   DiffRenderMode,
   ReviewComment,
@@ -50,14 +51,32 @@ type AnnotatedDiffRow =
   | { kind: "split"; splitRowIndex: number }
   | InlineBoxRow;
 
+const HELP_COMMANDS = [
+  ["h", "show or hide this help"],
+  ["j/k or arrows", "move selection"],
+  ["ctrl-u / ctrl-d", "move up or down half a page"],
+  ["g / G", "jump to top or bottom"],
+  ["n / p", "jump to next or previous hunk"],
+  ["/", "search diff lines"],
+  ["n / N", "jump between search matches"],
+  ["J / K", "extend highlighted selection"],
+  ["c", "add or edit a line or range comment"],
+  ["C", "add or edit an overall diff comment"],
+  ["x", "delete the current line or range comment"],
+  ["t", "toggle inline comments and explanations"],
+  ["v", "toggle unified or split rendering"],
+  ["?", "toggle AI explanation for current hunk"],
+  ["Enter", "submit comments, save edits, or jump to search result"],
+  ["Esc", "close help, cancel search/edit, clear selection, or exit"],
+  ["q", "exit review"],
+] as const;
+
 export class ReviewComponent {
   private navigation: ReviewNavigationState;
   private editMode = false;
   private editingCommentKey?: string;
-  private searchMode = false;
-  private searchQuery = "";
-  private draftSearchQuery = "";
-  private searchMessage = "";
+  private search: ReviewSearchState;
+  private helpVisible = false;
 
   private inlineAnnotationsVisible = true;
   private visibleExplanationKeys = new Set<string>();
@@ -97,6 +116,7 @@ export class ReviewComponent {
       firstCommentable >= 0 ? firstCommentable : 0,
     );
     this.lines.forEach((line, index) => this.lineIndexById.set(line.id, index));
+    this.search = new ReviewSearchState(this.lines);
     this.explanationController = new ExplanationController(
       tui,
       explainer,
@@ -172,6 +192,13 @@ export class ReviewComponent {
   }
 
   handleInput(data: string): void {
+    if (this.helpVisible) {
+      if (data === "h" || matchesKey(data, "escape")) {
+        this.toggleHelp();
+      }
+      return;
+    }
+
     if (this.editMode) {
       if (matchesKey(data, "escape") || matchesKey(data, "ctrl+c")) {
         this.exitEditMode();
@@ -183,13 +210,13 @@ export class ReviewComponent {
       return;
     }
 
-    if (this.searchMode) {
+    if (this.search.mode) {
       this.handleSearchInput(data);
       return;
     }
 
     if (matchesKey(data, "escape")) {
-      if (this.searchQuery) {
+      if (this.search.query) {
         this.clearSearch();
       } else if (this.hasSelection()) {
         this.clearSelection();
@@ -202,6 +229,10 @@ export class ReviewComponent {
       this.done({ action: "cancel" });
       return;
     }
+    if (data === "h") {
+      this.toggleHelp();
+      return;
+    }
     if (data === "t") {
       this.toggleInlineAnnotations();
       return;
@@ -251,14 +282,14 @@ export class ReviewComponent {
       return;
     }
     if (data === "n") {
-      if (this.searchQuery) {
+      if (this.search.query) {
         this.jumpSearch(1);
       } else {
         this.jumpHunk(1);
       }
       return;
     }
-    if (data === "N" && this.searchQuery) {
+    if (data === "N" && this.search.query) {
       this.jumpSearch(-1);
       return;
     }
@@ -293,15 +324,9 @@ export class ReviewComponent {
     const output: string[] = [];
 
     output.push(
-      truncateToWidth(
-        this.theme.fg(
-          "dim",
-          this.editMode
-            ? `${this.title} • ${this.lines.length} lines • ${this.comments.size} comments • editing inline comment • Enter save • Esc/Ctrl+C cancel`
-            : this.hasSelection()
-              ? `${this.title} • ${this.lines.length} lines • ${this.comments.size} comments • J/K extend • Esc clear selection • c comment range • C overall comment • Enter submit`
-              : `${this.title} • ${this.lines.length} lines • ${this.comments.size} comments • ${this.getPositionText(selectedLine)} • inline ${this.inlineAnnotationsVisible ? "shown" : "hidden"} • j/k move • g/G top/bottom • ctrl-u/d page • / search • t annotations • v unified/split • ? explain • J/K extend • c comment • C overall • x delete • ${this.searchQuery ? "n/N search" : "n/p hunk"} • Enter submit • q quit`,
-        ),
+      this.renderStatusLine(
+        this.getHeaderText(selectedLine),
+        "Press h for help",
         width,
       ),
     );
@@ -315,9 +340,132 @@ export class ReviewComponent {
         width,
       ),
     );
+    return this.helpVisible ? this.renderHelpModal(output, width) : output;
+  }
+
+  private getHeaderText(selectedLine?: ReviewLine): string {
+    const base = `${this.title} • ${this.lines.length} lines • ${this.comments.size} comments`;
+
+    if (this.editMode) {
+      return `${base} • editing ${this.editingCommentKey === GLOBAL_COMMENT_KEY ? "overall comment" : "inline comment"}`;
+    }
+
+    if (this.hasSelection()) {
+      return `${base} • selection active`;
+    }
+
+    return `${base} • ${this.getPositionText(selectedLine)} • inline ${this.inlineAnnotationsVisible ? "shown" : "hidden"} • ${this.diffRenderMode}`;
+  }
+
+  private renderStatusLine(left: string, right: string, width: number): string {
+    const styledLeft = this.theme.fg("dim", left);
+    const styledRight = this.theme.fg("muted", right);
+    const rightWidth = visibleWidth(styledRight);
+    const leftWidth = Math.max(0, width - rightWidth - 1);
+    const truncatedLeft = truncateToWidth(styledLeft, leftWidth);
+    const spacer = Math.max(
+      1,
+      width - visibleWidth(truncatedLeft) - rightWidth,
+    );
+    return truncateToWidth(
+      `${truncatedLeft}${" ".repeat(spacer)}${styledRight}`,
+      width,
+    );
+  }
+
+  private renderHelpModal(rows: string[], width: number): string[] {
+    if (rows.length === 0 || width < 8) return rows;
+
+    const modalWidth = Math.max(8, Math.min(72, width - 2));
+    const contentWidth = Math.max(4, modalWidth - 4);
+    const keyWidth = Math.min(16, Math.max(8, Math.floor(contentWidth * 0.35)));
+    const modalRows = this.buildHelpModalRows(
+      modalWidth,
+      contentWidth,
+      keyWidth,
+    );
+    const maxRows = Math.max(1, rows.length - 2);
+    const visibleModalRows =
+      modalRows.length > maxRows
+        ? [
+            ...modalRows.slice(0, maxRows - 1),
+            this.renderModalRow(
+              this.theme.fg("dim", "More commands available on taller screens"),
+              contentWidth,
+            ),
+          ]
+        : modalRows;
+    const top = Math.max(
+      1,
+      Math.floor((rows.length - visibleModalRows.length) / 2),
+    );
+    const left = Math.max(0, Math.floor((width - modalWidth) / 2));
+
+    const output = [...rows];
+    for (let index = 0; index < visibleModalRows.length; index++) {
+      const row = visibleModalRows[index]!;
+      output[top + index] = padToWidth(
+        truncateToWidth(`${" ".repeat(left)}${row}`, width),
+        width,
+      );
+    }
     return output;
   }
 
+  private buildHelpModalRows(
+    modalWidth: number,
+    contentWidth: number,
+    keyWidth: number,
+  ): string[] {
+    const rows = [
+      this.renderModalHorizontal(" Help ", modalWidth, "top"),
+      this.renderModalRow(
+        this.theme.fg("dim", "Press h or Esc to close."),
+        contentWidth,
+      ),
+      this.renderModalRow("", contentWidth),
+    ];
+
+    for (const [keys, description] of HELP_COMMANDS) {
+      const keyCell = padToWidth(
+        truncateToWidth(this.theme.fg("accent", keys), keyWidth),
+        keyWidth,
+      );
+      rows.push(
+        this.renderModalRow(
+          `${keyCell} ${this.theme.fg("text", description)}`,
+          contentWidth,
+        ),
+      );
+    }
+
+    rows.push(this.renderModalHorizontal("", modalWidth, "bottom"));
+    return rows;
+  }
+
+  private renderModalRow(text: string, contentWidth: number): string {
+    return `${this.theme.fg("borderMuted", "│")} ${padToWidth(
+      truncateToWidth(text, contentWidth),
+      contentWidth,
+    )} ${this.theme.fg("borderMuted", "│")}`;
+  }
+
+  private renderModalHorizontal(
+    title: string,
+    width: number,
+    part: "top" | "bottom",
+  ): string {
+    const contentWidth = Math.max(0, width - 2);
+    const visibleTitle = truncateToWidth(title, contentWidth);
+    const remaining = Math.max(0, contentWidth - visibleWidth(visibleTitle));
+    const left = part === "top" ? "╭" : "╰";
+    const right = part === "top" ? "╮" : "╯";
+    return `${this.theme.fg("borderMuted", left)}${visibleTitle}${this.theme.fg(
+      "borderMuted",
+      "─".repeat(remaining),
+    )}${this.theme.fg("borderMuted", right)}`;
+  }
+
   private renderAnnotatedDiffRows(width: number, height: number): string[] {
     const rows = this.getAnnotatedRows(width);
     const output: string[] = [];
@@ -767,6 +915,11 @@ export class ReviewComponent {
     this.tui.requestRender(true);
   }
 
+  private toggleHelp(): void {
+    this.helpVisible = !this.helpVisible;
+    this.tui.requestRender(true);
+  }
+
   private hideInlineExplanation(): void {
     this.visibleExplanationKeys.clear();
   }
@@ -869,11 +1022,11 @@ export class ReviewComponent {
   }
 
   private getFooterText(selectedLine?: ReviewLine): string {
-    if (this.searchMode) {
-      return `Search: /${this.draftSearchQuery} • Enter jump • Esc cancel`;
+    if (this.search.mode) {
+      return `Search: /${this.search.draftQuery} • Enter jump • Esc cancel`;
     }
 
-    const searchStatus = this.getSearchStatusText();
+    const searchStatus = this.search.getStatusText(this.selected);
     if (searchStatus) return searchStatus;
 
     const selection = this.getSelectionBounds();
@@ -886,21 +1039,6 @@ export class ReviewComponent {
     return `Selected: ${selectedLine ? formatLocation(selectedLine) : "(no selection)"}`;
   }
 
-  private getSearchStatusText(): string {
-    if (this.searchMessage) return this.searchMessage;
-    if (!this.searchQuery) return "";
-
-    const matches = this.getSearchMatchIndexes(this.searchQuery);
-    if (matches.length === 0) return `No matches for /${this.searchQuery}`;
-
-    const current = matches.findIndex((index) => index === this.selected);
-    const position =
-      current >= 0
-        ? `${current + 1}/${matches.length}`
-        : `${matches.length} matches`;
-    return `Search /${this.searchQuery} • ${position} • n next • N previous • Esc clear search`;
-  }
-
   private jumpHunk(direction: 1 | -1): void {
     let index = this.selected + direction;
     while (index >= 0 && index < this.lines.length) {
@@ -965,92 +1103,27 @@ export class ReviewComponent {
   }
 
   private startSearchMode(): void {
-    this.searchMode = true;
-    this.draftSearchQuery = this.searchQuery;
-    this.searchMessage = "";
+    this.search.start();
     this.tui.requestRender();
   }
 
   private handleSearchInput(data: string): void {
-    if (matchesKey(data, "escape") || matchesKey(data, "ctrl+c")) {
-      this.searchMode = false;
-      this.draftSearchQuery = "";
-      this.tui.requestRender();
-      return;
-    }
-
-    if (matchesKey(data, "enter")) {
-      const query = this.draftSearchQuery.trim();
-      this.searchMode = false;
-      this.draftSearchQuery = "";
-      this.searchQuery = query;
-      this.searchMessage = "";
-      if (query) {
-        this.jumpSearch(1);
-      } else {
-        this.tui.requestRender();
-      }
-      return;
-    }
-
-    if (matchesKey(data, "ctrl+u")) {
-      this.draftSearchQuery = "";
-      this.tui.requestRender();
-      return;
-    }
-
-    if (matchesKey(data, "backspace") || data === "\u007f" || data === "\b") {
-      this.draftSearchQuery = this.draftSearchQuery.slice(0, -1);
-      this.tui.requestRender();
-      return;
-    }
-
-    if (data.length === 1 && data >= " " && data !== "\u007f") {
-      this.draftSearchQuery += data;
-      this.tui.requestRender();
-    }
+    const result = this.search.handleInput(data, this.selected);
+    if (result.selected != null) this.selected = result.selected;
+    this.tui.requestRender();
   }
 
   private clearSearch(): void {
-    this.searchMode = false;
-    this.searchQuery = "";
-    this.draftSearchQuery = "";
-    this.searchMessage = "";
+    this.search.clear();
     this.tui.requestRender();
   }
 
   private jumpSearch(direction: 1 | -1): void {
-    const query = this.searchQuery.trim();
-    if (!query) return;
-
-    const matches = this.getSearchMatchIndexes(query);
-    if (matches.length === 0) {
-      this.searchMessage = `No matches for /${query}`;
-      this.tui.requestRender();
-      return;
-    }
-
-    this.searchMessage = "";
-    const current =
-      direction === 1
-        ? matches.find((index) => index > this.selected)
-        : [...matches].reverse().find((index) => index < this.selected);
-    this.selected =
-      current ?? (direction === 1 ? matches[0]! : matches[matches.length - 1]!);
+    const result = this.search.jump(direction, this.selected);
+    if (result.selected != null) this.selected = result.selected;
     this.tui.requestRender();
   }
 
-  private getSearchMatchIndexes(query: string): number[] {
-    const needle = query.toLocaleLowerCase();
-    if (!needle) return [];
-
-    const matches: number[] = [];
-    this.lines.forEach((line, index) => {
-      if (line.text.toLocaleLowerCase().includes(needle)) matches.push(index);
-    });
-    return matches;
-  }
-
   private getSplitDiffRows(): SplitDiffRow[] {
     if (this.splitRows) return this.splitRows;
 
@@ -1100,11 +1173,11 @@ export class ReviewComponent {
   }
 
   private getDisplayText(line: ReviewLine): string {
-    return line.kind === "add" ||
-      line.kind === "remove" ||
-      line.kind === "context"
-      ? line.text.slice(1)
-      : line.text;
+    const raw =
+      line.kind === "add" || line.kind === "remove" || line.kind === "context"
+        ? line.text.slice(1)
+        : line.text;
+    return expandTabs(raw);
   }
 
   private applyDiffBackground(
@@ -1186,3 +1259,19 @@ export class ReviewComponent {
     return getCurrentHunkScope(this.lines, this.selected);
   }
 }
+
+function expandTabs(text: string, tabSize = 4): string {
+  let result = "";
+  let col = 0;
+  for (const char of text) {
+    if (char === "\t") {
+      const spaces = tabSize - (col % tabSize);
+      result += " ".repeat(spaces);
+      col += spaces;
+    } else {
+      result += char;
+      col++;
+    }
+  }
+  return result;
+}

package/src/review/search.ts

@@ -0,0 +1,109 @@
+import { matchesKey } from "@earendil-works/pi-tui";
+import type { ReviewLine } from "./types.ts";
+
+export type SearchInputResult = {
+  selected?: number;
+};
+
+export class ReviewSearchState {
+  mode = false;
+  query = "";
+  draftQuery = "";
+  message = "";
+
+  constructor(private readonly lines: ReviewLine[]) {}
+
+  start(): void {
+    this.mode = true;
+    this.draftQuery = this.query;
+    this.message = "";
+  }
+
+  handleInput(data: string, selected: number): SearchInputResult {
+    if (matchesKey(data, "escape") || matchesKey(data, "ctrl+c")) {
+      this.mode = false;
+      this.draftQuery = "";
+      return {};
+    }
+
+    if (matchesKey(data, "enter")) {
+      const query = this.draftQuery.trim();
+      this.mode = false;
+      this.draftQuery = "";
+      this.query = query;
+      this.message = "";
+      return query ? this.jump(1, selected) : {};
+    }
+
+    if (matchesKey(data, "ctrl+u")) {
+      this.draftQuery = "";
+      return {};
+    }
+
+    if (matchesKey(data, "backspace") || data === "\u007f" || data === "\b") {
+      this.draftQuery = this.draftQuery.slice(0, -1);
+      return {};
+    }
+
+    if (data.length === 1 && data >= " " && data !== "\u007f") {
+      this.draftQuery += data;
+    }
+
+    return {};
+  }
+
+  clear(): void {
+    this.mode = false;
+    this.query = "";
+    this.draftQuery = "";
+    this.message = "";
+  }
+
+  jump(direction: 1 | -1, selected: number): SearchInputResult {
+    const query = this.query.trim();
+    if (!query) return {};
+
+    const matches = this.getMatchIndexes(query);
+    if (matches.length === 0) {
+      this.message = `No matches for /${query}`;
+      return {};
+    }
+
+    this.message = "";
+    const current =
+      direction === 1
+        ? matches.find((index) => index > selected)
+        : [...matches].reverse().find((index) => index < selected);
+    return {
+      selected:
+        current ??
+        (direction === 1 ? matches[0]! : matches[matches.length - 1]!),
+    };
+  }
+
+  getStatusText(selected: number): string {
+    if (this.message) return this.message;
+    if (!this.query) return "";
+
+    const matches = this.getMatchIndexes(this.query);
+    if (matches.length === 0) return `No matches for /${this.query}`;
+
+    const current = matches.findIndex((index) => index === selected);
+    const position =
+      current >= 0
+        ? `${current + 1}/${matches.length}`
+        : `${matches.length} matches`;
+    return `Search /${this.query} • ${position} • n next • N previous • Esc clear search`;
+  }
+
+  private getMatchIndexes(query: string): number[] {
+    const needle = query.toLocaleLowerCase();
+    if (!needle) return [];
+
+    const matches: number[] = [];
+    this.lines.forEach((line, index) => {
+      if (line.text.toLocaleLowerCase().includes(needle)) matches.push(index);
+    });
+    return matches;
+  }
+}