Add Windows cache path support (%LOCALAPPDATA%) and platform test coverage

Author: shouze

README.md

@@ -399,10 +399,11 @@ disk for **24 hours** to avoid repeating dozens of API calls on every run.
 
 ### Cache location
 
-| OS    | Path                                                                    |
-| ----- | ----------------------------------------------------------------------- |
-| macOS | `~/Library/Caches/github-code-search/`                                  |
-| Linux | `$XDG_CACHE_HOME/github-code-search/` or `~/.cache/github-code-search/` |
+| OS      | Path                                                                    |
+| ------- | ----------------------------------------------------------------------- |
+| macOS   | `~/Library/Caches/github-code-search/`                                  |
+| Linux   | `$XDG_CACHE_HOME/github-code-search/` or `~/.cache/github-code-search/` |
+| Windows | `%LOCALAPPDATA%\github-code-search\`                                    |
 
 You can also override the cache directory with the `GITHUB_CODE_SEARCH_CACHE_DIR`
 environment variable.
@@ -419,11 +420,14 @@ github-code-search "useFeatureFlag" --org fulll \
 ### Purging the cache
 
 ```bash
-# macOS
-rm -rf ~/Library/Caches/github-code-search
+# macOS / Linux
+rm -rf ~/Library/Caches/github-code-search   # macOS
+rm -rf "${XDG_CACHE_HOME:-$HOME/.cache}/github-code-search"  # Linux
+```
 
-# Linux
-rm -rf "${XDG_CACHE_HOME:-$HOME/.cache}/github-code-search"
+```powershell
+# Windows (PowerShell)
+Remove-Item -Recurse -Force "$env:LOCALAPPDATA\github-code-search"
 ```
 
 ## Known limitations

src/cache.test.ts

@@ -41,6 +41,90 @@ describe("getCacheDir", () => {
     delete process.env.GITHUB_CODE_SEARCH_CACHE_DIR;
     expect(getCacheDir()).toContain("github-code-search");
   });
+
+  it("uses LOCALAPPDATA on win32 when the env var is set", () => {
+    delete process.env.GITHUB_CODE_SEARCH_CACHE_DIR;
+    const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
+    const originalLocalAppData = process.env.LOCALAPPDATA;
+    try {
+      Object.defineProperty(process, "platform", { value: "win32", configurable: true });
+      process.env.LOCALAPPDATA = "C:\\Users\\user\\AppData\\Local";
+      const dir = getCacheDir();
+      // path.join uses the host OS separator in tests (macOS: /), so we just
+      // assert both components are present rather than hard-coding a separator.
+      expect(dir).toContain("AppData");
+      expect(dir).toContain("Local");
+      expect(dir).toContain("github-code-search");
+    } finally {
+      if (originalPlatform) Object.defineProperty(process, "platform", originalPlatform);
+      if (originalLocalAppData !== undefined) process.env.LOCALAPPDATA = originalLocalAppData;
+      else delete process.env.LOCALAPPDATA;
+    }
+  });
+
+  it("falls back to ~/AppData/Local on win32 when LOCALAPPDATA is not set", () => {
+    delete process.env.GITHUB_CODE_SEARCH_CACHE_DIR;
+    const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
+    const originalLocalAppData = process.env.LOCALAPPDATA;
+    try {
+      Object.defineProperty(process, "platform", { value: "win32", configurable: true });
+      delete process.env.LOCALAPPDATA;
+      const dir = getCacheDir();
+      expect(dir).toContain("AppData");
+      expect(dir).toContain("Local");
+      expect(dir).toContain("github-code-search");
+    } finally {
+      if (originalPlatform) Object.defineProperty(process, "platform", originalPlatform);
+      if (originalLocalAppData !== undefined) process.env.LOCALAPPDATA = originalLocalAppData;
+    }
+  });
+
+  it("uses XDG_CACHE_HOME on linux when set", () => {
+    delete process.env.GITHUB_CODE_SEARCH_CACHE_DIR;
+    const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
+    const originalXdg = process.env.XDG_CACHE_HOME;
+    try {
+      Object.defineProperty(process, "platform", { value: "linux", configurable: true });
+      process.env.XDG_CACHE_HOME = "/custom/xdg/cache";
+      const dir = getCacheDir();
+      expect(dir).toContain("custom");
+      expect(dir).toContain("xdg");
+      expect(dir).toContain("github-code-search");
+    } finally {
+      if (originalPlatform) Object.defineProperty(process, "platform", originalPlatform);
+      if (originalXdg !== undefined) process.env.XDG_CACHE_HOME = originalXdg;
+      else delete process.env.XDG_CACHE_HOME;
+    }
+  });
+
+  it("falls back to ~/.cache on linux when XDG_CACHE_HOME is not set", () => {
+    delete process.env.GITHUB_CODE_SEARCH_CACHE_DIR;
+    const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
+    const originalXdg = process.env.XDG_CACHE_HOME;
+    try {
+      Object.defineProperty(process, "platform", { value: "linux", configurable: true });
+      delete process.env.XDG_CACHE_HOME;
+      const dir = getCacheDir();
+      expect(dir).toContain(".cache");
+      expect(dir).toContain("github-code-search");
+    } finally {
+      if (originalPlatform) Object.defineProperty(process, "platform", originalPlatform);
+      if (originalXdg !== undefined) process.env.XDG_CACHE_HOME = originalXdg;
+    }
+  });
+
+  it("falls back to ~/.github-code-search/cache on unknown platforms", () => {
+    delete process.env.GITHUB_CODE_SEARCH_CACHE_DIR;
+    const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
+    try {
+      Object.defineProperty(process, "platform", { value: "freebsd", configurable: true });
+      const dir = getCacheDir();
+      expect(dir).toContain(".github-code-search");
+      expect(dir).toContain("cache");
+    } finally {
+      if (originalPlatform) Object.defineProperty(process, "platform", originalPlatform);
+    }
+  });
 });
 
 // ─── getCacheKey ─────────────────────────────────────────────────────────────

src/cache.ts

@@ -12,9 +12,10 @@ export const CACHE_TTL_MS = 24 * 60 * 60 * 1_000; // 24 hours
 
 /**
  * Returns the OS-appropriate cache directory for the application:
- * - macOS  → ~/Library/Caches/github-code-search
- * - Linux  → $XDG_CACHE_HOME/github-code-search  (fallback: ~/.cache/github-code-search)
- * - Other  → ~/.github-code-search/cache
+ * - macOS   → ~/Library/Caches/github-code-search
+ * - Linux   → $XDG_CACHE_HOME/github-code-search  (fallback: ~/.cache/github-code-search)
+ * - Windows → %LOCALAPPDATA%\github-code-search   (fallback: ~/AppData/Local/github-code-search)
+ * - Other   → ~/.github-code-search/cache
  *
  * Override with `GITHUB_CODE_SEARCH_CACHE_DIR` env var (useful in tests and CI).
  */
@@ -31,6 +32,14 @@ export function getCacheDir(): string {
     const base = xdg && xdg.trim() !== "" ? xdg : join(homedir(), ".cache");
     return join(base, "github-code-search");
   }
+  if (platform === "win32") {
+    const localAppData = process.env.LOCALAPPDATA;
+    const base =
+      localAppData && localAppData.trim() !== ""
+        ? localAppData
+        : join(homedir(), "AppData", "Local");
+    return join(base, "github-code-search");
+  }
   return join(homedir(), ".github-code-search", "cache");
 }