doc-freshness-checker 1.0.0

package/dist/graph/graphBuilder.js

@@ -0,0 +1,76 @@
+import path from 'path';
+import { CodeDocGraph } from './codeDocGraph.js';
+/**
+ * Builds the code-to-doc relationship graph
+ */
+export class GraphBuilder {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Build the complete code-to-doc graph
+     */
+    async buildGraph(documents, codeIndex) {
+        const graph = new CodeDocGraph();
+        const indexedFilePaths = codeIndex
+            ? new Set(Array.from(codeIndex.values()).flatMap((locations) => locations.map((loc) => loc.filePath)))
+            : null;
+        // Resolve references and build edges
+        for (const doc of documents) {
+            for (const ref of doc.references) {
+                const resolvedFiles = this.resolveReference(ref, doc, codeIndex, indexedFilePaths);
+                for (const codeFile of resolvedFiles) {
+                    graph.addReference(doc.path, codeFile, ref);
+                }
+            }
+        }
+        // Store code symbols for change detection
+        if (codeIndex) {
+            for (const [symbolName, locations] of codeIndex.entries()) {
+                for (const location of locations) {
+                    if (!graph.codeSymbols.has(location.filePath)) {
+                        graph.codeSymbols.set(location.filePath, new Set());
+                    }
+                    graph.codeSymbols.get(location.filePath).add(symbolName);
+                }
+            }
+        }
+        graph.buildTimestamp = Date.now();
+        return graph;
+    }
+    /**
+     * Resolve a reference to actual code files
+     */
+    resolveReference(ref, doc, codeIndex, indexedFilePaths) {
+        const resolvedFiles = [];
+        switch (ref.type) {
+            case 'file-path': {
+                // Direct file reference
+                const docDir = path.dirname(doc.absolutePath || doc.path);
+                const resolvedPath = path.resolve(docDir, ref.value);
+                const relativePath = path.relative(this.config.rootDir || process.cwd(), resolvedPath);
+                if (indexedFilePaths?.has(relativePath)) {
+                    resolvedFiles.push(relativePath);
+                }
+                break;
+            }
+            case 'code-pattern': {
+                // Symbol reference - find files containing this symbol
+                if (codeIndex && codeIndex.has(ref.value)) {
+                    const locations = codeIndex.get(ref.value);
+                    for (const loc of locations) {
+                        resolvedFiles.push(loc.filePath);
+                    }
+                }
+                break;
+            }
+            case 'dependency':
+                // Package reference - could map to local packages in monorepo
+                // Skip for now - external packages
+                break;
+        }
+        return resolvedFiles;
+    }
+}
+//# sourceMappingURL=graphBuilder.js.map

package/dist/graph/graphBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphBuilder.js","sourceRoot":"","sources":["../../src/graph/graphBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD;;GAEG;AACH,MAAM,OAAO,YAAY;IACf,MAAM,CAAqB;IAEnC,YAAY,MAA0B;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,SAAqB,EAAE,SAA+C;QACrF,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;QACjC,MAAM,gBAAgB,GAAG,SAAS;YAChC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;YACtG,CAAC,CAAC,IAAI,CAAC;QAET,qCAAqC;QACrC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;gBACjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC;gBAEnF,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE,CAAC;oBACrC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;QACH,CAAC;QAED,0CAA0C;QAC1C,IAAI,SAAS,EAAE,CAAC;YACd,KAAK,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC1D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBACjC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC9C,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;oBACtD,CAAC;oBACD,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAElC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACK,gBAAgB,CACtB,GAAc,EACd,GAAa,EACb,SAA+C,EAC/C,gBAAoC;QAEpC,MAAM,aAAa,GAAa,EAAE,CAAC;QAEnC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,wBAAwB;gBACxB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC1D,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBACrD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC;gBAEvF,IAAI,gBAAgB,EAAE,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;oBACxC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACnC,CAAC;gBACD,MAAM;YACR,CAAC;YAED,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,uDAAuD;gBACvD,IAAI,SAAS,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;oBAC5C,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;wBAC5B,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACnC,CAAC;gBACH,CAAC;gBACD,MAAM;YACR,CAAC;YAED,KAAK,YAAY;gBACf,8DAA8D;gBAC9D,mCAAmC;gBACnC,MAAM;QACV,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}

