@twahaa/codefinder 1.0.0 → 1.0.2

package/README.md

@@ -175,6 +175,36 @@ You will be prompted for:
 
 ---
 
+## Installation and Usage
+
+The `codefinder` package provides a command-line interface (CLI) tool for exploring and searching codebases.
+
+### Installation
+
+To install `codefinder` globally, run:
+
+```bash
+npm install -g @twahaa/codefinder
+```
+
+Alternatively, you can use `npx` to run it without global installation:
+
+```bash
+npx @twahaa/codefinder
+```
+
+### Usage
+
+Once installed, you can run the `codefinder` command from your terminal:
+
+```bash
+codefinder
+```
+
+This will launch an interactive Gemini client that allows you to explore and search codebases using the provided MCP tools. Follow the on-screen prompts to interact with the client.
+
+---
+
 ## What the Server Provides (Tools)
 
 The MCP server exposes three safe, deterministic tools:

package/build/client.js

@@ -23,7 +23,7 @@ const transport = new StdioClientTransport({
 });
 const mcpClient = new Client({
     name: "CodeFinder",
-    version: "1.0.0",
+    version: "1.0.1",
 });
 await mcpClient.connect(transport);
 const apiKeyInput = await text({

package/build/server.js

@@ -6,7 +6,7 @@ import { readFile } from "./tools/readFile.js";
 import { listFile } from "./tools/listFile.js";
 const server = new McpServer({
     name: "CodeFinder",
-    version: "1.0.0",
+    version: "1.0.1",
 }, {
     capabilities: {
         tools: {},

package/build/tools/listFile.js

@@ -1,18 +1,7 @@
 import fs from "fs";
 import path from "path";
 import { resolveSafePath } from "../utils/pathGuard.js";
-const IGNORE = new Set([
-    "node_modules",
-    ".git",
-    "dist",
-    "build",
-    ".next",
-    ".env",
-    "package-lock.json",
-    "yarn.lock",
-    "pnpm-lock.yaml",
-    "package.json",
-]);
+import { IGNORE_LIST } from "../utils/ignoreList.js";
 const MAX_DEPTH = 2;
 export function listFile(dir = ".") {
     const safeDir = resolveSafePath(dir);
@@ -26,7 +15,7 @@ function walkDirectory(absoluteDir, depth) {
     const entires = fs.readdirSync(absoluteDir, { withFileTypes: true });
     const result = [];
     for (const entry of entires) {
-        if (IGNORE.has(entry.name))
+        if (IGNORE_LIST.has(entry.name))
             continue;
         const entryPath = path.join(absoluteDir, entry.name);
         if (entry.isFile()) {

package/build/utils/ignoreList.js

@@ -0,0 +1,41 @@
+export const IGNORE_LIST = new Set([
+    // Version control
+    ".git",
+    ".svn",
+    ".hg",
+    // Dependencies
+    "node_modules",
+    "bower_components",
+    // Build outputs
+    "dist",
+    "build",
+    ".next",
+    "out",
+    "coverage",
+    // Environment variables
+    ".env",
+    ".env.local",
+    ".env.development",
+    ".env.test",
+    ".env.production",
+    // Lock files
+    "package-lock.json",
+    "yarn.lock",
+    "pnpm-lock.yaml",
+    // IDEs and editors
+    ".vscode",
+    ".idea",
+    ".project",
+    ".classpath",
+    ".settings",
+    // OS generated files
+    ".DS_Store",
+    "Thumbs.db",
+    // npm
+    ".npmrc",
+    ".npm",
+    // yarn
+    ".yarnrc",
+    // Project config
+    "package.json",
+]);

package/package.json

@@ -9,7 +9,7 @@
     "zod": "^3.25.76"
   },
   "name": "@twahaa/codefinder",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "MCP server and interactive Gemini client for exploring and searching codebases.",
   "main": "build/server.js",
   "exports": {