mirror of
https://github.com/amitwh/markdown-converter.git
synced 2026-10-01 09:19:34 +05:30
feat(templates,qa): template gallery + pluggable DocQA engine
Two more features from the deferred menu:
Daily-note template gallery:
- src/main/DailyNotesTemplates.js — pure module: listTemplates() /
saveTemplate() / deleteTemplate() / labelFor() with injectable IO.
- src/main/DailyNotes.js — openOrCreate() now accepts seedContent so a
non-default template can seed a NEW note (existing notes never get
clobbered).
- src/main.js — IPC channels daily-templates:list / save / delete /
apply. apply renders the chosen template (with {date}/{weekday}
substitution) and pipes through DailyNotes.openOrCreate.
- src/sidebar/daily-templates-panel.js — gallery UI: list, +New
(prompt for name + content), Use (applies to today's note),
delete (refuses to remove the last template so the default survives).
- src/renderer.js — registers the panel.
- src/index.html — icon (already added).
Pluggable DocQA engine (semantic search hook):
- src/main/SemanticEngine.js — engine interface with defaultEngine() (TF-idF,
always available) and neuralEngine() (lazy @xenova/transformers,
falls back gracefully when the dep is missing). getEngine(name)
resolves either.
- src/main/DocQA.js — ask() is now async and accepts an engine arg.
TF-idF path unchanged; neural path calls engine.rank(question, chunks)
directly. The chunk corpus is built up front regardless of engine so
ranking is consistent.
- src/main.js — doc-qa:ask IPC resolves the engine via SemanticEngine.getEngine(name)
before calling DocQA.ask. The renderer can pass {engine: 'transformers'}
to opt in once @xenova/transformers is installed.
Tests (51 new across this batch):
- tests/main/DailyNotesTemplates.test.js (18): labelFor separators /
edge cases / non-string safety, listTemplates empty / present / sort,
saveTemplate nested dir + .md extension + validation + null content,
deleteTemplate success / missing / validation.
- tests/daily-templates-panel.test.js (12): mount + empty state + list +
XSS safety, Use button (apply + error path), Delete button (success +
last-template guard), New template (save + cancel), refresh.
- tests/main/SemanticEngine.test.js (8): default engine shape + rank
matches WorkspaceSearch, getEngine for tf-idf / unknown / transformers
(graceful fallback when @xenova/transformers missing), parity check.
- DocQA: 5 new tests for engine arg (custom engine.rank called, default
fallback, neural hit shape translation); existing tests updated to
await the now-async ask().
Full suite: 76 suites, 914 tests, lint+format clean.
Activation for the neural engine:
npm install @xenova/transformers
(heavy; ~50 MiB with deps) — then 'transformers' is selectable in
doc-qa:ask. Until then, all calls use TF-idF transparently.
Amit Haridas
This commit is contained in:
+60
-15
@@ -79,18 +79,18 @@ describe('DocQA.ask', () => {
|
||||
},
|
||||
];
|
||||
|
||||
test('returns empty chunks for a question with no substantive terms', () => {
|
||||
const r = DocQA.ask({ question: 'what is this?', files });
|
||||
test('returns empty chunks for a question with no substantive terms', async () => {
|
||||
const r = await DocQA.ask({ question: 'what is this?', files });
|
||||
expect(r.chunks).toEqual([]);
|
||||
});
|
||||
|
||||
test('returns empty chunks when no files match', () => {
|
||||
const r = DocQA.ask({ question: 'quantum entanglement', files });
|
||||
test('returns empty chunks when no files match', async () => {
|
||||
const r = await DocQA.ask({ question: 'quantum entanglement', files });
|
||||
expect(r.chunks).toEqual([]);
|
||||
});
|
||||
|
||||
test('returns relevant chunks for a substantive question', () => {
|
||||
const r = DocQA.ask({ question: 'how does rust async work', files, topK: 3 });
|
||||
test('returns relevant chunks for a substantive question', async () => {
|
||||
const r = await DocQA.ask({ question: 'how does rust async work', files, topK: 3 });
|
||||
expect(r.chunks.length).toBeGreaterThan(0);
|
||||
// The first hit should be from rust.md (highest relevance)
|
||||
expect(r.chunks[0].filePath).toBe('/notes/rust.md');
|
||||
@@ -98,25 +98,25 @@ describe('DocQA.ask', () => {
|
||||
expect(r.chunks[0].score).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
test('honors topK', () => {
|
||||
const r = DocQA.ask({ question: 'rust', files, topK: 2 });
|
||||
test('honors topK', async () => {
|
||||
const r = await DocQA.ask({ question: 'rust', files, topK: 2 });
|
||||
expect(r.chunks.length).toBeLessThanOrEqual(2);
|
||||
});
|
||||
|
||||
test('includes the original question in the response', () => {
|
||||
const r = DocQA.ask({ question: 'how do I configure pandoc', files });
|
||||
test('includes the original question in the response', async () => {
|
||||
const r = await DocQA.ask({ question: 'how do I configure pandoc', files });
|
||||
expect(r.question).toBe('how do I configure pandoc');
|
||||
});
|
||||
|
||||
test('handles missing or empty file list gracefully', () => {
|
||||
const r = DocQA.ask({ question: 'rust', files: [] });
|
||||
test('handles missing or empty file list gracefully', async () => {
|
||||
const r = await DocQA.ask({ question: 'rust', files: [] });
|
||||
expect(r.chunks).toEqual([]);
|
||||
|
||||
const r2 = DocQA.ask({ question: 'rust', files: null });
|
||||
const r2 = await DocQA.ask({ question: 'rust', files: null });
|
||||
expect(r2.chunks).toEqual([]);
|
||||
});
|
||||
|
||||
test('rank prefers recent edits when scores tie (recency nudge)', () => {
|
||||
test('rank prefers recent edits when scores tie (recency nudge)', async () => {
|
||||
const now = Date.now();
|
||||
const filesWithMtime = [
|
||||
{
|
||||
@@ -130,7 +130,52 @@ describe('DocQA.ask', () => {
|
||||
mtimeMs: now - 60 * 24 * 60 * 60 * 1000, // 60 days ago
|
||||
},
|
||||
];
|
||||
const r = DocQA.ask({ question: 'rust overview', files: filesWithMtime, topK: 5 });
|
||||
const r = await DocQA.ask({ question: 'rust overview', files: filesWithMtime, topK: 5 });
|
||||
expect(r.chunks[0].filePath).toBe('/fresh.md');
|
||||
});
|
||||
});
|
||||
|
||||
describe('DocQA.ask with a custom engine', () => {
|
||||
const files = [
|
||||
{ path: '/x.md', content: 'rust language is systems-level and safe.' },
|
||||
{ path: '/y.md', content: 'unrelated content' },
|
||||
];
|
||||
|
||||
test('passes the question + chunks to a custom engine.rank()', async () => {
|
||||
const customEngine = {
|
||||
isNeural: true,
|
||||
rank: jest.fn().mockResolvedValue([
|
||||
{ filePath: '/x.md#0', snippet: 'ranked', score: 0.9 },
|
||||
]),
|
||||
};
|
||||
const r = await DocQA.ask({ question: 'rust', files, engine: customEngine });
|
||||
expect(customEngine.rank).toHaveBeenCalled();
|
||||
const args = customEngine.rank.mock.calls[0];
|
||||
expect(args[0]).toMatch(/rust/);
|
||||
expect(args[1].length).toBeGreaterThan(0);
|
||||
expect(r.chunks[0].filePath).toBe('/x.md');
|
||||
expect(r.chunks[0].offset).toBe(0);
|
||||
});
|
||||
|
||||
test('falls back to default engine when none provided', async () => {
|
||||
const r = await DocQA.ask({ question: 'rust', files });
|
||||
// Default engine is tf-idf — chunks come back
|
||||
expect(r.chunks.length).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
test('translates neural-engine hits into the public chunks shape', async () => {
|
||||
const engine = {
|
||||
isNeural: true,
|
||||
rank: jest.fn().mockResolvedValue([
|
||||
{ filePath: '/x.md#42', snippet: 'rust snippet', score: 0.85, mtimeMs: 99 },
|
||||
{ filePath: '/y.md#7', snippet: 'other', score: 0.1, mtimeMs: 1 },
|
||||
]),
|
||||
};
|
||||
const r = await DocQA.ask({ question: 'rust', files, engine });
|
||||
expect(r.chunks).toHaveLength(2);
|
||||
expect(r.chunks[0].filePath).toBe('/x.md');
|
||||
expect(r.chunks[0].offset).toBe(42);
|
||||
expect(r.chunks[0].snippet).toBe('rust snippet');
|
||||
expect(r.chunks[0].mtimeMs).toBe(99);
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user