@gitpagedocs/cli 1.1.61 → 1.1.63

package/ai/core/ports/illm-provider.ts

@@ -1,32 +1,32 @@
-/**
- * @file illm-provider.ts
- * @description Contract for all LLM implementations ensuring OCP and DIP.
- * Isolates the AI logic from the specific LLM providers (OpenAI, Claude, Ollama, etc.).
- */
-
-export interface ChatMessage {
-    role: 'user' | 'assistant' | 'system';
-    content: string;
-    type?: 'text' | 'image' | 'audio'; // Supporting multimedia as requested
-}
-
-export interface ILLMProviderConfig {
-    apiKey?: string;
-    baseUrl?: string;
-    model?: string;
-}
-
-export interface ILLMProvider {
-    /**
-     * Generates markdown documentation based on file content.
-     * @param fileContent Raw content of the source file
-     * @param contextPrompt Optional instructions to guide the generation (e.g., FSD standard)
-     */
-    generateDocumentation(fileContent: string, contextPrompt?: string): Promise<string>;
-
-    /**
-     * Conversational chat support.
-     * @param messages Array of chat messages (system context, user history, etc.)
-     */
-    chat(messages: ChatMessage[]): Promise<string>;
-}
+/**
+ * @file illm-provider.ts
+ * @description Contract for all LLM implementations ensuring OCP and DIP.
+ * Isolates the AI logic from the specific LLM providers (OpenAI, Claude, Ollama, etc.).
+ */
+
+export interface ChatMessage {
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+    type?: 'text' | 'image' | 'audio'; // Supporting multimedia as requested
+}
+
+export interface ILLMProviderConfig {
+    apiKey?: string;
+    baseUrl?: string;
+    model?: string;
+}
+
+export interface ILLMProvider {
+    /**
+     * Generates markdown documentation based on file content.
+     * @param fileContent Raw content of the source file
+     * @param contextPrompt Optional instructions to guide the generation (e.g., FSD standard)
+     */
+    generateDocumentation(fileContent: string, contextPrompt?: string): Promise<string>;
+
+    /**
+     * Conversational chat support.
+     * @param messages Array of chat messages (system context, user history, etc.)
+     */
+    chat(messages: ChatMessage[]): Promise<string>;
+}

package/ai/infrastructure/ai-config-file.ts