package/dist/graph/graphBuilder.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/graph/graphBuilder.test.js

@@ -0,0 +1,87 @@
+import { GraphBuilder } from './graphBuilder.js';
+function makeDoc(docPath, refs) {
+    return {
+        path: docPath,
+        absolutePath: `${process.cwd()}/${docPath}`,
+        content: '',
+        format: 'markdown',
+        lines: [],
+        references: refs,
+    };
+}
+function makeRef(type, value) {
+    return { type, value, lineNumber: 1, raw: value, sourceFile: 'doc.md' };
+}
+describe('GraphBuilder', () => {
+    const config = { rootDir: process.cwd() };
+    it('builds graph from code-pattern references', async () => {
+        const codeIndex = new Map([
+            ['MyClass', [{ filePath: 'src/myClass.ts', kind: 'class', language: 'typescript' }]],
+        ]);
+        const docs = [makeDoc('docs/api.md', [makeRef('code-pattern', 'MyClass')])];
+        const graph = await new GraphBuilder(config).buildGraph(docs, codeIndex);
+        expect(graph.getCodeReferencedByDoc('docs/api.md').has('src/myClass.ts')).toBe(true);
+        expect(graph.codeSymbols.get('src/myClass.ts')?.has('MyClass')).toBe(true);
+    });
+    it('stores code symbols from the index', async () => {
+        const codeIndex = new Map([
+            ['FuncA', [{ filePath: 'src/a.ts', kind: 'function', language: 'typescript' }]],
+            ['FuncB', [{ filePath: 'src/a.ts', kind: 'function', language: 'typescript' }]],
+        ]);
+        const graph = await new GraphBuilder(config).buildGraph([], codeIndex);
+        expect(graph.codeSymbols.get('src/a.ts')?.size).toBe(2);
+    });
+    it('resolves file-path references when file is in code index', async () => {
+        const codeIndex = new Map([
+            ['SomeFunc', [{ filePath: 'src/utils.ts', kind: 'function', language: 'typescript' }]],
+        ]);
+        const docs = [makeDoc('docs/guide.md', [makeRef('file-path', '../src/utils.ts')])];
+        const graph = await new GraphBuilder(config).buildGraph(docs, codeIndex);
+        expect(graph.getCodeReferencedByDoc('docs/guide.md').has('src/utils.ts')).toBe(true);
+    });
+    it('does not resolve file-path when file is not in code index', async () => {
+        const codeIndex = new Map([
+            ['Other', [{ filePath: 'src/other.ts', kind: 'function', language: 'typescript' }]],
+        ]);
+        const docs = [makeDoc('docs/guide.md', [makeRef('file-path', '../src/missing.ts')])];
+        const graph = await new GraphBuilder(config).buildGraph(docs, codeIndex);
+        expect(graph.getCodeReferencedByDoc('docs/guide.md').size).toBe(0);
+    });
+    it('does not resolve file-path when codeIndex is null', async () => {
+        const docs = [makeDoc('docs/guide.md', [makeRef('file-path', '../src/utils.ts')])];
+        const graph = await new GraphBuilder(config).buildGraph(docs, null);
+        expect(graph.getCodeReferencedByDoc('docs/guide.md').size).toBe(0);
+    });
+    it('ignores dependency references (external packages)', async () => {
+        const docs = [makeDoc('docs/api.md', [makeRef('dependency', 'express')])];
+        const graph = await new GraphBuilder(config).buildGraph(docs, new Map());
+        expect(graph.getCodeReferencedByDoc('docs/api.md').size).toBe(0);
+    });
+    it('sets buildTimestamp on the graph', async () => {
+        const before = Date.now();
+        const graph = await new GraphBuilder(config).buildGraph([], null);
+        expect(graph.buildTimestamp).toBeGreaterThanOrEqual(before);
+    });
+    it('handles null codeIndex for code-pattern refs', async () => {
+        const docs = [makeDoc('docs/api.md', [makeRef('code-pattern', 'Missing')])];
+        const graph = await new GraphBuilder(config).buildGraph(docs, null);
+        expect(graph.getCodeReferencedByDoc('docs/api.md').size).toBe(0);
+    });
+    it('resolves code-pattern to multiple files', async () => {
+        const codeIndex = new Map([
+            [
+                'SharedFunc',
+                [
+                    { filePath: 'src/a.ts', kind: 'function', language: 'typescript' },
+                    { filePath: 'src/b.ts', kind: 'function', language: 'typescript' },
+                ],
+            ],
+        ]);
+        const docs = [makeDoc('docs/api.md', [makeRef('code-pattern', 'SharedFunc')])];
+        const graph = await new GraphBuilder(config).buildGraph(docs, codeIndex);
+        const refs = graph.getCodeReferencedByDoc('docs/api.md');
+        expect(refs.has('src/a.ts')).toBe(true);
+        expect(refs.has('src/b.ts')).toBe(true);
+    });
+});
+//# sourceMappingURL=graphBuilder.test.js.map

