@possumtech/rummy.repo 0.0.1 → 0.0.3

package/README.md

@@ -2,11 +2,11 @@
 
 Symbol extraction plugin for [Rummy](https://github.com/possumtech/rummy). Turns source files into structured symbol maps using [antlrmap](https://github.com/possumtech/antlrmap) (formal ANTLR4 grammars) with [Universal Ctags](https://ctags.io/) as a fallback.
 
-Antlrmap relies on ANTLR4's Grammar Zoo, mapping the symbol extraction process from formal EBNF grammars. More academically rigorous than tree-sitter heuristics, more accurate than ctags regex patterns, and more amenable to obscure and domain-specific languages. Don't like it? This is why symbol extraction is a plugin -- swap it out in 20 lines.
+Antlrmap relies on ANTLR4's Grammar Zoo, mapping the symbol extraction process from formal EBNF grammars. More academically rigorous than tree-sitter heuristics, more accurate than ctags regex patterns, and more amenable to obscure and domain-specific languages. Don't like it? This is why symbol extraction is a plugin -- swap it out.
 
 ## What It Does
 
-When files change in a Rummy project, this plugin extracts their symbols (functions, classes, methods, fields) and returns them as structured data. Rummy stores the formatted symbol tree in file entry attributes, giving the model a compact map of the codebase without reading every file.
+When files change in a Rummy project, this plugin reacts to `entry.changed` events, extracts symbols (functions, classes, methods, fields) from the changed files, and writes a formatted symbol tree into each file entry's `attributes.symbols`. This gives the model a compact structural overview of the codebase without reading every file in full.
 
 ## Supported Languages
 
@@ -29,25 +29,11 @@ Rummy loads plugins from `~/.rummy/plugins/` on startup. No configuration requir
 
 ## Usage
 
-The plugin registers automatically via the standard Rummy plugin contract. No manual setup needed.
+The plugin registers automatically via the Rummy plugin contract. No manual setup needed.
 
 ```js
-// Rummy's plugin loader calls this automatically:
 import RepoMapPlugin from "@possumtech/rummy.repo";
-RepoMapPlugin.register(hooks);
-```
-
-### formatSymbols
-
-The plugin exposes a `formatSymbols` helper for rendering symbol arrays as indented text:
-
-```js
-import RepoMapPlugin from "@possumtech/rummy.repo";
-
-const text = RepoMapPlugin.formatSymbols(symbols);
-// class MyClass L1
-//   method doThing(a, b) L5
-//   field name L3
+new RepoMapPlugin(core);
 ```
 
 ## Development

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@possumtech/rummy.repo",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"description": "Rummy plugin for symbol extraction via antlrmap and ctags",
 	"keywords": [
 		"rummy",

package/src/rummy.repo.js

@@ -1,59 +1,49 @@
-import { readFileSync } from "node:fs";
-import { extname, join } from "node:path";
+import { extname } from "node:path";
 import Antlrmap from "@possumtech/antlrmap";
 import CtagsExtractor from "./CtagsExtractor.js";
 import formatSymbols from "./formatSymbols.js";
 
 const antlrmapSupported = new Set(Object.keys(Antlrmap.extensions));
 
-/**
- * RepoMapPlugin: symbol extraction via antlrmap (ANTLR4 grammars)
- * with ctags fallback.
- *
- * Filter: hooks.file.symbols
- * Input:  Map (empty or partially populated)
- * Context: { paths, projectPath }
- *   - paths: string[] of relative file paths that changed
- *   - projectPath: string, absolute project root
- * Output: Map<string, symbol[]> where symbol = { name, kind?, params?, line?, endLine? }
- */
 export default class RepoMapPlugin {
-	static register(hooks) {
-		hooks.file.symbols.addFilter(async (symbolMap, { paths, projectPath }) => {
-			const result = symbolMap instanceof Map ? symbolMap : new Map();
-			const antlrmap = new Antlrmap();
-			const ctagsQueue = [];
+	constructor(core) {
+		core.on("entry.changed", this.#onChanged.bind(this));
+	}
+
+	async #onChanged({ rummy, paths }) {
+		const antlrmap = new Antlrmap();
+		const ctagsQueue = [];
 
-			for (const relPath of paths) {
-				if (result.has(relPath)) continue;
-				const ext = extname(relPath);
+		for (const path of paths) {
+			const ext = extname(path);
+			if (!ext) continue;
 
-				if (antlrmapSupported.has(ext)) {
-					try {
-						const content = readFileSync(join(projectPath, relPath), "utf8");
-						const symbols = await antlrmap.mapSource(content, ext);
-						if (symbols?.length > 0) {
-							result.set(relPath, symbols);
-							continue;
-						}
-					} catch {
-						// Fall through to ctags
+			if (antlrmapSupported.has(ext)) {
+				const body = await rummy.getBody(path);
+				if (!body) continue;
+				try {
+					const symbols = await antlrmap.mapSource(body, ext);
+					if (symbols?.length > 0) {
+						await rummy.setAttributes(path, {
+							symbols: formatSymbols(symbols),
+						});
+						continue;
 					}
+				} catch {
+					// Fall through to ctags
 				}
-				ctagsQueue.push(relPath);
 			}
+			ctagsQueue.push(path);
+		}
 
-			if (ctagsQueue.length > 0) {
-				const extractor = new CtagsExtractor(projectPath);
-				const ctagsResults = extractor.extract(ctagsQueue);
-				for (const [path, symbols] of ctagsResults) {
-					if (symbols.length > 0) result.set(path, symbols);
+		if (ctagsQueue.length > 0) {
+			const extractor = new CtagsExtractor(rummy.project.project_root);
+			const ctagsResults = extractor.extract(ctagsQueue);
+			for (const [path, symbols] of ctagsResults) {
+				if (symbols.length > 0) {
+					await rummy.setAttributes(path, { symbols: formatSymbols(symbols) });
 				}
 			}
-
-			return result;
-		}, 50);
+		}
 	}
-
-	static formatSymbols = formatSymbols;
 }