@@ -1,101 +1,101 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import { resolveUserConfigDir } from "@gitpagedocs/tools";
-import {
-  AI_CLI_CONFIG_FILENAME,
-  type AiCliConfig,
-} from "../core/models/ai-cli-config";
-import { parseAiCliConfig } from "../core/models/parse-ai-cli-config";
-
-/** Owner-only directory/file permissions (no-op on Windows, enforced on POSIX). */
-const CONFIG_DIR_MODE = 0o700;
-const CONFIG_FILE_MODE = 0o600;
-
-export interface AiConfigFileRepositoryOptions {
-  /** Working directory searched for a legacy `<cwd>/.gitpagedocsconfig`. */
-  cwd?: string;
-  /** Destination directory; defaults to the per-user OS config directory. */
-  configDir?: string;
-  /** Notified after a legacy config is moved into the user config directory. */
-  onMigrate?: (fromPath: string, toPath: string) => void;
-}
-
-/**
- * Stores `.gitpagedocsconfig` in the per-user OS config directory
- * (`%APPDATA%\gitpagedocs` on Windows, `~/Library/Application Support/gitpagedocs`
- * on macOS, `$XDG_CONFIG_HOME/gitpagedocs` elsewhere) with owner-only
- * permissions, so the API key never lives inside a repository checkout.
- * A legacy `<cwd>/.gitpagedocsconfig` is migrated automatically on first read.
- */
-export class AiConfigFileRepository {
-  private readonly cwd: string;
-  private readonly configDir: string;
-  private readonly onMigrate?: (fromPath: string, toPath: string) => void;
-
-  constructor(options: AiConfigFileRepositoryOptions = {}) {
-    this.cwd = options.cwd ?? process.cwd();
-    this.configDir = options.configDir ?? resolveUserConfigDir();
-    this.onMigrate = options.onMigrate;
-  }
-
-  getConfigPath(): string {
-    return path.join(this.configDir, AI_CLI_CONFIG_FILENAME);
-  }
-
-  getLegacyConfigPath(): string {
-    return path.join(this.cwd, AI_CLI_CONFIG_FILENAME);
-  }
-
-  async read(): Promise<AiCliConfig | null> {
-    const current = await this.readFrom(this.getConfigPath());
-    if (current) return current;
-    return this.migrateLegacyConfig();
-  }
-
-  /** Delete the stored configuration (secure and legacy locations), wiping
-   * any saved credentials. Returns the paths that were actually removed. */
-  async clear(): Promise<string[]> {
-    const removed: string[] = [];
-    const candidates = new Set([this.getConfigPath(), this.getLegacyConfigPath()].map((p) => path.resolve(p)));
-    for (const configPath of candidates) {
-      try {
-        await fs.rm(configPath);
-        removed.push(configPath);
-      } catch {
-        // Missing file: nothing to remove at this location.
-      }
-    }
-    return removed;
-  }
-
-  async write(config: AiCliConfig): Promise<void> {
-    const configPath = this.getConfigPath();
-    await fs.mkdir(path.dirname(configPath), { recursive: true, mode: CONFIG_DIR_MODE });
-    const data = `${JSON.stringify(config, null, 2)}\n`;
-    await fs.writeFile(configPath, data, { encoding: "utf-8", mode: CONFIG_FILE_MODE });
-  }
-
-  private async readFrom(configPath: string): Promise<AiCliConfig | null> {
-    try {
-      const content = await fs.readFile(configPath, "utf-8");
-      return parseAiCliConfig(JSON.parse(content));
-    } catch {
-      return null;
-    }
-  }
-
-  private async migrateLegacyConfig(): Promise<AiCliConfig | null> {
-    const legacyPath = this.getLegacyConfigPath();
-    if (path.resolve(legacyPath) === path.resolve(this.getConfigPath())) return null;
-    const legacy = await this.readFrom(legacyPath);
-    if (!legacy) return null;
-    try {
-      await this.write(legacy);
-      await fs.rm(legacyPath, { force: true });
-      this.onMigrate?.(legacyPath, this.getConfigPath());
-    } catch {
-      // Migration is best-effort: keep serving the legacy config on failure.
-    }
-    return legacy;
-  }
-}
+import fs from "node:fs/promises";
+import path from "node:path";
+import { resolveUserConfigDir } from "@gitpagedocs/tools";
+import {
+  AI_CLI_CONFIG_FILENAME,
+  type AiCliConfig,
+} from "../core/models/ai-cli-config";
+import { parseAiCliConfig } from "../core/models/parse-ai-cli-config";
+
+/** Owner-only directory/file permissions (no-op on Windows, enforced on POSIX). */
+const CONFIG_DIR_MODE = 0o700;
+const CONFIG_FILE_MODE = 0o600;
+
+export interface AiConfigFileRepositoryOptions {
+  /** Working directory searched for a legacy `<cwd>/.gitpagedocsconfig`. */
+  cwd?: string;
+  /** Destination directory; defaults to the per-user OS config directory. */
+  configDir?: string;
+  /** Notified after a legacy config is moved into the user config directory. */
+  onMigrate?: (fromPath: string, toPath: string) => void;
+}
+
+/**
+ * Stores `.gitpagedocsconfig` in the per-user OS config directory
+ * (`%APPDATA%\gitpagedocs` on Windows, `~/Library/Application Support/gitpagedocs`
+ * on macOS, `$XDG_CONFIG_HOME/gitpagedocs` elsewhere) with owner-only
+ * permissions, so the API key never lives inside a repository checkout.
+ * A legacy `<cwd>/.gitpagedocsconfig` is migrated automatically on first read.
+ */
+export class AiConfigFileRepository {
+  private readonly cwd: string;
+  private readonly configDir: string;
+  private readonly onMigrate?: (fromPath: string, toPath: string) => void;
+
+  constructor(options: AiConfigFileRepositoryOptions = {}) {
+    this.cwd = options.cwd ?? process.cwd();
+    this.configDir = options.configDir ?? resolveUserConfigDir();
+    this.onMigrate = options.onMigrate;
+  }
+
+  getConfigPath(): string {
+    return path.join(this.configDir, AI_CLI_CONFIG_FILENAME);
+  }
+
+  getLegacyConfigPath(): string {
+    return path.join(this.cwd, AI_CLI_CONFIG_FILENAME);
+  }
+
+  async read(): Promise<AiCliConfig | null> {
+    const current = await this.readFrom(this.getConfigPath());
+    if (current) return current;
+    return this.migrateLegacyConfig();
+  }
+
+  /** Delete the stored configuration (secure and legacy locations), wiping
+   * any saved credentials. Returns the paths that were actually removed. */
+  async clear(): Promise<string[]> {
+    const removed: string[] = [];
+    const candidates = new Set([this.getConfigPath(), this.getLegacyConfigPath()].map((p) => path.resolve(p)));
+    for (const configPath of candidates) {
+      try {
+        await fs.rm(configPath);
+        removed.push(configPath);
+      } catch {
+        // Missing file: nothing to remove at this location.
+      }
+    }
+    return removed;
+  }
+
+  async write(config: AiCliConfig): Promise<void> {
+    const configPath = this.getConfigPath();
+    await fs.mkdir(path.dirname(configPath), { recursive: true, mode: CONFIG_DIR_MODE });
+    const data = `${JSON.stringify(config, null, 2)}\n`;
+    await fs.writeFile(configPath, data, { encoding: "utf-8", mode: CONFIG_FILE_MODE });
+  }
+
+  private async readFrom(configPath: string): Promise<AiCliConfig | null> {
+    try {
+      const content = await fs.readFile(configPath, "utf-8");
+      return parseAiCliConfig(JSON.parse(content));
+    } catch {
+      return null;
+    }
+  }
+
+  private async migrateLegacyConfig(): Promise<AiCliConfig | null> {
+    const legacyPath = this.getLegacyConfigPath();
+    if (path.resolve(legacyPath) === path.resolve(this.getConfigPath())) return null;
+    const legacy = await this.readFrom(legacyPath);
+    if (!legacy) return null;
+    try {
+      await this.write(legacy);
+      await fs.rm(legacyPath, { force: true });
+      this.onMigrate?.(legacyPath, this.getConfigPath());
+    } catch {
+      // Migration is best-effort: keep serving the legacy config on failure.
+    }
+    return legacy;
+  }
+}