package/dist/graph/graphBuilder.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphBuilder.test.js","sourceRoot":"","sources":["../../src/graph/graphBuilder.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,SAAS,OAAO,CAAC,OAAe,EAAE,IAAiB;IACjD,OAAO;QACL,IAAI,EAAE,OAAO;QACb,YAAY,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,OAAO,EAAE;QAC3C,OAAO,EAAE,EAAE;QACX,MAAM,EAAE,UAAU;QAClB,KAAK,EAAE,EAAE;QACT,UAAU,EAAE,IAAI;KACjB,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,KAAa;IAC1C,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;AAC1E,CAAC;AAED,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,MAAM,GAAuB,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;IAE9D,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,SAAS,GAAG,IAAI,GAAG,CAA2B;YAClD,CAAC,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;SACrF,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrF,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,SAAS,GAAG,IAAI,GAAG,CAA2B;YAClD,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;YAC/E,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;SAChF,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,SAAS,GAAG,IAAI,GAAG,CAA2B;YAClD,CAAC,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;SACvF,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;QACnF,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,SAAS,GAAG,IAAI,GAAG,CAA2B;YAClD,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;SACpF,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;QACrF,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;QACnF,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAClE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,SAAS,GAAG,IAAI,GAAG,CAA2B;YAClD;gBACE,YAAY;gBACZ;oBACE,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE;oBAClE,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE;iBACnE;aACF;SACF,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,MAAM,KAAK,GAAG,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,KAAK,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QACzD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Documentation Freshness Checker
+ *
+ * A universal, project-agnostic tool that validates documentation accuracy
+ * by checking references against the actual codebase.
+ */
+export { run, runWithConfig } from './runner.js';
+export { loadConfig, DEFAULT_CONFIG } from './config/loader.js';
+export { defineConfig } from './config/defineConfig.js';
+export { DocumentParser } from './parsers/documentParser.js';
+export { ValidationEngine } from './validators/validationEngine.js';
+export { BaseExtractor } from './parsers/extractors/baseExtractor.js';
+export { FilePathExtractor } from './parsers/extractors/filePathExtractor.js';
+export { VersionExtractor } from './parsers/extractors/versionExtractor.js';
+export { DirectoryStructureExtractor } from './parsers/extractors/directoryStructureExtractor.js';
+export { CodePatternExtractor } from './parsers/extractors/codePatternExtractor.js';
+export { ExternalUrlExtractor } from './parsers/extractors/externalUrlExtractor.js';
+export { DependencyExtractor } from './parsers/extractors/dependencyExtractor.js';
+export { FileValidator } from './validators/fileValidator.js';
+export { UrlValidator } from './validators/urlValidator.js';
+export { VersionValidator } from './validators/versionValidator.js';
+export { DirectoryValidator } from './validators/directoryValidator.js';
+export { CodePatternValidator } from './validators/codePatternValidator.js';
+export { DependencyValidator } from './validators/dependencyValidator.js';
+export { ConsoleReporter } from './reporters/consoleReporter.js';
+export { JsonReporter } from './reporters/jsonReporter.js';
+export { MarkdownReporter } from './reporters/markdownReporter.js';
+export { EnhancedReporter } from './reporters/enhancedReporter.js';
+export { CodeDocGraph } from './graph/codeDocGraph.js';
+export { GraphBuilder } from './graph/graphBuilder.js';
+export { GitChangeTracker } from './git/changeTracker.js';
+export { CacheManager } from './cache/cacheManager.js';
+export { FreshnessScorer } from './scoring/freshnessScorer.js';
+export { Plugin } from './plugins/plugin.js';
+export { IncrementalChecker } from './utils/incremental.js';
+export { VectorSearch } from './semantic/vectorSearch.js';
+export type { DocFreshnessConfig, Document, DocumentFormat, Reference, ValidationResult, ValidationResults, ValidationSummary, DocumentIssues, VectorMismatch, Severity, RuleConfig, VersionRuleConfig, RulesConfig, UrlValidationConfig, GraphConfig, GitConfig, FreshnessScoringConfig, FreshnessScoringWeights, FreshnessScoringThresholds, VectorSearchConfig, CacheConfig, IncrementalConfig, ReporterType, Grade, DocScore, ProjectScores, CommitInfo, ChangeSummaryItem, IndexMetadata, CacheStats, SymbolLocation, SourceFileData, CodeFile, BaseExtractor as BaseExtractorType, BaseValidator, } from './types.js';

