pi-lens 1.3.13 → 2.0.0

package/clients/test-runner-client.test.ts

@@ -1,38 +1,30 @@
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { TestRunnerClient } from "./test-runner-client.js";
-import * as fs from "node:fs";
+import { createTempFile, setupTestEnvironment } from "./test-utils.js";
 import * as path from "node:path";
-import * as os from "node:os";
 
 describe("TestRunnerClient", () => {
   let client: TestRunnerClient;
   let tmpDir: string;
-
-  function createTempFile(name: string, content: string): string {
-    const filePath = path.join(tmpDir, name);
-    const dir = path.dirname(filePath);
-    if (!fs.existsSync(dir)) {
-      fs.mkdirSync(dir, { recursive: true });
-    }
-    fs.writeFileSync(filePath, content);
-    return filePath;
-  }
+  let cleanup: () => void;
 
   beforeEach(() => {
     client = new TestRunnerClient();
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pi-lens-test-runner-"));
+    ({ tmpDir, cleanup } = setupTestEnvironment("pi-lens-test-runner-"));
+  });
+
+  afterEach(() => {
+    cleanup();
   });
 
   afterEach(() => {
-    if (tmpDir && fs.existsSync(tmpDir)) {
-      fs.rmSync(tmpDir, { recursive: true });
-    }
+    cleanup();
   });
 
   describe("detectRunner", () => {
     it("should detect vitest from config file", () => {
-      createTempFile("vitest.config.ts", "export default {}");
-      createTempFile("src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "vitest.config.ts", "export default {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
 
       const result = client.detectRunner(tmpDir);
       expect(result).not.toBeNull();
@@ -40,8 +32,8 @@ describe("TestRunnerClient", () => {
     });
 
     it("should detect jest from config file", () => {
-      createTempFile("jest.config.js", "module.exports = {}");
-      createTempFile("src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "jest.config.js", "module.exports = {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
 
       const result = client.detectRunner(tmpDir);
       expect(result).not.toBeNull();
@@ -49,8 +41,8 @@ describe("TestRunnerClient", () => {
     });
 
     it("should detect pytest from config file", () => {
-      createTempFile("pytest.ini", "[tool:pytest]");
-      createTempFile("src/app.py", "x = 1");
+      createTempFile(tmpDir, "pytest.ini", "[tool:pytest]");
+      createTempFile(tmpDir, "src/app.py", "x = 1");
 
       const result = client.detectRunner(tmpDir);
       expect(result).not.toBeNull();
@@ -59,8 +51,8 @@ describe("TestRunnerClient", () => {
 
     it("should detect runner from node_modules", () => {
       // Create a node_modules/vitest to simulate installed package
-      createTempFile("node_modules/vitest/package.json", "{}");
-      createTempFile("src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "node_modules/vitest/package.json", "{}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
 
       const result = client.detectRunner(tmpDir);
       // Should detect vitest from node_modules
@@ -68,9 +60,9 @@ describe("TestRunnerClient", () => {
     });
 
     it("should prefer vitest over jest when both exist", () => {
-      createTempFile("vitest.config.ts", "export default {}");
-      createTempFile("jest.config.js", "module.exports = {}");
-      createTempFile("src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "vitest.config.ts", "export default {}");
+      createTempFile(tmpDir, "jest.config.js", "module.exports = {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
 
       const result = client.detectRunner(tmpDir);
       expect(result!.runner).toBe("vitest");
@@ -79,9 +71,9 @@ describe("TestRunnerClient", () => {
 
   describe("findTestFile", () => {
     it("should find test file with .test.ts suffix", () => {
-      createTempFile("vitest.config.ts", "export default {}");
-      createTempFile("src/app.ts", "export const app = {};");
-      createTempFile("src/app.test.ts", "describe('app', () => {});");
+      createTempFile(tmpDir, "vitest.config.ts", "export default {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "src/app.test.ts", "describe('app', () => {});");
 
       const result = client.findTestFile(path.join(tmpDir, "src/app.ts"), tmpDir);
       expect(result).not.toBeNull();
@@ -90,9 +82,9 @@ describe("TestRunnerClient", () => {
     });
 
     it("should find test file with .spec.ts suffix", () => {
-      createTempFile("vitest.config.ts", "export default {}");
-      createTempFile("src/app.ts", "export const app = {};");
-      createTempFile("src/app.spec.ts", "describe('app', () => {});");
+      createTempFile(tmpDir, "vitest.config.ts", "export default {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "src/app.spec.ts", "describe('app', () => {});");
 
       const result = client.findTestFile(path.join(tmpDir, "src/app.ts"), tmpDir);
       expect(result).not.toBeNull();
@@ -100,9 +92,9 @@ describe("TestRunnerClient", () => {
     });
 
     it("should find test file in __tests__ directory", () => {
-      createTempFile("vitest.config.ts", "export default {}");
-      createTempFile("src/app.ts", "export const app = {};");
-      createTempFile("src/__tests__/app.test.ts", "describe('app', () => {});");
+      createTempFile(tmpDir, "vitest.config.ts", "export default {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "src/__tests__/app.test.ts", "describe('app', () => {});");
 
       const result = client.findTestFile(path.join(tmpDir, "src/app.ts"), tmpDir);
       expect(result).not.toBeNull();
@@ -110,9 +102,9 @@ describe("TestRunnerClient", () => {
     });
 
     it("should find test file in top-level tests/ directory", () => {
-      createTempFile("vitest.config.ts", "export default {}");
-      createTempFile("src/app.ts", "export const app = {};");
-      createTempFile("tests/app.test.ts", "describe('app', () => {});");
+      createTempFile(tmpDir, "vitest.config.ts", "export default {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "tests/app.test.ts", "describe('app', () => {});");
 
       const result = client.findTestFile(path.join(tmpDir, "src/app.ts"), tmpDir);
       expect(result).not.toBeNull();
@@ -120,9 +112,9 @@ describe("TestRunnerClient", () => {
     });
 
     it("should find pytest test file with test_ prefix", () => {
-      createTempFile("pytest.ini", "[tool:pytest]");
-      createTempFile("src/app.py", "x = 1");
-      createTempFile("tests/test_app.py", "def test_app(): pass");
+      createTempFile(tmpDir, "pytest.ini", "[tool:pytest]");
+      createTempFile(tmpDir, "src/app.py", "x = 1");
+      createTempFile(tmpDir, "tests/test_app.py", "def test_app(): pass");
 
       const result = client.findTestFile(path.join(tmpDir, "src/app.py"), tmpDir);
       expect(result).not.toBeNull();
@@ -131,8 +123,8 @@ describe("TestRunnerClient", () => {
     });
 
     it("should return null when no test file found", () => {
-      createTempFile("vitest.config.ts", "export default {}");
-      createTempFile("src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "vitest.config.ts", "export default {}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
 
       const result = client.findTestFile(path.join(tmpDir, "src/app.ts"), tmpDir);
       expect(result).toBeNull();
@@ -140,9 +132,9 @@ describe("TestRunnerClient", () => {
 
     it("should find test file even without config (if runner installed)", () => {
       // Simulate vitest installed in node_modules
-      createTempFile("node_modules/vitest/package.json", "{}");
-      createTempFile("src/app.ts", "export const app = {};");
-      createTempFile("src/app.test.ts", "describe('app', () => {});");
+      createTempFile(tmpDir, "node_modules/vitest/package.json", "{}");
+      createTempFile(tmpDir, "src/app.ts", "export const app = {};");
+      createTempFile(tmpDir, "src/app.test.ts", "describe('app', () => {});");
 
       const result = client.findTestFile(path.join(tmpDir, "src/app.ts"), tmpDir);
       // Should find the test file since vitest is "installed"

package/clients/test-utils.ts

@@ -0,0 +1,31 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+import * as os from "node:os";
+
+/**
+ * Creates a temporary file within the given temp directory.
+ * Automatically creates parent directories if they don't exist.
+ */
+export function createTempFile(tmpDir: string, name: string, content: string): string {
+	const filePath = path.join(tmpDir, name);
+	const dir = path.dirname(filePath);
+	if (!fs.existsSync(dir)) {
+		fs.mkdirSync(dir, { recursive: true });
+	}
+	fs.writeFileSync(filePath, content);
+	return filePath;
+}
+
+/**
+ * Creates a temporary directory for testing.
+ * Returns the path and a cleanup function.
+ */
+export function setupTestEnvironment(prefix: string): { tmpDir: string; cleanup: () => void } {
+	const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), prefix));
+	const cleanup = () => {
+		if (tmpDir && fs.existsSync(tmpDir)) {
+			fs.rmSync(tmpDir, { recursive: true });
+		}
+	};
+	return { tmpDir, cleanup };
+}

package/clients/todo-scanner.test.ts

@@ -1,37 +1,24 @@
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { TodoScanner } from "./todo-scanner.js";
-import * as fs from "node:fs";
-import * as path from "node:path";
-import * as os from "node:os";
+import { createTempFile, setupTestEnvironment } from "./test-utils.js";
 
 describe("TodoScanner", () => {
-  let scanner: TodoScanner;
+  let client: TodoScanner;
   let tmpDir: string;
-
-  function createTempFile(name: string, content: string): string {
-    const filePath = path.join(tmpDir, name);
-    const dir = path.dirname(filePath);
-    if (!fs.existsSync(dir)) {
-      fs.mkdirSync(dir, { recursive: true });
-    }
-    fs.writeFileSync(filePath, content);
-    return filePath;
-  }
+  let cleanup: () => void;
 
   beforeEach(() => {
-    scanner = new TodoScanner();
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pi-lens-todo-test-"));
+    client = new TodoScanner();
+    ({ tmpDir, cleanup } = setupTestEnvironment("pi-lens-todo-test-"));
   });
 
   afterEach(() => {
-    if (tmpDir && fs.existsSync(tmpDir)) {
-      fs.rmSync(tmpDir, { recursive: true });
-    }
+    cleanup();
   });
 
   describe("scanFile", () => {
     it("should return empty array for non-existent files", () => {
-      const result = scanner.scanFile("/nonexistent/file.ts");
+      const result = client.scanFile("/nonexistent/file.ts");
       expect(result).toEqual([]);
     });
 
@@ -40,8 +27,8 @@ describe("TodoScanner", () => {
 // TODO: implement this function
 function foo() {}
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("TODO");
@@ -53,8 +40,8 @@ function foo() {}
 // FIXME: this is broken
 function foo() {}
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("FIXME");
@@ -65,8 +52,8 @@ function foo() {}
 // HACK: temporary workaround
 const x = 1;
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("HACK");
@@ -77,8 +64,8 @@ const x = 1;
 // BUG: this causes a crash
 const x = 1;
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("BUG");
@@ -89,8 +76,8 @@ const x = 1;
 // NOTE: important design decision
 const x = 1;
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("NOTE");
@@ -103,8 +90,8 @@ const x = 1;
  */
 const x = 1;
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("TODO");
@@ -117,8 +104,8 @@ const x = 1;
  */
 function foo() {}
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("TODO");
@@ -130,8 +117,8 @@ function foo() {}
 def foo():
     pass
 `;
-      const filePath = createTempFile("test.py", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.py", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(1);
       expect(result[0].type).toBe("TODO");
@@ -141,8 +128,8 @@ def foo():
       const content = `
 const message = "TODO: buy milk";
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(0);
     });
@@ -154,8 +141,8 @@ const y = 2;
 // TODO: fix this
 const z = 3;
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result[0].line).toBe(4);
     });
@@ -166,8 +153,8 @@ const z = 3;
 // FIXME: second
 // HACK: third
 `;
-      const filePath = createTempFile("test.ts", content);
-      const result = scanner.scanFile(filePath);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
+      const result = client.scanFile(filePath);
 
       expect(result.length).toBe(3);
     });
@@ -175,41 +162,41 @@ const z = 3;
 
   describe("scanDirectory", () => {
     it("should scan all files in directory", () => {
-      createTempFile("file1.ts", "// TODO: task 1");
-      createTempFile("file2.ts", "// FIXME: bug 1");
-      createTempFile("file3.py", "# HACK: workaround");
+      createTempFile(tmpDir, "file1.ts", "// TODO: task 1");
+      createTempFile(tmpDir, "file2.ts", "// FIXME: bug 1");
+      createTempFile(tmpDir, "file3.py", "# HACK: workaround");
 
-      const result = scanner.scanDirectory(tmpDir);
+      const result = client.scanDirectory(tmpDir);
 
       expect(result.items.length).toBe(3);
     });
 
     it("should skip node_modules", () => {
-      createTempFile("src/file.ts", "// TODO: task 1");
-      createTempFile("node_modules/lib/file.ts", "// TODO: should be skipped");
+      createTempFile(tmpDir, "src/file.ts", "// TODO: task 1");
+      createTempFile(tmpDir, "node_modules/lib/file.ts", "// TODO: should be skipped");
 
-      const result = scanner.scanDirectory(tmpDir);
+      const result = client.scanDirectory(tmpDir);
 
       expect(result.items.length).toBe(1);
       expect(result.items[0].file).not.toContain("node_modules");
     });
 
     it("should group items by type", () => {
-      createTempFile("file1.ts", "// TODO: task 1");
-      createTempFile("file2.ts", "// TODO: task 2");
-      createTempFile("file3.ts", "// FIXME: bug 1");
+      createTempFile(tmpDir, "file1.ts", "// TODO: task 1");
+      createTempFile(tmpDir, "file2.ts", "// TODO: task 2");
+      createTempFile(tmpDir, "file3.ts", "// FIXME: bug 1");
 
-      const result = scanner.scanDirectory(tmpDir);
+      const result = client.scanDirectory(tmpDir);
 
       expect(result.byType.get("TODO")?.length).toBe(2);
       expect(result.byType.get("FIXME")?.length).toBe(1);
     });
 
     it("should group items by file", () => {
-      createTempFile("file1.ts", "// TODO: task 1\n// FIXME: bug 1");
-      createTempFile("file2.ts", "// TODO: task 2");
+      createTempFile(tmpDir, "file1.ts", "// TODO: task 1\n// FIXME: bug 1");
+      createTempFile(tmpDir, "file2.ts", "// TODO: task 2");
 
-      const result = scanner.scanDirectory(tmpDir);
+      const result = client.scanDirectory(tmpDir);
 
       const file1Items = [...result.byFile.entries()].find(([k]) => k.includes("file1.ts"));
       expect(file1Items?.[1].length).toBe(2);
@@ -219,7 +206,7 @@ const z = 3;
   describe("formatResult", () => {
     it("should return empty string for no results", () => {
       const result = { items: [], byType: new Map(), byFile: new Map() };
-      expect(scanner.formatResult(result)).toBe("");
+      expect(client.formatResult(result)).toBe("");
     });
 
     it("should format results with counts", () => {
@@ -232,7 +219,7 @@ const z = 3;
         byFile: new Map([["test.ts", [{ type: "TODO" as const, message: "task 1", file: "test.ts", line: 1, column: 0 }]]]),
       };
 
-      const formatted = scanner.formatResult(result);
+      const formatted = client.formatResult(result);
       expect(formatted).toContain("2 annotation(s)");
       expect(formatted).toContain("TODO");
       expect(formatted).toContain("FIXME");
@@ -248,7 +235,7 @@ const z = 3;
         byFile: new Map(),
       };
 
-      const formatted = scanner.formatResult(result);
+      const formatted = client.formatResult(result);
       // Check that FIXME line comes before TODO line in the sorted output
       const fixmeLineIndex = formatted.indexOf("🔴");
       const todoLineIndex = formatted.indexOf("📝");
@@ -268,7 +255,7 @@ const z = 3;
         byFile: new Map(),
       };
 
-      const formatted = scanner.formatResult(result);
+      const formatted = client.formatResult(result);
       expect(formatted).toContain("🔴"); // FIXME
       expect(formatted).toContain("🟠"); // HACK
       expect(formatted).toContain("🐛"); // BUG

package/clients/todo-scanner.ts

@@ -130,6 +130,8 @@ export class TodoScanner {
         } else if (extensions.some(ext => entry.name.endsWith(ext))) {
           // Skip this scanner file — its own type literals and regex cause false positives
           if (entry.name === "todo-scanner.ts" || entry.name === "todo-scanner.js") continue;
+          // Skip test files — intentional annotations are test fixtures, not work items
+          if (/\.(test|spec)\.[jt]sx?$/.test(entry.name)) continue;
           items.push(...this.scanFile(fullPath));
         }
       }

package/clients/type-coverage-client.test.ts

@@ -1,22 +1,23 @@
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { TypeCoverageClient } from "./type-coverage-client.js";
-import * as fs from "node:fs";
-import * as path from "node:path";
-import * as os from "node:os";
+import { setupTestEnvironment } from "./test-utils.js";
 
 describe("TypeCoverageClient", () => {
   let client: TypeCoverageClient;
   let tmpDir: string;
+  let cleanup: () => void;
 
   beforeEach(() => {
     client = new TypeCoverageClient();
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pi-lens-typecoverage-test-"));
+    ({ tmpDir, cleanup } = setupTestEnvironment("pi-lens-typecoverage-test-"));
   });
 
   afterEach(() => {
-    if (tmpDir && fs.existsSync(tmpDir)) {
-      fs.rmSync(tmpDir, { recursive: true });
-    }
+    cleanup();
+  });
+
+  afterEach(() => {
+    cleanup();
   });
 
   describe("isAvailable", () => {

package/clients/typescript-client.test.ts

@@ -1,32 +1,23 @@
 import { describe, it, expect, beforeEach, afterEach } from "vitest";
 import { TypeScriptClient } from "./typescript-client.js";
-import * as fs from "node:fs";
-import * as path from "node:path";
-import * as os from "node:os";
+import { createTempFile, setupTestEnvironment } from "./test-utils.js";
 
 describe("TypeScriptClient", () => {
   let client: TypeScriptClient;
   let tmpDir: string;
-
-  function createTempFile(name: string, content: string): string {
-    const filePath = path.join(tmpDir, name);
-    const dir = path.dirname(filePath);
-    if (!fs.existsSync(dir)) {
-      fs.mkdirSync(dir, { recursive: true });
-    }
-    fs.writeFileSync(filePath, content);
-    return filePath;
-  }
+  let cleanup: () => void;
 
   beforeEach(() => {
     client = new TypeScriptClient();
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pi-lens-ts-test-"));
+    ({ tmpDir, cleanup } = setupTestEnvironment("pi-lens-ts-test-"));
+  });
+
+  afterEach(() => {
+    cleanup();
   });
 
   afterEach(() => {
-    if (tmpDir && fs.existsSync(tmpDir)) {
-      fs.rmSync(tmpDir, { recursive: true });
-    }
+    cleanup();
   });
 
   describe("isTypeScriptFile", () => {
@@ -51,7 +42,7 @@ describe("TypeScriptClient", () => {
       const content = `
 const x: number = "string"; // Type error
 `;
-      const filePath = createTempFile("test.ts", content);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
 
       client.updateFile(filePath, content);
       const diags = client.getDiagnostics(filePath);
@@ -65,7 +56,7 @@ const x: number = "string"; // Type error
 const x: number = 42;
 const y: string = "hello";
 `;
-      const filePath = createTempFile("test.ts", content);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
 
       client.updateFile(filePath, content);
       const diags = client.getDiagnostics(filePath);
@@ -81,7 +72,7 @@ function test() {
   return undefinedVariable;
 }
 `;
-      const filePath = createTempFile("test.ts", content);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
 
       client.updateFile(filePath, content);
       const diags = client.getDiagnostics(filePath);
@@ -96,7 +87,7 @@ function add(a: number, b: number): number {
 }
 const result = add(1);
 `;
-      const filePath = createTempFile("test.ts", content);
+      const filePath = createTempFile(tmpDir, "test.ts", content);
 
       client.updateFile(filePath, content);
       const diags = client.getDiagnostics(filePath);