@xuhaojun/githunk 0.1.1 → 0.1.2

package/README.md

@@ -28,6 +28,15 @@ cd path/to/repository
 githunk
 ```
 
+Or point it at a repository from anywhere:
+
+```sh
+githunk --path path/to/repository
+githunk path/to/repository
+```
+
+`githunk --help` prints all options; `githunk --version` prints the installed version.
+
 ## Development
 
 This repository uses Bun for development and for producing the Node.js bundle published to npm:

package/dist/githunk.js

@@ -1,6 +1,64 @@
 #!/usr/bin/env node
 
+// src/cli/args.ts
+import { Command, CommanderError } from "commander";
+import { readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+var cachedVersion;
+function getCliVersion() {
+  if (cachedVersion !== undefined)
+    return cachedVersion;
+  let directory = dirname(fileURLToPath(import.meta.url));
+  for (let level = 0;level < 4; level += 1) {
+    try {
+      const manifest = JSON.parse(readFileSync(join(directory, "package.json"), "utf8"));
+      if (manifest.name === "@xuhaojun/githunk" && typeof manifest.version === "string") {
+        cachedVersion = manifest.version;
+        return cachedVersion;
+      }
+    } catch {}
+    const parent = dirname(directory);
+    if (parent === directory)
+      break;
+    directory = parent;
+  }
+  cachedVersion = "0.0.0-dev";
+  return cachedVersion;
+}
+function parseCliArgs(argv) {
+  let stdout = "";
+  let stderr = "";
+  const program = new Command;
+  program.name("githunk").description("A review-first Git TUI combining lazygit's everyday Git workflow with focused hunk review.").version(getCliVersion(), "-V, --version", "output the version number").option("-p, --path <dir>", "path to the Git repository to open").argument("[path]", "path to the Git repository to open").exitOverride().configureOutput({
+    writeOut: (text) => {
+      stdout += text;
+    },
+    writeErr: (text) => {
+      stderr += text;
+    }
+  });
+  try {
+    program.parse([...argv], { from: "user" });
+  } catch (error) {
+    if (error instanceof CommanderError) {
+      if (error.code === "commander.helpDisplayed")
+        return { kind: "help", text: stdout };
+      if (error.code === "commander.version")
+        return { kind: "version", text: stdout };
+      const message = stderr.trim() === "" ? error.message : stderr.trim();
+      return { kind: "error", message, exitCode: error.exitCode };
+    }
+    throw error;
+  }
+  const options = program.opts();
+  const positional = program.args[0];
+  const startDirectory = options.path ?? positional;
+  return startDirectory === undefined ? { kind: "start" } : { kind: "start", startDirectory };
+}
+
 // src/main.ts
+import { resolve as resolve4 } from "node:path";
 import { createCliRenderer } from "@opentui/core";
 
 // src/domain/command.ts
@@ -775,6 +833,7 @@ function withCommitStatuses(commits, sets) {
 
 // src/git/commits.ts
 var LOG_FORMAT = "%H%n%h%n%P%n%an%n%aI%n%s%n%b";
+var COMMITS_LIMIT = 300;
 function parseSummary(record) {
   const fields = record.split(`
 `);
@@ -802,8 +861,11 @@ function parseSummary(record) {
 function parseCommitLog(raw) {
   return raw.split("\x00").map(parseSummary).filter((summary) => summary !== undefined);
 }
-async function listCommits(runner, range, filter) {
-  const args = ["log", "-z", "--topo-order", `--format=${LOG_FORMAT}`, range];
+async function listCommits(runner, range, filter, options) {
+  const args = ["log", "-z", "--topo-order", `--format=${LOG_FORMAT}`];
+  if (options?.limit ?? true)
+    args.push(`-${COMMITS_LIMIT}`);
+  args.push(range);
   if (filter !== undefined && filter.length > 0)
     args.push("--", filter);
   const [result, statusSets] = await Promise.all([
@@ -916,7 +978,7 @@ function fingerprintWorkingTreeFile(target, filePatch) {
 
 // src/storage/local-state-file.ts
 import { mkdir, open, rename, stat, unlink, lstat, link, readFile } from "node:fs/promises";
-import { dirname, isAbsolute, join, resolve } from "node:path";
+import { dirname as dirname2, isAbsolute, join as join2, resolve } from "node:path";
 import { randomUUID } from "node:crypto";
 async function assertNoSymlinkInPath(path, pathKind) {
   const absolute = resolve(path);
@@ -946,7 +1008,7 @@ class LocalStateFile {
     this.pathKind = options.pathKind ?? "state";
   }
   get path() {
-    return this.resolvedPath ?? join(this.runner.cwd, ".git", this.relativePath);
+    return this.resolvedPath ?? join2(this.runner.cwd, ".git", this.relativePath);
   }
   async resolvePath() {
     if (this.resolvedPath !== undefined)
@@ -954,7 +1016,7 @@ class LocalStateFile {
     const output = (await this.runner.run(["rev-parse", "--git-path", this.relativePath], { readOnly: true })).stdout.trim();
     if (output.length === 0)
       throw new Error(`git returned an empty path for ${this.relativePath}`);
-    this.resolvedPath = isAbsolute(output) ? output : join(this.runner.cwd, output);
+    this.resolvedPath = isAbsolute(output) ? output : join2(this.runner.cwd, output);
     return this.resolvedPath;
   }
   async readText() {
@@ -971,7 +1033,7 @@ class LocalStateFile {
   async writeText(text) {
     const path = await this.resolvePath();
     await assertNoSymlinkInPath(path, this.pathKind);
-    await mkdir(dirname(path), { recursive: true, mode: 448 });
+    await mkdir(dirname2(path), { recursive: true, mode: 448 });
     const temporary = `${path}.tmp-${process.pid}-${randomUUID()}`;
     await assertNoSymlinkInPath(temporary, this.pathKind);
     const handle = await open(temporary, "wx", 384);
@@ -984,7 +1046,7 @@ class LocalStateFile {
     }
     await rename(temporary, path);
     try {
-      const directory = await open(dirname(path), "r");
+      const directory = await open(dirname2(path), "r");
       try {
         await directory.sync();
       } finally {
@@ -1008,7 +1070,7 @@ class LocalStateFile {
   async createTextExclusive(text) {
     const path = await this.resolvePath();
     await assertNoSymlinkInPath(path, this.pathKind);
-    await mkdir(dirname(path), { recursive: true, mode: 448 });
+    await mkdir(dirname2(path), { recursive: true, mode: 448 });
     const temporary = `${path}.tmp-${process.pid}-${randomUUID()}`;
     await assertNoSymlinkInPath(temporary, this.pathKind);
     const handle = await open(temporary, "wx", 384);
@@ -1037,7 +1099,7 @@ class LocalStateFile {
       return;
     });
     try {
-      const directory = await open(dirname(path), "r");
+      const directory = await open(dirname2(path), "r");
       try {
         await directory.sync();
       } finally {
@@ -2072,7 +2134,7 @@ async function listReflog(runner, options = {}) {
 
 // src/git/worktrees.ts
 import { readFile as readFile2, stat as stat2 } from "node:fs/promises";
-import { dirname as dirname2, join as join2 } from "node:path";
+import { dirname as dirname3, join as join3 } from "node:path";
 function finalizeEntry(entry) {
   return {
     path: entry.path,
@@ -2174,7 +2236,7 @@ async function resolveRepositoryPaths(runner) {
   const worktreeGitDirPath = lines[1] ?? "";
   const repoGitDirPath = lines[2] ?? "";
   const isSubmodule = (lines[3] ?? "").length > 0;
-  const repoPath = worktreeGitDirPath === repoGitDirPath || isSubmodule ? worktreePath : dirname2(repoGitDirPath);
+  const repoPath = worktreeGitDirPath === repoGitDirPath || isSubmodule ? worktreePath : dirname3(repoGitDirPath);
   return { worktreePath, worktreeGitDirPath, repoPath, repoGitDirPath };
 }
 async function isPathMissing(path) {
@@ -2207,11 +2269,11 @@ async function readTrimmedFile(path) {
 }
 async function inProgressBranch(gitDir) {
   for (const directory of ["rebase-merge", "rebase-apply"]) {
-    const headName = await readTrimmedFile(join2(gitDir, directory, "head-name"));
+    const headName = await readTrimmedFile(join3(gitDir, directory, "head-name"));
     if (headName !== undefined)
       return headName.replace(/^refs\/heads\//, "");
   }
-  return await readTrimmedFile(join2(gitDir, "BISECT_START"));
+  return await readTrimmedFile(join3(gitDir, "BISECT_START"));
 }
 async function listWorktrees(runner) {
   const repositoryPaths = await resolveRepositoryPaths(runner);
@@ -2278,7 +2340,7 @@ function worktreeRemovalRequiresForce(error) {
 
 // src/git/submodules.ts
 import { readFile as readFile3 } from "node:fs/promises";
-import { join as join3, resolve as resolve2 } from "node:path";
+import { join as join4, resolve as resolve2 } from "node:path";
 
 // src/domain/submodule.ts
 function submoduleFullName(submodule) {
@@ -2333,7 +2395,7 @@ function parseGitModules(raw) {
 }
 async function readGitModules(directory) {
   try {
-    return await readFile3(join3(directory, ".gitmodules"), "utf8");
+    return await readFile3(join4(directory, ".gitmodules"), "utf8");
   } catch (error) {
     if (error instanceof Error && "code" in error) {
       const code = error.code;
@@ -2344,7 +2406,7 @@ async function readGitModules(directory) {
   }
 }
 async function collectSubmodules(worktreePath, parentModule, visited) {
-  const directory = parentModule === undefined ? worktreePath : join3(worktreePath, submoduleFullPath(parentModule));
+  const directory = parentModule === undefined ? worktreePath : join4(worktreePath, submoduleFullPath(parentModule));
   const resolved = resolve2(directory);
   if (visited.has(resolved))
     return [];
@@ -2474,6 +2536,7 @@ class AppController {
   loadCommitDetails;
   loadCommitFile;
   generation = 0;
+  limitCommits = true;
   pullRequestRefreshGeneration = 0;
   currentState;
   reviewDatabase = emptyWorkingTreeReviewDatabase();
@@ -2494,7 +2557,7 @@ class AppController {
       return loadWorkingTree(runner, target2.scope, snapshotOptions ?? {});
     });
     this.loadBranchesListing = options instanceof GitRunner ? () => listBranches(options) : options.loadBranches ?? options.branchesLoader ?? (runner !== undefined ? () => listBranches(runner) : async () => ({ detached: true, localBranches: [], remotes: [] }));
-    this.loadCommitList = options instanceof GitRunner ? (range, filter) => listCommits(options, range, filter) : options.loadCommits ?? options.commitsLoader ?? (runner === undefined ? async () => [] : (range, filter) => listCommits(runner, range, filter));
+    this.loadCommitList = options instanceof GitRunner ? (range, filter, listOptions) => listCommits(options, range, filter, listOptions) : options.loadCommits ?? options.commitsLoader ?? (runner === undefined ? async () => [] : (range, filter, listOptions) => listCommits(runner, range, filter, listOptions));
     this.loadCommitDetails = options instanceof GitRunner ? (oid) => loadCommit(options, oid) : options.loadCommit ?? options.commitLoader ?? (runner === undefined ? async () => {
       throw new Error("Commit details require a GitRunner");
     } : (oid) => loadCommit(runner, oid));
@@ -2732,6 +2795,7 @@ class AppController {
     await this.switchLocalBranch(branch);
   }
   async switchLocalBranch(branch) {
+    this.limitCommits = true;
     this.logAction(LOG_ACTIONS.checkoutBranch);
     await this.runBranchMutation(() => this.requireRunnerOperation((runner) => switchLocal(runner, branch)));
   }
@@ -3103,7 +3167,20 @@ class AppController {
     return this.loadCommitDetails(oid);
   }
   async loadBranchCommits(branch) {
-    return this.loadCommitList(`refs/heads/${branch}`);
+    return this.loadCommitList(`refs/heads/${branch}`, undefined, { limit: this.limitCommits });
+  }
+  async expandCommits() {
+    if (!this.limitCommits)
+      return false;
+    this.limitCommits = false;
+    const history = await this.loadCommitHistory("HEAD");
+    this.currentState = {
+      ...this.currentState,
+      commits: history.commits,
+      ...this.commandLogSnapshot(),
+      ...history.warning === undefined ? {} : { banner: history.warning }
+    };
+    return true;
   }
   async loadCommitFileInspection(oid, path) {
     return this.loadCommitFile(oid, path);
@@ -3402,7 +3479,7 @@ class AppController {
   }
   async loadCommitHistory(range) {
     try {
-      return { commits: await this.loadCommitList(range) };
+      return { commits: await this.loadCommitList(range, undefined, { limit: this.limitCommits }) };
     } catch (error) {
       const warning = error instanceof GitCommandError ? error.record.stderr || error.message : error instanceof Error ? error.message : String(error);
       return { commits: this.currentState.commits ?? [], warning };
@@ -5896,6 +5973,7 @@ function reflogRows(model, filter = "") {
 
 // src/ui/panes/commits-pane.ts
 var paneStates = new WeakMap;
+var COMMIT_THRESHOLD = 200;
 function formatRelativeTime(authoredAt, now) {
   const date = new Date(authoredAt);
   if (Number.isNaN(date.getTime()))
@@ -10212,6 +10290,7 @@ class RootView {
   onInspectStash;
   onBrowseRemote;
   loadBranchCommits;
+  onExpandCommits;
   onInspectBranch;
   onCheckoutRemoteTracking;
   onFilterBranches;
@@ -10305,6 +10384,7 @@ class RootView {
     this.loadTagInspection = options.loadTagInspection;
     this.loadRefLogInspection = options.loadRefLogInspection;
     this.loadBranchCommits = options.loadBranchCommits;
+    this.onExpandCommits = options.onExpandCommits;
     this.onPreviewError = options.onPreviewError;
     this.onCommitMessage = options.onCommitMessage;
     this.onAmendMessage = options.onAmendMessage;
@@ -10495,7 +10575,7 @@ class RootView {
     }
     this.branchActionGeneration += 1;
     this.invalidateBranchCommitsRequest();
-    if (!options.preserveRemoteCheckout) {
+    if (!options.preserveRemoteCheckout && !options.preserveFilterInput) {
       this.branchFilterActive = false;
       this.branchFilter = "";
       this.filterInput.clear();
@@ -11686,6 +11766,7 @@ class RootView {
             this.renderCommitsPane();
             this.revealListRow("commits", this.panes.commits, nextView.selectedIndex);
             this.syncPreviewForFocus("commits");
+            this.maybeExpandCommits(nextView.selectedIndex);
           }
         }
         return;
@@ -11808,11 +11889,63 @@ class RootView {
       }
       return;
     }
-    const direction = edge === "bottom" ? "next" : "previous";
-    const branchCount = this.branchesPanel.child !== undefined ? this.branchesPanel.child.view.rows.length : this.branchesPanel.views[this.branchesPanel.activeTab]?.rows.length ?? 0;
-    const limit = Math.max(this.model.files.length, (this.model.worktrees ?? []).length, (this.model.submodules ?? []).length, (this.model.commits ?? []).length, (this.model.stashes ?? []).length, (this.model.reflog ?? []).length, branchCount) + 1;
-    for (let moved = 0;moved < limit; moved += 1)
-      this.actionMoveCursor(direction);
+    this.clearTransientMenus();
+    const paneId = this.focusManager.active;
+    if (paneId !== "files" && paneId !== "branches" && paneId !== "commits" && paneId !== "stash")
+      return;
+    if (paneId === "commits" && edge === "bottom") {
+      this.jumpCommitsToBottom();
+      return;
+    }
+    const active = this.activeListView(paneId);
+    if (active === undefined || active.state.rows.length === 0)
+      return;
+    const rows = active.state.rows;
+    const targetId = (edge === "bottom" ? rows[rows.length - 1] : rows[0]).id;
+    const next = this.edgeSelection(active.state, targetId);
+    if (next === active.state)
+      return;
+    this.updateActiveListState(paneId, next);
+    this.renderListPane(paneId);
+    this.revealListRow(paneId, this.panes[paneId], next.selectedIndex);
+    this.syncListSelectionAfterChange(paneId);
+    this.root.requestRender();
+  }
+  edgeSelection(state, targetId) {
+    const direct = selectListRow(state, targetId);
+    if (direct === state)
+      return state;
+    if (state.rangeMode !== "sticky" || state.rangeStartId === undefined)
+      return direct;
+    if (!state.rows.some((row) => row.id === state.rangeStartId))
+      return direct;
+    return { ...direct, rangeMode: state.rangeMode, rangeStartId: state.rangeStartId };
+  }
+  jumpCommitsToBottom() {
+    (async () => {
+      await this.onExpandCommits?.();
+      const active = this.activeListView("commits");
+      if (active === undefined || active.state.rows.length === 0)
+        return;
+      const rows = active.state.rows;
+      const next = this.edgeSelection(active.state, rows[rows.length - 1].id);
+      if (next === active.state)
+        return;
+      this.updateActiveListState("commits", next);
+      this.renderListPane("commits");
+      this.revealListRow("commits", this.panes.commits, next.selectedIndex);
+      this.syncListSelectionAfterChange("commits");
+      this.root.requestRender();
+    })();
+  }
+  maybeExpandCommits(selectedIndex) {
+    if (this.commitsPanel.activeTab !== "commits")
+      return;
+    if (this.commitsPanel.child !== undefined)
+      return;
+    if (selectedIndex <= COMMIT_THRESHOLD)
+      return;
+    this.onExpandCommits?.();
   }
   actionInspect() {
     switch (this.focusManager.active) {
@@ -13162,6 +13295,9 @@ class RootView {
     const existing = this.getFilterForKey(target.key);
     if (existing.length > 0)
       this.filters.delete(target.key);
+    if (target.key === this.filterKey("commits", "commits")) {
+      this.onExpandCommits?.();
+    }
     this.filterInput.open("");
     this.refreshForFilterKey(target.key);
     this.renderForFilterKey(target.key);
@@ -15282,7 +15418,7 @@ async function loadRefsSnapshot(runner) {
 }
 
 // src/git/editor.ts
-import { join as join4, basename } from "node:path";
+import { join as join5, basename } from "node:path";
 function standardTerminalPreset(editor) {
   return {
     edit: `${editor} -- {{filename}}`,
@@ -15420,7 +15556,7 @@ async function resolveEditCommand(files, options = {}) {
 function absolutePath(repoRoot, relativePath) {
   if (relativePath.startsWith("/"))
     return relativePath;
-  return join4(repoRoot, relativePath);
+  return join5(repoRoot, relativePath);
 }
 
 // src/app/create-app.ts
@@ -15428,7 +15564,7 @@ import { isAbsolute as isAbsolute2, resolve as resolve3 } from "node:path";
 
 // src/app/index-watcher.ts
 import { watch, statSync } from "node:fs";
-import { basename as basename2, dirname as dirname3 } from "node:path";
+import { basename as basename2, dirname as dirname4 } from "node:path";
 var DEFAULT_INDEX_EVENT_DEBOUNCE_MS = 50;
 var BUSY_RETRY_MS = 50;
 function fingerprint(path) {
@@ -15469,7 +15605,7 @@ class IndexWatcher {
     this.stopped = false;
     this.baseline = fingerprint(this.options.indexPath);
     try {
-      const watcher = watch(dirname3(this.options.indexPath), { persistent: false }, (_eventType, filename) => {
+      const watcher = watch(dirname4(this.options.indexPath), { persistent: false }, (_eventType, filename) => {
         if (this.stopped)
           return;
         const name = eventFileName(filename);
@@ -16135,7 +16271,7 @@ function reviewHelp(focus, state) {
 }
 
 // src/ui/review-workspace/review-sidebar.ts
-import { basename as basename3, dirname as dirname4 } from "node:path/posix";
+import { basename as basename3, dirname as dirname5 } from "node:path/posix";
 function normalizeDiffPath(p) {
   return p?.replace(/[\r\n]+$/u, "");
 }
@@ -16221,7 +16357,7 @@ function buildReviewSidebarEntries(state) {
   let activeGroup;
   visible.forEach((file, index) => {
     const path = formatTerminalPath(normalizeDiffPath(file.path) ?? file.path);
-    const group = dirname4(path);
+    const group = dirname5(path);
     if (group !== activeGroup) {
       activeGroup = group;
       entries.push({
@@ -24006,6 +24142,7 @@ function createApp(options) {
     repositoryRoot: options.repositoryRoot,
     runner: options.runner,
     ...pullRequestLoader === undefined ? {} : { loadPullRequests: pullRequestLoader },
+    ...options.loadCommits === undefined ? {} : { loadCommits: options.loadCommits },
     onPullRequestsChanged: (state) => {
       renderPullRequests?.(state);
     }
@@ -24285,6 +24422,12 @@ function createApp(options) {
     },
     loadCommitInspection: (oid) => controller.loadCommitInspection(oid),
     loadBranchCommits: options.loadBranchCommits ?? ((branch) => controller.loadBranchCommits(branch)),
+    onExpandCommits: async () => {
+      const expanded = await controller.expandCommits();
+      if (expanded && (screenController?.shouldRenderRepository() ?? true))
+        view.update(controller.state, { preserveFilterInput: true });
+      return expanded;
+    },
     loadCommitFileInspection: (oid, path) => controller.loadCommitFileInspection(oid, path),
     loadTagInspection: (tag) => controller.loadTagInspection(tag),
     loadRefLogInspection: (target) => controller.loadRefLogInspection(target),
@@ -24651,8 +24794,9 @@ function createApp(options) {
 function shouldQueryTerminalPalette(env = process.env, capabilities) {
   return env.ZELLIJ === undefined && env.ZELLIJ_SESSION_NAME === undefined && env.TERM_PROGRAM?.toLowerCase() !== "zellij" && capabilities?.multiplexer !== "zellij";
 }
-async function startApp() {
-  const runner = new GitRunner;
+async function startApp(options = {}) {
+  const startDirectory = options.startDirectory === undefined ? process.cwd() : resolve4(process.cwd(), options.startDirectory);
+  const runner = new GitRunner(startDirectory);
   let repositoryRoot;
   try {
     repositoryRoot = (await runner.run(["rev-parse", "--show-toplevel"], { readOnly: true })).stdout.trim();
@@ -24697,4 +24841,17 @@ ${detail}
 if (false) {}
 
 // src/cli.ts
-process.exitCode = await startApp();
+var result = parseCliArgs(process.argv.slice(2));
+if (result.kind === "help" || result.kind === "version") {
+  process.stdout.write(result.text.endsWith(`
+`) ? result.text : `${result.text}
+`);
+  process.exitCode = 0;
+} else if (result.kind === "error") {
+  process.stderr.write(result.message.endsWith(`
+`) ? result.message : `${result.message}
+`);
+  process.exitCode = result.exitCode;
+} else {
+  process.exitCode = await startApp(result.startDirectory === undefined ? {} : { startDirectory: result.startDirectory });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xuhaojun/githunk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A review-first Git TUI combining lazygit's everyday Git workflow with focused hunk review.",
   "type": "module",
   "bin": {
@@ -52,6 +52,7 @@
     "@opentui/core": "0.5.10",
     "@opentui/react": "0.5.10",
     "@pierre/diffs": "1.3.5",
+    "commander": "^15.0.0",
     "react": "19.2.8",
     "zod": "^4.4.3"
   },