package/dist/index.js

@@ -0,0 +1,37 @@
+/**
+ * Documentation Freshness Checker
+ *
+ * A universal, project-agnostic tool that validates documentation accuracy
+ * by checking references against the actual codebase.
+ */
+export { run, runWithConfig } from './runner.js';
+export { loadConfig, DEFAULT_CONFIG } from './config/loader.js';
+export { defineConfig } from './config/defineConfig.js';
+export { DocumentParser } from './parsers/documentParser.js';
+export { ValidationEngine } from './validators/validationEngine.js';
+export { BaseExtractor } from './parsers/extractors/baseExtractor.js';
+export { FilePathExtractor } from './parsers/extractors/filePathExtractor.js';
+export { VersionExtractor } from './parsers/extractors/versionExtractor.js';
+export { DirectoryStructureExtractor } from './parsers/extractors/directoryStructureExtractor.js';
+export { CodePatternExtractor } from './parsers/extractors/codePatternExtractor.js';
+export { ExternalUrlExtractor } from './parsers/extractors/externalUrlExtractor.js';
+export { DependencyExtractor } from './parsers/extractors/dependencyExtractor.js';
+export { FileValidator } from './validators/fileValidator.js';
+export { UrlValidator } from './validators/urlValidator.js';
+export { VersionValidator } from './validators/versionValidator.js';
+export { DirectoryValidator } from './validators/directoryValidator.js';
+export { CodePatternValidator } from './validators/codePatternValidator.js';
+export { DependencyValidator } from './validators/dependencyValidator.js';
+export { ConsoleReporter } from './reporters/consoleReporter.js';
+export { JsonReporter } from './reporters/jsonReporter.js';
+export { MarkdownReporter } from './reporters/markdownReporter.js';
+export { EnhancedReporter } from './reporters/enhancedReporter.js';
+export { CodeDocGraph } from './graph/codeDocGraph.js';
+export { GraphBuilder } from './graph/graphBuilder.js';
+export { GitChangeTracker } from './git/changeTracker.js';
+export { CacheManager } from './cache/cacheManager.js';
+export { FreshnessScorer } from './scoring/freshnessScorer.js';
+export { Plugin } from './plugins/plugin.js';
+export { IncrementalChecker } from './utils/incremental.js';
+export { VectorSearch } from './semantic/vectorSearch.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,qDAAqD,CAAC;AAClG,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/parsers/documentParser.d.ts

@@ -0,0 +1,22 @@
+import type { DocFreshnessConfig, Document, DocumentFormat } from '../types.js';
+import type { BaseExtractor } from './extractors/baseExtractor.js';
+/**
+ * Parses documentation files and extracts references for validation
+ */
+export declare class DocumentParser {
+    private config;
+    private extractors;
+    constructor(config: DocFreshnessConfig);
+    /**
+     * Register reference extractors
+     */
+    registerExtractor(extractor: BaseExtractor): void;
+    /**
+     * Scan all documentation files matching the configured patterns
+     */
+    scanDocuments(): Promise<Document[]>;
+    /**
+     * Detect documentation format from file extension
+     */
+    detectFormat(filePath: string): DocumentFormat;
+}

package/dist/parsers/documentParser.js