package/ai/infrastructure/file-system-adapter.ts

@@ -1,85 +1,85 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { statSync } from 'node:fs';
-
-export interface FilePayload {
-    filePath: string;
-    content: string;
-}
-
-export class FileSystemAdapter {
-    constructor(private readonly baseDir: string = process.cwd()) {}
-
-    splitExistingDirectories(targetDirectories: string[]): { existing: string[]; missing: string[] } {
-        const existing: string[] = [];
-        const missing: string[] = [];
-
-        for (const targetDirectory of targetDirectories) {
-            const absolutePath = path.resolve(this.baseDir, targetDirectory);
-            try {
-                const stat = statSync(absolutePath);
-                if (stat.isDirectory()) {
-                    existing.push(targetDirectory);
-                } else {
-                    missing.push(targetDirectory);
-                }
-            } catch {
-                missing.push(targetDirectory);
-            }
-        }
-
-        return { existing, missing };
-    }
-
-    async readDirectoryRecursively(targetDirectory: string): Promise<FilePayload[]> {
-        const absolutePath = path.resolve(this.baseDir, targetDirectory);
-        const resolvedFiles: FilePayload[] = [];
-
-        try {
-            await this.traverse(absolutePath, resolvedFiles);
-        } catch (error) {
-        }
-
-        return resolvedFiles;
-    }
-
-    private async traverse(currentPath: string, payloadList: FilePayload[]): Promise<void> {
-        let stats;
-        try {
-            stats = await fs.stat(currentPath);
-        } catch {
-            return;
-        }
-
-        if (stats.isDirectory()) {
-            const basename = path.basename(currentPath);
-            if (['node_modules', '.git', '.next', 'out', 'dist'].includes(basename)) {
-                return;
-            }
-
-            const entries = await fs.readdir(currentPath);
-            for (const entry of entries) {
-                await this.traverse(path.join(currentPath, entry), payloadList);
-            }
-        } else if (stats.isFile()) {
-            const ext = path.extname(currentPath);
-            const validExtensions = ['.ts', '.tsx', '.js', '.jsx', '.json', '.md', '.css'];
-            if (validExtensions.includes(ext)) {
-                try {
-                    const content = await fs.readFile(currentPath, 'utf-8');
-                    payloadList.push({
-                        filePath: currentPath,
-                        content: content
-                    });
-                } catch {
-                }
-            }
-        }
-    }
-
-    async writeDocumentationOutput(outputContent: string, targetPath: string = "documentation-output.md"): Promise<void> {
-        const absoluteDest = path.resolve(this.baseDir, targetPath);
-        await fs.mkdir(path.dirname(absoluteDest), { recursive: true });
-        await fs.writeFile(absoluteDest, outputContent, 'utf-8');
-    }
-}
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { statSync } from 'node:fs';
+
+export interface FilePayload {
+    filePath: string;
+    content: string;
+}
+
+export class FileSystemAdapter {
+    constructor(private readonly baseDir: string = process.cwd()) {}
+
+    splitExistingDirectories(targetDirectories: string[]): { existing: string[]; missing: string[] } {
+        const existing: string[] = [];
+        const missing: string[] = [];
+
+        for (const targetDirectory of targetDirectories) {
+            const absolutePath = path.resolve(this.baseDir, targetDirectory);
+            try {
+                const stat = statSync(absolutePath);
+                if (stat.isDirectory()) {
+                    existing.push(targetDirectory);
+                } else {
+                    missing.push(targetDirectory);
+                }
+            } catch {
+                missing.push(targetDirectory);
+            }
+        }
+
+        return { existing, missing };
+    }
+
+    async readDirectoryRecursively(targetDirectory: string): Promise<FilePayload[]> {
+        const absolutePath = path.resolve(this.baseDir, targetDirectory);
+        const resolvedFiles: FilePayload[] = [];
+
+        try {
+            await this.traverse(absolutePath, resolvedFiles);
+        } catch (error) {
+        }
+
+        return resolvedFiles;
+    }
+
+    private async traverse(currentPath: string, payloadList: FilePayload[]): Promise<void> {
+        let stats;
+        try {
+            stats = await fs.stat(currentPath);
+        } catch {
+            return;
+        }
+
+        if (stats.isDirectory()) {
+            const basename = path.basename(currentPath);
+            if (['node_modules', '.git', '.next', 'out', 'dist'].includes(basename)) {
+                return;
+            }
+
+            const entries = await fs.readdir(currentPath);
+            for (const entry of entries) {
+                await this.traverse(path.join(currentPath, entry), payloadList);
+            }
+        } else if (stats.isFile()) {
+            const ext = path.extname(currentPath);
+            const validExtensions = ['.ts', '.tsx', '.js', '.jsx', '.json', '.md', '.css'];
+            if (validExtensions.includes(ext)) {
+                try {
+                    const content = await fs.readFile(currentPath, 'utf-8');
+                    payloadList.push({
+                        filePath: currentPath,
+                        content: content
+                    });
+                } catch {
+                }
+            }
+        }
+    }
+
+    async writeDocumentationOutput(outputContent: string, targetPath: string = "documentation-output.md"): Promise<void> {
+        const absoluteDest = path.resolve(this.baseDir, targetPath);
+        await fs.mkdir(path.dirname(absoluteDest), { recursive: true });
+        await fs.writeFile(absoluteDest, outputContent, 'utf-8');
+    }
+}

