Merge pull request #7 from vindiarputra/main

fix: Windows compatibility for delete, size, and path separators

Author: codingstark-dev

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Type check
+        run: bun run check
+
+      - name: Build
+        run: bun run build
+
+      - name: Smoke test - help
+        run: bun run src/cli.ts --help
+
+      - name: Smoke test - dry-run
+        run: bun run src/cli.ts --dir "${{ github.workspace }}" --dry-run --hide-errors

.github/workflows/publish.yml

@@ -21,12 +21,12 @@ jobs:
         run: bun install
 
       - name: Run tests
-        run: bun test
+        run: bun run test
 
       - name: Build package
         run: bun run build
 
       - name: Publish to npm
         run: bun publish
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -29,15 +29,22 @@ BunKill scans large directory trees, calculates folder sizes, and lets you delet
 
 ## Requirements
 
-- Bun is required at runtime
-- macOS is the only platform tested so far
+- [Bun](https://bun.sh) runtime is required
+- Supported platforms: **macOS**, **Linux**, **Windows 10/11**
+- Windows: requires [Windows Terminal](https://aka.ms/terminal) for best interactive UI experience
 
-Install Bun if needed:
+**Install Bun:**
 
+macOS / Linux:
 ```bash
 curl -fsSL https://bun.sh/install | bash
 ```
 
+Windows (PowerShell):
+```powershell
+powershell -c "irm bun.sh/install.ps1 | iex"
+```
+
 ## Install
 
 ```bash
@@ -56,9 +63,12 @@ bun install -g bunkill
 # interactive scan in current directory
 bunkill
 
-# scan a specific directory
+# scan a specific directory (macOS / Linux)
 bunkill --dir ~/Projects
 
+# scan a specific directory (Windows)
+bunkill --dir "C:\Users\YourName\Projects"
+
 # preview only
 bunkill --dir ~/Projects --dry-run
 
@@ -101,13 +111,16 @@ Search filters the already loaded list, so you can quickly narrow large result s
 
 ## Platform status
 
-- macOS: tested
-- Linux: not tested yet
-- Windows: not tested yet
+| Platform | Status |
+|---|---|
+| macOS | ✅ Tested |
+| Linux | ✅ CI smoke tested |
+| Windows 10/11 | ✅ CI smoke tested (Windows Terminal recommended) |
 
-Linux and Windows may work, but they have not been validated in this repo yet.
+> **Windows note:** Interactive mode requires a terminal that supports ANSI escape codes and raw mode.
+> [Windows Terminal](https://aka.ms/terminal) works well. The legacy `cmd.exe` prompt is not supported.
 
-Contributions for Linux and Windows testing or fixes are welcome.
+CI covers help output, type checking, builds, and dry-run scanning. Manual interactive terminal testing is still useful across terminals.
 
 ## Performance
 

benchmark/three-way-benchmark.ts

@@ -6,7 +6,7 @@
  * This is now JS/Bun-only.
  */
 
-import { join } from "node:path";
+import { join, resolve } from "node:path";
 import { scan } from "../src/scanner.ts";
 
 const args = Bun.argv.slice(2);
@@ -34,10 +34,51 @@ function shouldSkip(p: string): boolean {
   );
 }
 
-async function npkillScan(dir: string): Promise<number> {
+function shellQuote(value: string): string {
+  return `'${value.replaceAll("'", "'\\''")}'`;
+}
+
+/** Convert a Windows absolute path to a WSL /mnt/... path. */
+function toWslPath(winPath: string): string {
+  const normalizedPath = resolve(winPath).replaceAll("\\", "/");
+  const driveMatch = /^([A-Za-z]):\/(.*)$/.exec(normalizedPath);
+  if (!driveMatch?.[1]) {
+    return normalizedPath;
+  }
+
+  const drive = driveMatch[1].toLowerCase();
+  const rest = driveMatch[2] ?? "";
+  return `/mnt/${drive}/${rest}`;
+}
+
+async function hasWslNpkill(): Promise<boolean> {
+  const probe = Bun.spawn({
+    cmd: [
+      "wsl",
+      "bash",
+      "-lc",
+      "command -v script >/dev/null && command -v npkill >/dev/null",
+    ],
+    stdout: "ignore",
+    stderr: "ignore",
+  });
+
+  return await probe.exited === 0;
+}
+
+async function npkillScan(dir: string, useWsl = false): Promise<number> {
+  if (useWsl && !(await hasWslNpkill())) {
+    return -1;
+  }
+
+  const wslCommand = `npkill -d ${shellQuote(toWslPath(dir))} -nu --hide-errors`;
+  const scriptCmd = useWsl
+    ? ["wsl", "bash", "-lc", `script -q /dev/null -c ${shellQuote(wslCommand)} 2>/dev/null`]
+    : ["script", "-q", "/dev/null", "npkill", "-d", dir, "-nu", "--hide-errors"];
+
   try {
     const proc = Bun.spawn({
-      cmd: ["script", "-q", "/dev/null", "npkill", "-d", dir, "-nu", "--hide-errors"],
+      cmd: scriptCmd,
       stdout: "pipe",
       stderr: "pipe",
       stdin: "pipe",
@@ -61,6 +102,10 @@ async function npkillScan(dir: string): Promise<number> {
     clearTimeout(killTimer);
     try { proc.kill(); } catch {}
 
+    if (await proc.exited !== 0) {
+      return -1;
+    }
+
     const raw = Buffer.concat(chunks).toString("utf8");
     const clean = raw.replace(/\x1b\[[0-9;]*[a-zA-Z]/g, "").replace(/\r/g, "");
 
@@ -84,11 +129,24 @@ async function bunGlobScan(dir: string): Promise<number> {
     onlyFiles: false,
     followSymlinks: false,
   })) {
+    const normalized = relative.replaceAll("\\", "/");
     const fullPath = join(dir, relative);
-    if (fullPath.split("/node_modules").length > 2) continue;
-    if (shouldSkip(fullPath)) continue;
-    const depth = relative.split("/").filter(Boolean).length;
+    const fullNormalized = fullPath.replaceAll("\\", "/");
+
+    const targetSegments = normalized.split("/")
+      .filter((segment) => segment === "node_modules");
+    if (targetSegments.length > 1) continue;
+    if (shouldSkip(fullNormalized)) continue;
+
+    const depth = normalized.split("/").filter(Boolean).length;
     if (depth > MAX_DEPTH) continue;
+
+    const projectPath = join(fullPath, "..");
+    const packageJson = await Bun.file(join(projectPath, "package.json"))
+      .json()
+      .catch(() => null);
+    if (!packageJson) continue;
+
     results.push(fullPath);
   }
 
@@ -162,19 +220,20 @@ function fmtMs(ms: number): string {
 }
 
 function printRow(r: BenchResult, baseline: number): void {
+  // \r\x1b[2K clears any partial line left by WSL/npkill carriage returns
   if (!r.available) {
-    console.log(`  ${r.label.padEnd(24)}  N/A (${r.note ?? "unavailable"})`);
+    process.stdout.write(`\r\x1b[2K  ${r.label.padEnd(24)}  N/A (${r.note ?? "unavailable"})\n`);
     return;
   }
 
   const speedup = r.avgMs === baseline
     ? "baseline"
     : `${(baseline / r.avgMs).toFixed(1)}x faster`;
 
-  console.log(
-    `  ${r.label.padEnd(24)}  avg=${fmtMs(r.avgMs).padStart(8)}  ` +
+  process.stdout.write(
+    `\r\x1b[2K  ${r.label.padEnd(24)}  avg=${fmtMs(r.avgMs).padStart(8)}  ` +
     `min=${fmtMs(r.minMs).padStart(8)}  max=${fmtMs(r.maxMs).padStart(8)}  ` +
-    `found=${String(r.found).padStart(4)}  ${speedup}`,
+    `found=${String(r.found).padStart(4)}  ${speedup}\n`,
   );
 }
 
@@ -184,9 +243,29 @@ console.log("╚═════════════════════
 console.log(`  Scan root : ${SCAN_DIR}`);
 console.log(`  Runs      : ${RUNS} (+ 1 warm-up)\n`);
 
-const npkillPath = await Bun.$.nothrow()`which npkill`.text().then((s) => s.trim()).catch(() => "");
-
-console.log(`  npkill    : ${npkillPath || "NOT FOUND  (npm install -g npkill)"}`);
+const isWindows = process.platform === "win32";
+
+// Detect npkill
+const npkillPath = isWindows
+  ? await Bun.$.nothrow()`where npkill`.text().then((s) => s.trim().split("\n")[0]?.trim() ?? "").catch(() => "")
+  : await Bun.$.nothrow()`which npkill`.text().then((s) => s.trim()).catch(() => "");
+
+const wslAvailable = isWindows
+  ? await Bun.$.nothrow()`where wsl`.text().then((s) => s.trim().length > 0).catch(() => false)
+  : false;
+const wslNpkillAvailable = isWindows && wslAvailable
+  ? await hasWslNpkill()
+  : false;
+
+const npkillStatus = !npkillPath
+  ? "NOT FOUND  (npm install -g npkill)"
+  : isWindows && wslNpkillAvailable
+    ? `${npkillPath} (via WSL)`
+    : isWindows
+      ? `${npkillPath} (skipped: WSL npkill/script unavailable)`
+      : npkillPath;
+
+console.log(`  npkill    : ${npkillStatus}`);
 console.log(`  Bun.Glob  : baseline glob walk`);
 console.log(`  bunkill   : current scanner.ts implementation\n`);
 
@@ -197,9 +276,15 @@ const [globResult, bunkillResult] = await Promise.all([
   bench("bunkill current", bunKillScan, SCAN_DIR, RUNS),
 ]);
 
-const npkillResult = npkillPath
-  ? await bench("npkill", npkillScan, SCAN_DIR, 1)
-  : { label: "npkill", avgMs: 0, minMs: 0, maxMs: 0, found: -1, available: false, note: "not installed" };
+// On Windows: run npkill via WSL if available; on Unix: run directly
+const canRunNpkill = npkillPath && (!isWindows || wslNpkillAvailable);
+const npkillResult = canRunNpkill
+  ? await bench("npkill", (d) => npkillScan(d, isWindows && wslAvailable), SCAN_DIR, 1)
+  : {
+      label: "npkill",
+      avgMs: 0, minMs: 0, maxMs: 0, found: -1, available: false,
+      note: !npkillPath ? "not installed" : "WSL npkill/script unavailable",
+    };
 
 const available = [npkillResult, globResult, bunkillResult].filter((r) => r.available);
 

bun.lock

@@ -22,7 +22,8 @@
   },
   "devDependencies": {
     "@types/bun": "^1.3.10",
-    "@types/node": "^24.5.2"
+    "@types/node": "^24.5.2",
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "test": "bun run src/cli.ts --help",

package.json

@@ -5,7 +5,7 @@ import { stat } from "node:fs/promises";
 import { basename, join, resolve } from "node:path";
 import { filesize } from "filesize";
 import { APP_CONFIG } from "./config.ts";
-import { deleteModules, scan as scanEngine } from "./scanner.ts";
+import { deleteModules, normalizeProjectPath, scan as scanEngine } from "./scanner.ts";
 import type { NodeModule, ScanOptions } from "./types.ts";
 
 const LOGO = `
@@ -558,7 +558,7 @@ class BunKill {
     }
 
     this.pendingUiMeta.add(module.path);
-    const projectPath = module.path.replace(/\/node_modules$/, "");
+    const projectPath = normalizeProjectPath(module.path);
 
     try {
       const result = await Bun.$`git -C ${projectPath} status --short --branch`.quiet().nothrow();

src/cli.ts

@@ -12,6 +12,7 @@ export const APP_CONFIG = {
       : 8;
     return Math.max(4, Math.min(16, cpuCount || 8));
   })(),
+  defaultDeleteConcurrency: 8,
 } as const;
 
 export const SCAN_PATHS = {