@@ -0,0 +1,76 @@
+import fs from 'fs';
+import path from 'path';
+import { glob } from 'glob';
+/**
+ * Parses documentation files and extracts references for validation
+ */
+export class DocumentParser {
+    config;
+    extractors;
+    constructor(config) {
+        this.config = config;
+        this.extractors = [];
+    }
+    /**
+     * Register reference extractors
+     */
+    registerExtractor(extractor) {
+        this.extractors.push(extractor);
+    }
+    /**
+     * Scan all documentation files matching the configured patterns
+     */
+    async scanDocuments() {
+        const files = await glob(this.config.include || [], {
+            ignore: this.config.exclude,
+            cwd: this.config.rootDir,
+            absolute: true,
+        });
+        const documents = [];
+        for (const filePath of files) {
+            try {
+                const content = await fs.promises.readFile(filePath, 'utf-8');
+                const relativePath = path.relative(this.config.rootDir || process.cwd(), filePath);
+                const format = this.detectFormat(filePath);
+                const doc = {
+                    path: relativePath,
+                    absolutePath: filePath,
+                    content,
+                    format,
+                    lines: content.split('\n'),
+                    references: [],
+                };
+                // Extract all reference types
+                for (const extractor of this.extractors) {
+                    if (extractor.supportsFormat(format)) {
+                        const refs = extractor.extract(doc);
+                        doc.references.push(...refs);
+                    }
+                }
+                documents.push(doc);
+            }
+            catch (error) {
+                if (this.config.verbose) {
+                    console.warn(`Warning: Could not read ${filePath}: ${error.message}`);
+                }
+            }
+        }
+        return documents;
+    }
+    /**
+     * Detect documentation format from file extension
+     */
+    detectFormat(filePath) {
+        const ext = path.extname(filePath).toLowerCase();
+        const formatMap = {
+            '.md': 'markdown',
+            '.markdown': 'markdown',
+            '.rst': 'restructuredtext',
+            '.adoc': 'asciidoc',
+            '.asciidoc': 'asciidoc',
+            '.txt': 'plaintext',
+        };
+        return formatMap[ext] || 'plaintext';
+    }
+}
+//# sourceMappingURL=documentParser.js.map

package/dist/parsers/documentParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentParser.js","sourceRoot":"","sources":["../../src/parsers/documentParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAI5B;;GAEG;AACH,MAAM,OAAO,cAAc;IACjB,MAAM,CAAqB;IAC3B,UAAU,CAAkB;IAEpC,YAAY,MAA0B;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,SAAwB;QACxC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE;YAClD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC3B,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YACxB,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;QAEH,MAAM,SAAS,GAAe,EAAE,CAAC;QAEjC,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAC9D,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;gBACnF,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBAE3C,MAAM,GAAG,GAAa;oBACpB,IAAI,EAAE,YAAY;oBAClB,YAAY,EAAE,QAAQ;oBACtB,OAAO;oBACP,MAAM;oBACN,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;oBAC1B,UAAU,EAAE,EAAE;iBACf,CAAC;gBAEF,8BAA8B;gBAC9B,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACxC,IAAI,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;wBACrC,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;wBACpC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBAED,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACxB,OAAO,CAAC,IAAI,CAAC,2BAA2B,QAAQ,KAAM,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;gBACnF,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,QAAgB;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QACjD,MAAM,SAAS,GAAmC;YAChD,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,UAAU;YACvB,MAAM,EAAE,kBAAkB;YAC1B,OAAO,EAAE,UAAU;YACnB,WAAW,EAAE,UAAU;YACvB,MAAM,EAAE,WAAW;SACpB,CAAC;QACF,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC;IACvC,CAAC;CACF"}

package/dist/parsers/documentParser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parsers/documentParser.test.js

