fix(theme): restore GitHub Dark Default as the default theme (#1195)

Author: benvinegar

.changeset/restore-github-default-theme.md

@@ -0,0 +1,5 @@
+---
+"hunkdiff": patch
+---
+
+Restore `github-dark-default` as the default theme. The `terminal` theme remains available explicitly through config, `--theme terminal`, or the theme picker.

README.md

@@ -177,7 +177,7 @@ and falling back to it if migration fails. Global extension paths are unchanged.
 For example:
 
 ```toml
-theme = "terminal"
+theme = "github-dark-default"
 mode = "auto"               # auto, split, unified
 auto_split_min_width = 160  # minimum available diff columns for split in auto mode
 line_numbers = true

docs/themes.md

@@ -1,7 +1,7 @@
 # Themes
 
-Hunk follows your terminal's own colors by default. You can instead choose a
-built-in theme, let Hunk select one from your terminal background, or create a
+Hunk uses `github-dark-default` by default. You can instead follow your terminal's
+own colors, choose another built-in theme, select one from your terminal background, or create a
 custom theme in `~/.config/hunk/config.toml` or `.hunk/config.toml`.
 
 ```toml
@@ -13,7 +13,7 @@ You can also change themes while reviewing: press `t` or choose
 
 ## Terminal theme
 
-`theme = "terminal"` is the default. At startup Hunk asks the terminal for its
+Set `theme = "terminal"` to follow your terminal's colors. At startup Hunk asks the terminal for its
 foreground, background, and 16-color ANSI palette, then draws diffs, chrome,
 and syntax highlighting from those colors: green for additions and strings, red
 for removals, blue for functions and accents, magenta for keywords, and so on.

packages/hunk/README.md

@@ -177,7 +177,7 @@ and falling back to it if migration fails. Global extension paths are unchanged.
 For example:
 
 ```toml
-theme = "terminal"
+theme = "github-dark-default"
 mode = "auto"               # auto, split, unified
 auto_split_min_width = 160  # minimum available diff columns for split in auto mode
 line_numbers = true

packages/hunk/src/core/run/config.test.ts

@@ -920,7 +920,7 @@ describe("config resolution", () => {
     expect(configured.input.options.transparentBackground).toBe(true);
   });
 
-  test("defaults unspecified themes to terminal, including piped pager-style patch input", () => {
+  test("defaults unspecified themes to GitHub Dark Default, including piped pager-style patch input", () => {
     const home = createTempDir("hunk-config-home-");
     const cwd = createTempDir("hunk-config-cwd-");
 
@@ -931,7 +931,7 @@ describe("config resolution", () => {
 
     expect(resolved.repoConfigPath).toBeUndefined();
     expect(resolved.viewPreferencesConfigPath).toBe(join(home, ".config", "hunk", "config.toml"));
-    expect(resolved.input.options.theme).toBe("terminal");
+    expect(resolved.input.options.theme).toBe("github-dark-default");
   });
 
   test("command-specific config sections also apply to show mode", () => {
@@ -1288,7 +1288,7 @@ describe("config resolution", () => {
     ]);
   });
 
-  test("loadAppBootstrap exposes terminal when no theme is configured", async () => {
+  test("loadAppBootstrap exposes GitHub Dark Default when no theme is configured", async () => {
     const home = createTempDir("hunk-config-home-");
     const repo = createTempDir("hunk-config-repo-");
     createRepo(repo);
@@ -1309,7 +1309,7 @@ describe("config resolution", () => {
     );
     const bootstrap = await loadAppBootstrap(resolved.input);
 
-    expect(bootstrap.initialTheme).toBe("terminal");
+    expect(bootstrap.initialTheme).toBe("github-dark-default");
   });
 });
 

packages/hunk/src/core/run/config.ts

@@ -2,7 +2,6 @@ import fs from "node:fs";
 import { dirname, join } from "node:path";
 import { sanitizeTerminalLine } from "../../lib/terminalText";
 import { BUNDLED_SHIKI_THEME_IDS, LEGACY_THEME_ID_ALIASES } from "../theme/catalog";
-import { TERMINAL_THEME_ID } from "../theme/terminalColors";
 import {
   createInvalidThemeIdNotice,
   createThemeCollisionNotice,
@@ -101,7 +100,7 @@ export interface PersistedViewPreferences {
 export const BUILT_IN_THEME_IDS = BUNDLED_SHIKI_THEME_IDS;
 // Widen the large literal tuple before formatting it, avoiding TypeScript's deep tuple inference.
 const BUILT_IN_THEME_IDS_FOR_MESSAGES: readonly string[] = BUILT_IN_THEME_IDS;
-const DEFAULT_THEME_ID = TERMINAL_THEME_ID;
+const DEFAULT_THEME_ID = "github-dark-default";
 const DEFAULT_CUSTOM_THEME_BASE_ID = "github-dark-default";
 const DEFAULT_VIEW_PREFERENCES: PersistedViewPreferences = {
   mode: "auto",

packages/hunk/src/core/theme/terminalColors.test.ts

@@ -0,0 +1,10 @@
+import { expect, test } from "bun:test";
+import { themeFollowsTerminal } from "./terminalColors";
+
+test("only explicit terminal and auto themes need terminal color detection", () => {
+  expect(themeFollowsTerminal(undefined)).toBe(false);
+  expect(themeFollowsTerminal("github-dark-default")).toBe(false);
+  expect(themeFollowsTerminal("github-light-default")).toBe(false);
+  expect(themeFollowsTerminal("terminal")).toBe(true);
+  expect(themeFollowsTerminal("auto")).toBe(true);
+});

packages/hunk/src/core/theme/terminalColors.ts

@@ -1,12 +1,12 @@
-/** Id of the built-in theme drawn from the terminal's own colors, and Hunk's default theme. */
+/** Id of the opt-in built-in theme drawn from the terminal's own colors. */
 export const TERMINAL_THEME_ID = "terminal";
 
 /**
- * Return whether a requested theme id depends on what the terminal looks like: the default
- * (no id), the terminal-colors theme itself, and `auto` light/dark selection.
+ * Return whether a requested theme id depends on what the terminal looks like:
+ * the terminal-colors theme itself and `auto` light/dark selection.
  */
 export function themeFollowsTerminal(themeId: string | undefined) {
-  return themeId === undefined || themeId === TERMINAL_THEME_ID || themeId === "auto";
+  return themeId === TERMINAL_THEME_ID || themeId === "auto";
 }
 
 /**

packages/hunk/src/lib/shikiWasm.test.ts

@@ -4,6 +4,7 @@ import { tmpdir } from "node:os";
 import { join } from "node:path";
 import { pathToFileURL } from "node:url";
 import { REPO_ROOT } from "../../../../scripts/build/package-paths";
+import { removeTestDirectory } from "../../../../test/helpers/filesystem";
 
 // Install the main-thread counter before Pierre evaluates its static imports.
 const highlightDecodeTestPreload = `
@@ -94,7 +95,7 @@ function runHighlightTestProcess(args: string[], cwd = REPO_ROOT) {
   return JSON.parse(result.stdout.toString());
 }
 
-test("Pierre avoids base64 decoding in source, workers, bundles, and binaries with identical tokens", () => {
+test("Pierre avoids base64 decoding in source, workers, bundles, and binaries with identical tokens", async () => {
   const temporary = mkdtempSync(join(tmpdir(), "hunk-shiki-test-"));
   // Keep the compile entry under the repository so its package imports resolve normally.
   const sourceDir = mkdtempSync(join(REPO_ROOT, ".shiki-test-"));
@@ -177,7 +178,7 @@ test("Pierre avoids base64 decoding in source, workers, bundles, and binaries wi
     expect(compiled.assets).toContain(466_610);
   } finally {
     rmSync(sourceDir, { recursive: true, force: true });
-    // Windows can briefly retain the compiled executable's file lock after the child exits.
-    rmSync(temporary, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
+    // Yield between retries so Windows can release the compiled child's executable handles.
+    await removeTestDirectory(temporary);
   }
 }, 60_000);

packages/hunk/src/ui/AppHost.keybindings.test.tsx

@@ -239,13 +239,13 @@ describe("user keybindings", () => {
         setup.mockInput.pressKey("n", { ctrl: true });
       });
       await flush(setup);
-      expect(setup.captureCharFrame()).toContain("›  andromeeda");
+      expect(setup.captureCharFrame()).toContain("›  github-dark-dimmed");
 
       await act(async () => {
         setup.mockInput.pressKey("p", { ctrl: true });
       });
       await flush(setup);
-      expect(setup.captureCharFrame()).toContain("›  terminal");
+      expect(setup.captureCharFrame()).toContain("›  github-dark-default");
     });
   });