@neuralsea/workspace-indexer 0.1.0 → 0.3.2

package/README.md

@@ -1,4 +1,4 @@
-# @petri-ai/workspace-indexer
+# @neuralsea/workspace-indexer
 
 A **local-first**, **multi-repo** workspace indexer for AI agents (e.g. your custom agent “Damocles”).
 
@@ -31,17 +31,21 @@ This package is designed so Damocles can use the same index in different problem
 npm i @neuralsea/workspace-indexer
 ```
 
-Node 18+ recommended.
+Node 18+ required.
 
 ---
 
 ## Quick start (library)
 
 ```ts
-import { WorkspaceIndexer, OllamaEmbeddingsProvider } from "@neuralsea/workspace-indexer";
+import { WorkspaceIndexer, OllamaEmbeddingsProvider, IndexerProgressObservable } from "@neuralsea/workspace-indexer";
 
 const embedder = new OllamaEmbeddingsProvider({ model: "nomic-embed-text" });
-const ix = new WorkspaceIndexer("/path/to/workspace", embedder);
+
+const progress = new IndexerProgressObservable();
+progress.subscribe(e => console.log(e.type, e));
+
+const ix = new WorkspaceIndexer("/path/to/workspace", embedder, { progress });
 
 await ix.indexAll();
 
@@ -63,6 +67,26 @@ await ix.closeAsync();
 
 ---
 
+## VS Code: high-fidelity symbol graphs (optional)
+
+In a VS Code extension, you can pass a `symbolGraphProvider` that uses VS Code (LSP-backed) providers to extract symbols.
+
+```ts
+import { WorkspaceIndexer, createVSCodeSymbolGraphProvider } from "@neuralsea/workspace-indexer";
+
+const symbolGraphProvider = await createVSCodeSymbolGraphProvider({
+  languages: ["typescript", "javascript", "python", "go"]
+});
+
+const ix = new WorkspaceIndexer(workspaceRoot, embedder, {
+  symbolGraphProvider: symbolGraphProvider ?? undefined
+});
+```
+
+To enable the optional Neo4j graph store, install `neo4j-driver` in your extension/app and set `workspace.graph` in config.
+
+---
+
 ## CLI
 
 ### Index a workspace
@@ -139,6 +163,29 @@ Example: `petri-index.config.json`
 
 ```json
 {
+  "workspace": {
+    "discovery": {
+      "exclude": ["**/vendor/**", "**/node_modules/**"],
+      "maxDepth": 8,
+      "includeSubmodules": true
+    },
+    "graph": {
+      "provider": "neo4j",
+      "neo4j": {
+        "uri": "neo4j://localhost:7687",
+        "user": "neo4j",
+        "password": "password",
+        "database": "neo4j",
+        "labelPrefix": "Petri"
+      }
+    },
+    "repoOverrides": [
+      {
+        "match": "apps/**",
+        "config": { "storage": { "ftsMode": "tokens" } }
+      }
+    ]
+  },
   "storage": {
     "storeText": true,
     "ftsMode": "full"