@@ -0,0 +1,116 @@
+import fs from 'fs';
+import path from 'path';
+import { DocumentParser } from './documentParser.js';
+import { BaseExtractor } from './extractors/baseExtractor.js';
+import { captureConsoleWarn } from '../test-utils/console.js';
+class MockExtractor extends BaseExtractor {
+    refs;
+    constructor(type, refs = []) {
+        super(type);
+        this.refs = refs;
+    }
+    extract(_document) {
+        return this.refs;
+    }
+}
+class MarkdownOnlyExtractor extends BaseExtractor {
+    constructor() {
+        super('test');
+    }
+    supportsFormat(format) {
+        return format === 'markdown';
+    }
+    extract(_document) {
+        return [{ type: 'test', value: 'found', lineNumber: 1, raw: 'found', sourceFile: '' }];
+    }
+}
+describe('DocumentParser', () => {
+    const tmpDir = path.join(process.cwd(), '.doc-freshness-cache', 'parser-test');
+    const captureWarn = captureConsoleWarn;
+    const writeDoc = async (fileName, content) => {
+        const fullPath = path.join(tmpDir, fileName);
+        await fs.promises.writeFile(fullPath, content);
+        return fullPath;
+    };
+    const createParser = (include, verbose = false) => new DocumentParser({
+        rootDir: process.cwd(),
+        include,
+        verbose,
+    });
+    beforeAll(async () => {
+        await fs.promises.mkdir(tmpDir, { recursive: true });
+    });
+    afterAll(async () => {
+        await fs.promises.rm(tmpDir, { recursive: true, force: true }).catch(() => { });
+    });
+    describe('detectFormat', () => {
+        const parser = new DocumentParser({ rootDir: process.cwd() });
+        it.each([
+            ['file.md', 'markdown'],
+            ['file.markdown', 'markdown'],
+            ['file.rst', 'restructuredtext'],
+            ['file.adoc', 'asciidoc'],
+            ['file.asciidoc', 'asciidoc'],
+            ['file.txt', 'plaintext'],
+            ['file.unknown', 'plaintext'],
+        ])('detectFormat(%s) => %s', (file, expected) => {
+            expect(parser.detectFormat(file)).toBe(expected);
+        });
+    });
+    describe('scanDocuments', () => {
+        it('returns empty array when no files match', async () => {
+            const parser = createParser(['nonexistent/**/*.md']);
+            const docs = await parser.scanDocuments();
+            expect(docs).toEqual([]);
+        });
+        it('scans and parses matching doc files', async () => {
+            const mdFile = await writeDoc('test-doc.md', '# Hello\n\nSome content');
+            const parser = createParser([path.relative(process.cwd(), mdFile)]);
+            const docs = await parser.scanDocuments();
+            expect(docs).toHaveLength(1);
+            expect(docs[0].format).toBe('markdown');
+            expect(docs[0].content).toContain('Hello');
+        });
+        it('applies registered extractors to matching documents', async () => {
+            const mdFile = await writeDoc('extract-doc.md', '# Test\n\nContent');
+            const parser = createParser([path.relative(process.cwd(), mdFile)]);
+            const ref = { type: 'test', value: 'found', lineNumber: 1, raw: 'found', sourceFile: '' };
+            parser.registerExtractor(new MockExtractor('test', [ref]));
+            const docs = await parser.scanDocuments();
+            expect(docs[0].references).toHaveLength(1);
+            expect(docs[0].references[0].value).toBe('found');
+        });
+        it('skips extractors that do not support the doc format', async () => {
+            const txtFile = await writeDoc('plain.txt', 'plain text content');
+            const parser = createParser([path.relative(process.cwd(), txtFile)]);
+            parser.registerExtractor(new MarkdownOnlyExtractor());
+            const docs = await parser.scanDocuments();
+            expect(docs[0].references).toHaveLength(0);
+        });
+        it('handles unreadable files gracefully in verbose mode', async () => {
+            const badFile = await writeDoc('bad-file.md', 'content');
+            const parser = createParser([path.relative(process.cwd(), badFile)], true);
+            const readSpy = vi.spyOn(fs.promises, 'readFile');
+            readSpy.mockRejectedValueOnce(new Error('Permission denied'));
+            const warnSpy = captureWarn();
+            const docs = await parser.scanDocuments();
+            expect(docs).toHaveLength(0);
+            expect(warnSpy).toHaveBeenCalledWith(expect.stringContaining('Permission denied'));
+        });
+        it('silently skips unreadable files in non-verbose mode', async () => {
+            const badFile = await writeDoc('silent-bad.md', 'content');
+            const parser = createParser([path.relative(process.cwd(), badFile)], false);
+            vi.spyOn(fs.promises, 'readFile').mockRejectedValueOnce(new Error('EPERM'));
+            const warnSpy = captureWarn();
+            const docs = await parser.scanDocuments();
+            expect(docs).toHaveLength(0);
+            expect(warnSpy).not.toHaveBeenCalled();
+        });
+        it('uses empty array when include is not set', async () => {
+            const parser = new DocumentParser({ rootDir: process.cwd() });
+            const docs = await parser.scanDocuments();
+            expect(docs).toEqual([]);
+        });
+    });
+});
+//# sourceMappingURL=documentParser.test.js.map

