Repository navigation
Expand file tree
/
Copy pathcollections.ts
More file actions
539 lines (462 loc) · 14.3 KB
/
Copy pathcollections.ts
File metadata and controls
539 lines (462 loc) · 14.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
/**
* Collections configuration management
*
* This module manages the YAML-based collection configuration at ~/.config/qmd/index.yml.
* Collections define which directories to index and their associated contexts.
*/
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
import { join, dirname, resolve } from "path";
import { qmdHomedir } from "./paths.js";
import YAML from "yaml";
// ============================================================================
// Types
// ============================================================================
/**
* Context definitions for a collection
* Key is path prefix (e.g., "/", "/2024", "/Board of Directors")
* Value is the context description
*/
export type ContextMap = Record<string, string>;
/**
* A single collection configuration
*/
export interface Collection {
path: string; // Absolute path to index
pattern: string; // Glob pattern (e.g., "**/*.md")
ignore?: string[]; // Glob patterns to exclude (e.g., ["Sessions/**"])
context?: ContextMap; // Optional context definitions
update?: string; // Optional bash command to run during qmd update
includeByDefault?: boolean; // Include in queries by default (default: true)
}
/**
* Model configuration for embedding, reranking, and generation
*/
export interface ModelsConfig {
embed?: string;
rerank?: string;
generate?: string;
}
/**
* The complete configuration file structure
*/
export interface CollectionConfig {
global_context?: string; // Context applied to all collections
editor_uri?: string; // Editor URI template for terminal hyperlinks
editor_uri_template?: string; // Alias for editor_uri
collections: Record<string, Collection>; // Collection name -> config
models?: ModelsConfig;
}
/**
* Collection with its name (for return values)
*/
export interface NamedCollection extends Collection {
name: string;
}
// ============================================================================
// Configuration paths
// ============================================================================
// Current index name (default: "index")
let currentIndexName: string = "index";
// SDK mode: optional in-memory config or custom config path
let configSource: { type: 'file'; path?: string } | { type: 'inline'; config: CollectionConfig } = { type: 'file' };
/**
* Set the config source for SDK mode.
* - File path: load/save from a specific YAML file
* - Inline config: use an in-memory CollectionConfig (saveConfig updates in place, no file I/O)
* - undefined: reset to default file-based config
*/
export function setConfigSource(source?: { configPath?: string; config?: CollectionConfig }): void {
if (!source) {
configSource = { type: 'file' };
return;
}
if (source.config) {
// Ensure collections object exists
if (!source.config.collections) {
source.config.collections = {};
}
configSource = { type: 'inline', config: source.config };
} else if (source.configPath) {
configSource = { type: 'file', path: source.configPath };
} else {
configSource = { type: 'file' };
}
}
/**
* Set the current index name for config file lookup
* Config file will be ~/.config/qmd/{indexName}.yml
*/
export function setConfigIndexName(name: string): void {
// Resolve relative paths to absolute paths and sanitize for use as filename
if (name.includes('/')) {
const absolutePath = resolve(process.cwd(), name);
// Replace path separators with underscores to create a valid filename
currentIndexName = absolutePath.replace(/\//g, '_').replace(/^_/, '');
} else {
currentIndexName = name;
}
}
export function getConfigDir(): string {
// Allow override via QMD_CONFIG_DIR for testing
if (process.env.QMD_CONFIG_DIR) {
return process.env.QMD_CONFIG_DIR;
}
// Respect XDG Base Directory specification (consistent with store.ts)
if (process.env.XDG_CONFIG_HOME) {
return join(process.env.XDG_CONFIG_HOME, "qmd");
}
return join(qmdHomedir(), ".config", "qmd");
}
function getConfigFilePath(): string {
return join(getConfigDir(), `${currentIndexName}.yml`);
}
/**
* Find a project-local QMD config by walking upward from startDir.
* The local config lives at .qmd/index.yaml or .qmd/index.yml and,
* when used by the CLI, keeps both config and index DB writes inside
* the project instead of the global ~/.config / ~/.cache locations.
*/
export function findLocalConfigPath(startDir: string = process.cwd()): string | undefined {
let dir = resolve(startDir);
while (true) {
const qmdDir = join(dir, ".qmd");
const yamlPath = join(qmdDir, "index.yaml");
if (existsSync(yamlPath)) return yamlPath;
const ymlPath = join(qmdDir, "index.yml");
if (existsSync(ymlPath)) return ymlPath;
const parent = dirname(dir);
if (parent === dir) return undefined;
dir = parent;
}
}
/** Return the local SQLite index path paired with a local .qmd/index.yaml file. */
export function getLocalDbPath(configPath: string): string {
return join(dirname(configPath), "index.sqlite");
}
/**
* Ensure config directory exists
*/
function ensureConfigDir(): void {
const configDir = getConfigDir();
if (!existsSync(configDir)) {
mkdirSync(configDir, { recursive: true });
}
}
// ============================================================================
// Core functions
// ============================================================================
/**
* Load configuration from the configured source.
* - Inline config: returns the in-memory object directly
* - File-based: reads from YAML file (default ~/.config/qmd/index.yml)
* Returns empty config if file doesn't exist
*/
export function loadConfig(): CollectionConfig {
// SDK inline config mode
if (configSource.type === 'inline') {
return configSource.config;
}
// File-based config (SDK custom path or default)
const configPath = configSource.path || getConfigFilePath();
if (!existsSync(configPath)) {
return { collections: {} };
}
try {
const content = readFileSync(configPath, "utf-8");
const parsed = YAML.parse(content) as CollectionConfig | null | undefined;
const config = parsed ?? { collections: {} };
// Ensure collections object exists
if (!config.collections) {
config.collections = {};
}
return config;
} catch (error) {
throw new Error(`Failed to parse ${configPath}: ${error}`);
}
}
/**
* Save configuration to the configured source.
* - Inline config: updates the in-memory object (no file I/O)
* - File-based: writes to YAML file (default ~/.config/qmd/index.yml)
*/
export function saveConfig(config: CollectionConfig): void {
// SDK inline config mode: update in place, no file I/O
if (configSource.type === 'inline') {
configSource.config = config;
return;
}
const configPath = configSource.path || getConfigFilePath();
const configDir = dirname(configPath);
if (!existsSync(configDir)) {
mkdirSync(configDir, { recursive: true });
}
try {
const yaml = YAML.stringify(config, {
indent: 2,
lineWidth: 0, // Don't wrap lines
});
writeFileSync(configPath, yaml, "utf-8");
} catch (error) {
throw new Error(`Failed to write ${configPath}: ${error}`);
}
}
/**
* Get a specific collection by name
* Returns null if not found
*/
export function getCollection(name: string): NamedCollection | null {
const config = loadConfig();
const collection = config.collections[name];
if (!collection) {
return null;
}
return { name, ...collection };
}
/**
* List all collections
*/
export function listCollections(): NamedCollection[] {
const config = loadConfig();
return Object.entries(config.collections).map(([name, collection]) => ({
name,
...collection,
}));
}
/**
* Get collections that are included by default in queries
*/
export function getDefaultCollections(): NamedCollection[] {
return listCollections().filter(c => c.includeByDefault !== false);
}
/**
* Get collection names that are included by default
*/
export function getDefaultCollectionNames(): string[] {
return getDefaultCollections().map(c => c.name);
}
/**
* Update a collection's settings
*/
export function updateCollectionSettings(
name: string,
settings: { update?: string | null; includeByDefault?: boolean }
): boolean {
const config = loadConfig();
const collection = config.collections[name];
if (!collection) return false;
if (settings.update !== undefined) {
if (settings.update === null) {
delete collection.update;
} else {
collection.update = settings.update;
}
}
if (settings.includeByDefault !== undefined) {
if (settings.includeByDefault === true) {
// true is default, remove the field
delete collection.includeByDefault;
} else {
collection.includeByDefault = settings.includeByDefault;
}
}
saveConfig(config);
return true;
}
/**
* Add or update a collection
*/
export function addCollection(
name: string,
path: string,
pattern: string = "**/*.md"
): void {
const config = loadConfig();
config.collections[name] = {
path,
pattern,
context: config.collections[name]?.context, // Preserve existing context
};
saveConfig(config);
}
/**
* Remove a collection
*/
export function removeCollection(name: string): boolean {
const config = loadConfig();
if (!config.collections[name]) {
return false;
}
delete config.collections[name];
saveConfig(config);
return true;
}
/**
* Rename a collection
*/
export function renameCollection(oldName: string, newName: string): boolean {
const config = loadConfig();
if (!config.collections[oldName]) {
return false;
}
if (config.collections[newName]) {
throw new Error(`Collection '${newName}' already exists`);
}
config.collections[newName] = config.collections[oldName];
delete config.collections[oldName];
saveConfig(config);
return true;
}
// ============================================================================
// Context management
// ============================================================================
/**
* Get global context
*/
export function getGlobalContext(): string | undefined {
const config = loadConfig();
return config.global_context;
}
/**
* Set global context
*/
export function setGlobalContext(context: string | undefined): void {
const config = loadConfig();
config.global_context = context;
saveConfig(config);
}
/**
* Get all contexts for a collection
*/
export function getContexts(collectionName: string): ContextMap | undefined {
const collection = getCollection(collectionName);
return collection?.context;
}
/**
* Add or update a context for a specific path in a collection
*/
export function addContext(
collectionName: string,
pathPrefix: string,
contextText: string
): boolean {
const config = loadConfig();
const collection = config.collections[collectionName];
if (!collection) {
return false;
}
if (!collection.context) {
collection.context = {};
}
collection.context[pathPrefix] = contextText;
saveConfig(config);
return true;
}
/**
* Remove a context from a collection
*/
export function removeContext(
collectionName: string,
pathPrefix: string
): boolean {
const config = loadConfig();
const collection = config.collections[collectionName];
if (!collection?.context?.[pathPrefix]) {
return false;
}
delete collection.context[pathPrefix];
// Remove empty context object
if (Object.keys(collection.context).length === 0) {
delete collection.context;
}
saveConfig(config);
return true;
}
/**
* List all contexts across all collections
*/
export function listAllContexts(): Array<{
collection: string;
path: string;
context: string;
}> {
const config = loadConfig();
const results: Array<{ collection: string; path: string; context: string }> = [];
// Add global context if present
if (config.global_context) {
results.push({
collection: "*",
path: "/",
context: config.global_context,
});
}
// Add collection contexts
for (const [name, collection] of Object.entries(config.collections)) {
if (collection.context) {
for (const [path, context] of Object.entries(collection.context)) {
results.push({
collection: name,
path,
context,
});
}
}
}
return results;
}
/**
* Find best matching context for a given collection and path
* Returns the most specific matching context (longest path prefix match)
*/
export function findContextForPath(
collectionName: string,
filePath: string
): string | undefined {
const config = loadConfig();
const collection = config.collections[collectionName];
if (!collection?.context) {
return config.global_context;
}
// Find all matching prefixes
const matches: Array<{ prefix: string; context: string }> = [];
for (const [prefix, context] of Object.entries(collection.context)) {
// Normalize paths for comparison
const normalizedPath = filePath.startsWith("/") ? filePath : `/${filePath}`;
const normalizedPrefix = prefix.startsWith("/") ? prefix : `/${prefix}`;
if (normalizedPath.startsWith(normalizedPrefix)) {
matches.push({ prefix: normalizedPrefix, context });
}
}
// Return most specific match (longest prefix)
if (matches.length > 0) {
matches.sort((a, b) => b.prefix.length - a.prefix.length);
return matches[0]!.context;
}
// Fallback to global context
return config.global_context;
}
// ============================================================================
// Utility functions
// ============================================================================
/**
* Get the config file path (useful for error messages)
*/
export function getConfigPath(): string {
if (configSource.type === 'inline') return '<inline>';
return configSource.path || getConfigFilePath();
}
/**
* Check if config file exists
*/
export function configExists(): boolean {
if (configSource.type === 'inline') return true;
const path = configSource.path || getConfigFilePath();
return existsSync(path);
}
/**
* Validate a collection name
* Collection names must be valid and not contain special characters
*/
export function isValidCollectionName(name: string): boolean {
// Allow alphanumeric, hyphens, underscores
return /^[a-zA-Z0-9_-]+$/.test(name);
}