ko-qmd 2.8.3-ko.2

package/dist/cli/version.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Build/commit identification for `qmd --version`.
+ *
+ * The commit is *stamped at build time* (scripts/build.mjs writes
+ * build-info.json next to the compiled CLI) rather than discovered at runtime.
+ * A published tarball carries no git history of its own, so a runtime lookup
+ * can only ever find some *other* repository's HEAD: `git -C <dir> rev-parse`
+ * walks up the tree, and a global install under a git-managed prefix (e.g.
+ * Homebrew's /opt/homebrew) reported that prefix's commit as qmd's.
+ *
+ * Running from a source checkout has no stamp, so the git lookup remains as a
+ * fallback — but only after confirming the enclosing repository is the package
+ * we are actually running from.
+ */
+/** Written next to the compiled CLI (dist/cli/) by scripts/build.mjs. */
+export declare const BUILD_INFO_FILENAME = "build-info.json";
+export type BuildInfo = {
+    commit: string;
+    builtAt?: string;
+};
+/**
+ * Read the commit stamped into this build, or "" when there is none.
+ *
+ * Deliberately looks beside the running script rather than in the package's
+ * dist/ directory: a source run (src/cli/) must not pick up the stamp left by
+ * an earlier, possibly unrelated, build in dist/.
+ */
+export declare function readStampedCommit(scriptDir: string): string;
+/**
+ * Short HEAD of the checkout we are running from, or "" when we are not
+ * running from one.
+ *
+ * The guard is the whole point: an enclosing repository is only qmd's if its
+ * top level *is* this package's root. Without that check, any install nested
+ * inside an unrelated repository reports that repository's HEAD.
+ */
+export declare function gitCommitForCheckout(scriptDir: string, packageRoot: string): string;
+/**
+ * The commit to report for this invocation: the build stamp when there is one,
+ * otherwise the verified checkout HEAD, otherwise nothing.
+ */
+export declare function resolveCommit(scriptDir: string, packageRoot: string): string;

package/dist/cli/version.js

@@ -0,0 +1,80 @@
+/**
+ * Build/commit identification for `qmd --version`.
+ *
+ * The commit is *stamped at build time* (scripts/build.mjs writes
+ * build-info.json next to the compiled CLI) rather than discovered at runtime.
+ * A published tarball carries no git history of its own, so a runtime lookup
+ * can only ever find some *other* repository's HEAD: `git -C <dir> rev-parse`
+ * walks up the tree, and a global install under a git-managed prefix (e.g.
+ * Homebrew's /opt/homebrew) reported that prefix's commit as qmd's.
+ *
+ * Running from a source checkout has no stamp, so the git lookup remains as a
+ * fallback — but only after confirming the enclosing repository is the package
+ * we are actually running from.
+ */
+import { execFileSync } from "node:child_process";
+import { readFileSync, realpathSync } from "node:fs";
+import { join } from "node:path";
+/** Written next to the compiled CLI (dist/cli/) by scripts/build.mjs. */
+export const BUILD_INFO_FILENAME = "build-info.json";
+/**
+ * Read the commit stamped into this build, or "" when there is none.
+ *
+ * Deliberately looks beside the running script rather than in the package's
+ * dist/ directory: a source run (src/cli/) must not pick up the stamp left by
+ * an earlier, possibly unrelated, build in dist/.
+ */
+export function readStampedCommit(scriptDir) {
+    try {
+        const raw = readFileSync(join(scriptDir, BUILD_INFO_FILENAME), "utf-8");
+        const info = JSON.parse(raw);
+        return typeof info.commit === "string" ? info.commit : "";
+    }
+    catch {
+        // No stamp (source run), unreadable, or malformed — fall through.
+        return "";
+    }
+}
+function git(args, cwd) {
+    // execFileSync, not execSync: no shell, so a path containing spaces or shell
+    // metacharacters is passed through intact instead of silently failing.
+    return execFileSync("git", args, {
+        cwd,
+        encoding: "utf-8",
+        stdio: ["pipe", "pipe", "pipe"],
+    }).trim();
+}
+/**
+ * Short HEAD of the checkout we are running from, or "" when we are not
+ * running from one.
+ *
+ * The guard is the whole point: an enclosing repository is only qmd's if its
+ * top level *is* this package's root. Without that check, any install nested
+ * inside an unrelated repository reports that repository's HEAD.
+ */
+export function gitCommitForCheckout(scriptDir, packageRoot) {
+    try {
+        const top = git(["rev-parse", "--show-toplevel"], scriptDir);
+        if (realpathSync(top) !== realpathSync(packageRoot))
+            return "";
+        const commit = git(["rev-parse", "--short", "HEAD"], top);
+        if (!commit)
+            return "";
+        // Same "-dirty" marker scripts/build.mjs stamps: running edited sources is
+        // not the commit it names, and that distinction is the whole point of
+        // printing a commit at all.
+        const dirty = git(["status", "--porcelain"], top);
+        return dirty ? `${commit}-dirty` : commit;
+    }
+    catch {
+        // Not a git repo, git not installed, or an unborn branch.
+        return "";
+    }
+}
+/**
+ * The commit to report for this invocation: the build stamp when there is one,
+ * otherwise the verified checkout HEAD, otherwise nothing.
+ */
+export function resolveCommit(scriptDir, packageRoot) {
+    return readStampedCommit(scriptDir) || gitCommitForCheckout(scriptDir, packageRoot);
+}

package/dist/collections.d.ts

@@ -0,0 +1,167 @@
+/**
+ * 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.
+ */
+/**
+ * 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;
+    pattern: string;
+    ignore?: string[];
+    context?: ContextMap;
+    update?: string;
+    includeByDefault?: boolean;
+}
+/**
+ * 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;
+    editor_uri?: string;
+    editor_uri_template?: string;
+    collections: Record<string, Collection>;
+    models?: ModelsConfig;
+}
+/**
+ * Collection with its name (for return values)
+ */
+export interface NamedCollection extends Collection {
+    name: string;
+}
+/**
+ * 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 declare function setConfigSource(source?: {
+    configPath?: string;
+    config?: CollectionConfig;
+}): void;
+/**
+ * Set the current index name for config file lookup
+ * Config file will be ~/.config/qmd/{indexName}.yml
+ */
+export declare function setConfigIndexName(name: string): void;
+export declare function getConfigDir(): string;
+/**
+ * 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 declare function findLocalConfigPath(startDir?: string): string | undefined;
+/** Return the local SQLite index path paired with a local .qmd/index.yaml file. */
+export declare function getLocalDbPath(configPath: string): string;
+/**
+ * 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 declare function loadConfig(): CollectionConfig;
+/**
+ * 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 declare function saveConfig(config: CollectionConfig): void;
+/**
+ * Get a specific collection by name
+ * Returns null if not found
+ */
+export declare function getCollection(name: string): NamedCollection | null;
+/**
+ * List all collections
+ */
+export declare function listCollections(): NamedCollection[];
+/**
+ * Get collections that are included by default in queries
+ */
+export declare function getDefaultCollections(): NamedCollection[];
+/**
+ * Get collection names that are included by default
+ */
+export declare function getDefaultCollectionNames(): string[];
+/**
+ * Update a collection's settings
+ */
+export declare function updateCollectionSettings(name: string, settings: {
+    update?: string | null;
+    includeByDefault?: boolean;
+}): boolean;
+/**
+ * Add or update a collection
+ */
+export declare function addCollection(name: string, path: string, pattern?: string): void;
+/**
+ * Remove a collection
+ */
+export declare function removeCollection(name: string): boolean;
+/**
+ * Rename a collection
+ */
+export declare function renameCollection(oldName: string, newName: string): boolean;
+/**
+ * Get global context
+ */
+export declare function getGlobalContext(): string | undefined;
+/**
+ * Set global context
+ */
+export declare function setGlobalContext(context: string | undefined): void;
+/**
+ * Get all contexts for a collection
+ */
+export declare function getContexts(collectionName: string): ContextMap | undefined;
+/**
+ * Add or update a context for a specific path in a collection
+ */
+export declare function addContext(collectionName: string, pathPrefix: string, contextText: string): boolean;
+/**
+ * Remove a context from a collection
+ */
+export declare function removeContext(collectionName: string, pathPrefix: string): boolean;
+/**
+ * List all contexts across all collections
+ */
+export declare function listAllContexts(): Array<{
+    collection: string;
+    path: string;
+    context: string;
+}>;
+/**
+ * Find best matching context for a given collection and path
+ * Returns the most specific matching context (longest path prefix match)
+ */
+export declare function findContextForPath(collectionName: string, filePath: string): string | undefined;
+/**
+ * Get the config file path (useful for error messages)
+ */
+export declare function getConfigPath(): string;
+/**
+ * Check if config file exists
+ */
+export declare function configExists(): boolean;
+/**
+ * Validate a collection name
+ * Collection names must be valid and not contain special characters
+ */
+export declare function isValidCollectionName(name: string): boolean;

package/dist/collections.js

@@ -0,0 +1,410 @@
+/**
+ * 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";
+// ============================================================================
+// Configuration paths
+// ============================================================================
+// Current index name (default: "index")
+let currentIndexName = "index";
+// SDK mode: optional in-memory config or custom config path
+let configSource = { 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) {
+    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) {
+    // 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() {
+    // 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() {
+    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 = process.cwd()) {
+    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) {
+    return join(dirname(configPath), "index.sqlite");
+}
+/**
+ * Ensure config directory exists
+ */
+function ensureConfigDir() {
+    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() {
+    // 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);
+        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) {
+    // 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) {
+    const config = loadConfig();
+    const collection = config.collections[name];
+    if (!collection) {
+        return null;
+    }
+    return { name, ...collection };
+}
+/**
+ * List all collections
+ */
+export function listCollections() {
+    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() {
+    return listCollections().filter(c => c.includeByDefault !== false);
+}
+/**
+ * Get collection names that are included by default
+ */
+export function getDefaultCollectionNames() {
+    return getDefaultCollections().map(c => c.name);
+}
+/**
+ * Update a collection's settings
+ */
+export function updateCollectionSettings(name, settings) {
+    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, path, pattern = "**/*.md") {
+    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) {
+    const config = loadConfig();
+    if (!config.collections[name]) {
+        return false;
+    }
+    delete config.collections[name];
+    saveConfig(config);
+    return true;
+}
+/**
+ * Rename a collection
+ */
+export function renameCollection(oldName, newName) {
+    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() {
+    const config = loadConfig();
+    return config.global_context;
+}
+/**
+ * Set global context
+ */
+export function setGlobalContext(context) {
+    const config = loadConfig();
+    config.global_context = context;
+    saveConfig(config);
+}
+/**
+ * Get all contexts for a collection
+ */
+export function getContexts(collectionName) {
+    const collection = getCollection(collectionName);
+    return collection?.context;
+}
+/**
+ * Add or update a context for a specific path in a collection
+ */
+export function addContext(collectionName, pathPrefix, contextText) {
+    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, pathPrefix) {
+    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() {
+    const config = loadConfig();
+    const results = [];
+    // 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, filePath) {
+    const config = loadConfig();
+    const collection = config.collections[collectionName];
+    if (!collection?.context) {
+        return config.global_context;
+    }
+    // Find all matching prefixes
+    const matches = [];
+    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() {
+    if (configSource.type === 'inline')
+        return '<inline>';
+    return configSource.path || getConfigFilePath();
+}
+/**
+ * Check if config file exists
+ */
+export function configExists() {
+    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) {
+    // Allow alphanumeric, hyphens, underscores
+    return /^[a-zA-Z0-9_-]+$/.test(name);
+}