package/dist/parsers/documentParser.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentParser.test.js","sourceRoot":"","sources":["../../src/parsers/documentParser.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,MAAM,aAAc,SAAQ,aAAa;IAC/B,IAAI,CAAc;IAE1B,YAAY,IAAY,EAAE,OAAoB,EAAE;QAC9C,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,OAAO,CAAC,SAAmB;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;CACF;AAED,MAAM,qBAAsB,SAAQ,aAAa;IAC/C;QACE,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED,cAAc,CAAC,MAAc;QAC3B,OAAO,MAAM,KAAK,UAAU,CAAC;IAC/B,CAAC;IAED,OAAO,CAAC,SAAmB;QACzB,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IACzF,CAAC;CACF;AAED,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,sBAAsB,EAAE,aAAa,CAAC,CAAC;IAC/E,MAAM,WAAW,GAAG,kBAAkB,CAAC;IACvC,MAAM,QAAQ,GAAG,KAAK,EAAE,QAAgB,EAAE,OAAe,EAAE,EAAE;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC7C,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,CAAC,OAAiB,EAAE,UAAmB,KAAK,EAAE,EAAE,CACnE,IAAI,cAAc,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;QACtB,OAAO;QACP,OAAO;KACR,CAAC,CAAC;IAEL,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClB,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAE9D,EAAE,CAAC,IAAI,CAAC;YACN,CAAC,SAAS,EAAE,UAAU,CAAC;YACvB,CAAC,eAAe,EAAE,UAAU,CAAC;YAC7B,CAAC,UAAU,EAAE,kBAAkB,CAAC;YAChC,CAAC,WAAW,EAAE,UAAU,CAAC;YACzB,CAAC,eAAe,EAAE,UAAU,CAAC;YAC7B,CAAC,UAAU,EAAE,WAAW,CAAC;YACzB,CAAC,cAAc,EAAE,WAAW,CAAC;SACrB,CAAC,CAAC,wBAAwB,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;YACvD,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC;YACrD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;YACxE,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YACpE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;YACrE,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YACpE,MAAM,GAAG,GAAc,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;YACrG,MAAM,CAAC,iBAAiB,CAAC,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC3D,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;YAClE,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;YACrE,MAAM,CAAC,iBAAiB,CAAC,IAAI,qBAAqB,EAAE,CAAC,CAAC;YACtD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YACzD,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAE3E,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YAClD,OAAO,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC9D,MAAM,OAAO,GAAG,WAAW,EAAE,CAAC;YAE9B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAE5E,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAC5E,MAAM,OAAO,GAAG,WAAW,EAAE,CAAC;YAE9B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC9D,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/parsers/extractors/baseExtractor.d.ts

@@ -0,0 +1,19 @@
+import type { Document, DocumentFormat, Reference } from '../../types.js';
+/**
+ * Base class for reference extractors
+ */
+export declare class BaseExtractor {
+    type: string;
+    supportedFormats: DocumentFormat[];
+    constructor(type: string);
+    supportsFormat(format: DocumentFormat): boolean;
+    extract(_document: Document): Reference[];
+    /**
+     * Helper to find line number for a match
+     */
+    findLineNumber(content: string, matchIndex: number): number;
+    /**
+     * Helper to get the context around a match
+     */
+    getContext(lines: string[], lineNumber: number, contextLines?: number): string;
+}

package/dist/parsers/extractors/baseExtractor.js

@@ -0,0 +1,33 @@
+/**
+ * Base class for reference extractors
+ */
+export class BaseExtractor {
+    type;
+    supportedFormats;
+    constructor(type) {
+        this.type = type;
+        this.supportedFormats = ['markdown', 'restructuredtext', 'asciidoc', 'plaintext'];
+    }
+    supportsFormat(format) {
+        return this.supportedFormats.includes(format);
+    }
+    extract(_document) {
+        throw new Error('extract() must be implemented');
+    }
+    /**
+     * Helper to find line number for a match
+     */
+    findLineNumber(content, matchIndex) {
+        const upToMatch = content.substring(0, matchIndex);
+        return upToMatch.split('\n').length;
+    }
+    /**
+     * Helper to get the context around a match
+     */
+    getContext(lines, lineNumber, contextLines = 2) {
+        const start = Math.max(0, lineNumber - contextLines - 1);
+        const end = Math.min(lines.length, lineNumber + contextLines);
+        return lines.slice(start, end).join('\n');
+    }
+}
+//# sourceMappingURL=baseExtractor.js.map