package/ai/infrastructure/llm/tools-llm-provider.ts

@@ -1,54 +1,54 @@
-import { createDefaultFactory, legacyProviderToCatalogId } from "@gitpagedocs/tools/ai";
-import type { AiMessage, ProviderConfig } from "@gitpagedocs/tools/ports";
-import type { ILLMProvider, ChatMessage, ILLMProviderConfig } from "../../core/ports/illm-provider";
-import { DEFAULT_AI_DOC_PROMPT, type AiProviderId } from "../../config";
-
-const factory = createDefaultFactory();
-
-/**
- * Single CLI LLM provider backed by the shared @gitpagedocs/tools AI core.
- * Replaces the four duplicated CLI provider classes (OpenAI/Claude/Gemini/
- * Ollama) with one adapter over the registry/factory, preserving the
- * ILLMProvider contract used by the AI documentation flow.
- */
-export class ToolsLlmProvider implements ILLMProvider {
-  private readonly providerId;
-  private readonly model: string;
-  private readonly apiKey?: string;
-  private readonly baseUrl?: string;
-
-  constructor(legacyProvider: AiProviderId, config: ILLMProviderConfig) {
-    this.providerId = legacyProviderToCatalogId(legacyProvider);
-    this.model = config.model ?? "";
-    this.apiKey = config.apiKey;
-    this.baseUrl = config.baseUrl;
-  }
-
-  async generateDocumentation(fileContent: string, contextPrompt?: string): Promise<string> {
-    return this.chat([
-      { role: "system", content: contextPrompt || DEFAULT_AI_DOC_PROMPT },
-      { role: "user", content: fileContent },
-    ]);
-  }
-
-  async chat(messages: ChatMessage[]): Promise<string> {
-    const system = messages
-      .filter((m) => m.role === "system")
-      .map((m) => m.content)
-      .join("\n");
-    const aiMessages: AiMessage[] = messages
-      .filter((m) => m.role !== "system")
-      .map((m) => ({ role: m.role as AiMessage["role"], content: m.content }));
-
-    const config: ProviderConfig = {
-      providerId: this.providerId,
-      model: this.model,
-      apiKey: this.apiKey,
-      baseUrl: this.baseUrl,
-    };
-    const response = await factory
-      .create(this.providerId)
-      .generate({ messages: aiMessages, system: system || undefined, maxTokens: 4000 }, config);
-    return response.text;
-  }
-}
+import { createDefaultFactory, legacyProviderToCatalogId } from "@gitpagedocs/tools/ai";
+import type { AiMessage, ProviderConfig } from "@gitpagedocs/tools/ports";
+import type { ILLMProvider, ChatMessage, ILLMProviderConfig } from "../../core/ports/illm-provider";
+import { DEFAULT_AI_DOC_PROMPT, type AiProviderId } from "../../config";
+
+const factory = createDefaultFactory();
+
+/**
+ * Single CLI LLM provider backed by the shared @gitpagedocs/tools AI core.
+ * Replaces the four duplicated CLI provider classes (OpenAI/Claude/Gemini/
+ * Ollama) with one adapter over the registry/factory, preserving the
+ * ILLMProvider contract used by the AI documentation flow.
+ */
+export class ToolsLlmProvider implements ILLMProvider {
+  private readonly providerId;
+  private readonly model: string;
+  private readonly apiKey?: string;
+  private readonly baseUrl?: string;
+
+  constructor(legacyProvider: AiProviderId, config: ILLMProviderConfig) {
+    this.providerId = legacyProviderToCatalogId(legacyProvider);
+    this.model = config.model ?? "";
+    this.apiKey = config.apiKey;
+    this.baseUrl = config.baseUrl;
+  }
+
+  async generateDocumentation(fileContent: string, contextPrompt?: string): Promise<string> {
+    return this.chat([
+      { role: "system", content: contextPrompt || DEFAULT_AI_DOC_PROMPT },
+      { role: "user", content: fileContent },
+    ]);
+  }
+
+  async chat(messages: ChatMessage[]): Promise<string> {
+    const system = messages
+      .filter((m) => m.role === "system")
+      .map((m) => m.content)
+      .join("\n");
+    const aiMessages: AiMessage[] = messages
+      .filter((m) => m.role !== "system")
+      .map((m) => ({ role: m.role as AiMessage["role"], content: m.content }));
+
+    const config: ProviderConfig = {
+      providerId: this.providerId,
+      model: this.model,
+      apiKey: this.apiKey,
+      baseUrl: this.baseUrl,
+    };
+    const response = await factory
+      .create(this.providerId)
+      .generate({ messages: aiMessages, system: system || undefined, maxTokens: 4000 }, config);
+    return response.text;
+  }
+}