package/dist/parsers/extractors/baseExtractor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseExtractor.js","sourceRoot":"","sources":["../../../src/parsers/extractors/baseExtractor.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,aAAa;IACxB,IAAI,CAAS;IACb,gBAAgB,CAAmB;IAEnC,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,gBAAgB,GAAG,CAAC,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACpF,CAAC;IAED,cAAc,CAAC,MAAsB;QACnC,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,CAAC,SAAmB;QACzB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,OAAe,EAAE,UAAkB;QAChD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QACnD,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAe,EAAE,UAAkB,EAAE,eAAuB,CAAC;QACtE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,YAAY,CAAC,CAAC;QAC9D,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/dist/parsers/extractors/baseExtractor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/parsers/extractors/baseExtractor.test.js

@@ -0,0 +1,43 @@
+import { BaseExtractor } from './baseExtractor.js';
+describe('BaseExtractor', () => {
+    let extractor;
+    beforeEach(() => {
+        extractor = new BaseExtractor('test-type');
+    });
+    it('initializes with type and all supported formats', () => {
+        expect(extractor.type).toBe('test-type');
+        expect(extractor.supportedFormats).toEqual(['markdown', 'restructuredtext', 'asciidoc', 'plaintext']);
+    });
+    describe('supportsFormat', () => {
+        it.each(['markdown', 'restructuredtext', 'asciidoc', 'plaintext'])('supports %s', (format) => {
+            expect(extractor.supportsFormat(format)).toBe(true);
+        });
+        it('rejects unknown formats', () => {
+            expect(extractor.supportsFormat('unknown')).toBe(false);
+        });
+    });
+    it('extract() throws by default', () => {
+        const doc = { path: 'test.md', absolutePath: '/test.md', content: '', format: 'markdown', lines: [], references: [] };
+        expect(() => extractor.extract(doc)).toThrow('extract() must be implemented');
+    });
+    describe('findLineNumber', () => {
+        it('returns correct line number for match index', () => {
+            const content = 'line1\nline2\nline3\nline4';
+            expect(extractor.findLineNumber(content, 0)).toBe(1);
+            expect(extractor.findLineNumber(content, 6)).toBe(2);
+            expect(extractor.findLineNumber(content, 12)).toBe(3);
+        });
+    });
+    describe('getContext', () => {
+        it('returns surrounding lines', () => {
+            const lines = ['a', 'b', 'c', 'd', 'e', 'f', 'g'];
+            const ctx = extractor.getContext(lines, 4, 1);
+            expect(ctx).toBe('c\nd\ne');
+        });
+        it('clamps to array bounds', () => {
+            const lines = ['a', 'b', 'c'];
+            expect(extractor.getContext(lines, 1, 5)).toBe('a\nb\nc');
+        });
+    });
+});
+//# sourceMappingURL=baseExtractor.test.js.map

package/dist/parsers/extractors/baseExtractor.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseExtractor.test.js","sourceRoot":"","sources":["../../../src/parsers/extractors/baseExtractor.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,IAAI,SAAwB,CAAC;IAE7B,UAAU,CAAC,GAAG,EAAE;QACd,SAAS,GAAG,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,WAAW,CAAU,CAAC,CAAC,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE;YACpG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACjC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,SAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,UAAmB,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAC/H,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,OAAO,GAAG,4BAA4B,CAAC;YAC7C,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YAClD,MAAM,GAAG,GAAG,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9C,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YAC9B,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/parsers/extractors/codePatternExtractor.d.ts

@@ -0,0 +1,13 @@
+import { BaseExtractor } from './baseExtractor.js';
+import type { Document, DocFreshnessConfig, Reference } from '../../types.js';
+/**
+ * Extracts code pattern references
+ * Configurable for any programming language
+ */
+export declare class CodePatternExtractor extends BaseExtractor {
+    private languageAliases;
+    private languagePatterns;
+    constructor(config?: Partial<DocFreshnessConfig>);
+    extract(document: Document): Reference[];
+    private detectLanguage;
+}