cloving 0.3.9 → 0.3.11

package/dist/cloving_gpt/adapters/azureopenai.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureOpenAIAdapter = void 0;
+class AzureOpenAIAdapter {
+    static listSupportedModels() {
+        AzureOpenAIAdapter.supportedModels.forEach((model) => {
+            console.log(model);
+        });
+    }
+    constructor(model, endpoint) {
+        this.model = model;
+        this.endpoint = endpoint;
+    }
+    getEndpoint() {
+        return this.endpoint;
+    }
+    getHeaders(apiKey) {
+        return {
+            Authorization: `Bearer ${apiKey}`,
+            'Content-Type': 'application/json',
+        };
+    }
+    getPayload(request, stream = false) {
+        return {
+            model: this.model.replace('azureopenai:', '').replace(':', '-'),
+            messages: request.messages && request.messages.length > 0
+                ? request.messages
+                : [{ role: 'user', content: request.prompt }],
+            max_tokens: request.maxTokens,
+            temperature: request.temperature || 0.2,
+            stream,
+        };
+    }
+    extractResponse(data) {
+        return data.choices[0].message.content;
+    }
+    convertStream(data) {
+        let beginningChar = 0;
+        let lastChar = 0;
+        while (lastChar < data.length) {
+            try {
+                let remainingString = data.slice(beginningChar, lastChar);
+                const firstBraceIndex = remainingString.indexOf('{');
+                if (firstBraceIndex > -1) {
+                    remainingString = remainingString.slice(firstBraceIndex);
+                }
+                const parsedObject = JSON.parse(remainingString);
+                const output = parsedObject?.choices[0]?.delta?.content || '';
+                return {
+                    output,
+                    lastChar,
+                };
+            }
+            catch (error) {
+                lastChar += 1;
+            }
+        }
+        return null;
+    }
+}
+exports.AzureOpenAIAdapter = AzureOpenAIAdapter;
+AzureOpenAIAdapter.supportedModels = [
+    'azureopenai:gpt:4o-2024-08-06',
+    'azureopenai:gpt:4o',
+    'azureopenai:gpt:4o-mini',
+    'azureopenai:gpt:4-turbo',
+    'azureopenai:gpt:3.5-turbo',
+    // Add more supported models as needed
+];

package/dist/cloving_gpt/adapters/claude.js

@@ -1,19 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClaudeAdapter = void 0;
+/**
+ * ClaudeAdapter class implements the Adapter interface for Claude AI models.
+ */
 class ClaudeAdapter {
+    /**
+     * Initializes a new ClaudeAdapter instance.
+     * @param model - The Claude model identifier.
+     */
     constructor(model) {
         this.model = model;
         this.anthropicVersion = '2023-06-01';
     }
+    /**
+     * Logs all supported Claude models to the console.
+     */
     static listSupportedModels() {
         ClaudeAdapter.supportedModels.forEach((model) => {
             console.log(model);
         });
     }
+    /**
+     * Returns the API endpoint for Claude.
+     * @returns The API endpoint URL.
+     */
     getEndpoint() {
         return `https://api.anthropic.com/v1/messages`;
     }
+    /**
+     * Generates headers for API requests.
+     * @param apiKey - The API key for authentication.
+     * @returns An object containing the required headers.
+     */
     getHeaders(apiKey) {
         return {
             'x-api-key': apiKey,
@@ -21,6 +40,12 @@ class ClaudeAdapter {
             'anthropic-version': this.anthropicVersion,
         };
     }
+    /**
+     * Prepares the payload for API requests.
+     * @param request - The GPTRequest object containing request details.
+     * @param stream - Whether to enable streaming (default: false).
+     * @returns An object containing the prepared payload.
+     */
     getPayload(request, stream = false) {
         let system = 'You are a computer programmer giving advice on how to write better code.';
         if (request.messages && request.messages.length > 0 && request.messages[0].role === 'system') {
@@ -38,6 +63,12 @@ class ClaudeAdapter {
             stream,
         };
     }
+    /**
+     * Extracts the response text from the API response data.
+     * @param data - The API response data.
+     * @returns The extracted response text.
+     * @throws Error if the response structure is invalid.
+     */
     extractResponse(data) {
         try {
             if (data && data.content && Array.isArray(data.content) && data.content.length > 0) {
@@ -53,7 +84,11 @@ class ClaudeAdapter {
             throw error;
         }
     }
-    // data example: data: { type: 'content_block_delta', index: 0, delta: { type: 'text_delta', text: 'Hello, how are you?' } }
+    /**
+     * Converts streaming data to OpenAIStreamChunk format.
+     * @param data - The streaming data string.
+     * @returns An OpenAIStreamChunk object or null if parsing fails.
+     */
     convertStream(data) {
         let beginningChar = 0;
         let lastChar = 0;
@@ -81,6 +116,9 @@ class ClaudeAdapter {
     }
 }
 exports.ClaudeAdapter = ClaudeAdapter;
+/**
+ * Array of supported Claude model identifiers.
+ */
 ClaudeAdapter.supportedModels = [
     'claude:claude-3-5:sonnet-20240620',
     'claude:claude-3:opus-20240229',

package/dist/cloving_gpt/adapters/gemini.js

@@ -1,15 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GeminiAdapter = void 0;
+/**
+ * GeminiAdapter class implements the Adapter interface for Google's Gemini AI model.
+ */
 class GeminiAdapter {
+    /**
+     * Creates a new GeminiAdapter instance.
+     * @param model - The Gemini model to use.
+     */
     constructor(model) {
         this.model = model;
     }
+    /**
+     * Lists all supported Gemini models to the console.
+     */
     static async listSupportedModels() {
         GeminiAdapter.supportedModels.forEach((model) => {
             console.log(model);
         });
     }
+    /**
+     * Gets the appropriate API endpoint URL based on whether streaming is required.
+     * @param stream - Whether to use streaming endpoint.
+     * @returns The API endpoint URL.
+     */
     getEndpoint(stream = false) {
         if (stream) {
             return `https://generativelanguage.googleapis.com/v1beta/models/${this.model.replace(':', '-')}:streamGenerateContent`;
@@ -18,12 +33,23 @@ class GeminiAdapter {
             return `https://generativelanguage.googleapis.com/v1beta/models/${this.model.replace(':', '-')}:generateContent`;
         }
     }
+    /**
+     * Generates headers for the API request.
+     * @param apiKey - The API key for authentication.
+     * @returns An object containing the necessary headers.
+     */
     getHeaders(apiKey) {
         return {
             'Content-Type': 'application/json',
             'x-goog-api-key': apiKey,
         };
     }
+    /**
+     * Prepares the payload for the API request.
+     * @param request - The GPTRequest object containing prompt and other parameters.
+     * @param stream - Whether the request is for streaming.
+     * @returns The formatted payload object.
+     */
     getPayload(request, stream = false) {
         return {
             contents: [
@@ -44,6 +70,12 @@ class GeminiAdapter {
             },
         };
     }
+    /**
+     * Extracts the response text from the API response data.
+     * @param data - The raw API response data.
+     * @returns The extracted response text.
+     * @throws Error if the response structure is invalid.
+     */
     extractResponse(data) {
         try {
             if (data &&
@@ -64,6 +96,11 @@ class GeminiAdapter {
             throw error;
         }
     }
+    /**
+     * Converts a stream chunk to an OpenAIStreamChunk format.
+     * @param data - The raw stream chunk data.
+     * @returns An OpenAIStreamChunk object or null if parsing fails.
+     */
     convertStream(data) {
         let beginningChar = 0;
         let lastChar = 0;

package/dist/cloving_gpt/adapters/mistral.js

@@ -1,24 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MistralAdapter = void 0;
+/**
+ * MistralAdapter class
+ * Implements the Adapter interface for Mistral AI models.
+ */
 class MistralAdapter {
+    /**
+     * Prints all supported models to the console
+     */
     static listSupportedModels() {
         MistralAdapter.supportedModels.forEach((model) => {
             console.log(model);
         });
     }
+    /**
+     * Constructor
+     * @param model - The Mistral AI model to use
+     */
     constructor(model) {
         this.model = model;
     }
+    /**
+     * @returns The Mistral AI API endpoint
+     */
     getEndpoint() {
         return 'https://api.mistral.ai/v1/chat/completions';
     }
+    /**
+     * @param apiKey - The API key for authentication
+     * @returns Headers for the API request
+     */
     getHeaders(apiKey) {
         return {
             Authorization: `Bearer ${apiKey}`,
             'Content-Type': 'application/json',
         };
     }
+    /**
+     * Prepares the payload for the API request
+     * @param request - The GPT request object
+     * @param stream - Whether to use streaming mode
+     * @returns The formatted payload
+     */
     getPayload(request, stream = false) {
         return {
             model: this.model.replace(':', '-'),
@@ -30,6 +54,11 @@ class MistralAdapter {
             stream,
         };
     }
+    /**
+     * Extracts the response content from the API data
+     * @param data - The API response data
+     * @returns The extracted response content
+     */
     extractResponse(data) {
         return data.choices[0].message.content;
     }
@@ -51,6 +80,11 @@ class MistralAdapter {
     //          }
     //      ]
     //    }
+    /**
+     * Converts streaming data to OpenAIStreamChunk format
+     * @param data - The streaming data string
+     * @returns Parsed OpenAIStreamChunk or null if parsing fails
+     */
     convertStream(data) {
         let beginningChar = 0;
         let lastChar = 0;
@@ -78,6 +112,9 @@ class MistralAdapter {
     }
 }
 exports.MistralAdapter = MistralAdapter;
+/**
+ * List of supported Mistral AI models
+ */
 MistralAdapter.supportedModels = [
     'mistral:mistral:embed',
     'mistral:mistral:tiny-latest',

package/dist/cloving_gpt/adapters/ollama.js

@@ -5,10 +5,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OllamaAdapter = void 0;
 const axios_1 = __importDefault(require("axios"));
+/**
+ * Adapter for interacting with the Ollama API.
+ */
 class OllamaAdapter {
+    /**
+     * Constructor to initialize the OllamaAdapter with a specific model.
+     * @param model - The model to be used by the adapter.
+     */
     constructor(model) {
         this.model = model;
     }
+    /**
+     * Fetches and lists supported models from the Ollama API.
+     */
     static async listSupportedModels() {
         try {
             const endpoint = 'http://localhost:11434/api/tags';
@@ -31,15 +41,30 @@ class OllamaAdapter {
             // do nothing, no ollama server running
         }
     }
+    /**
+     * Returns the endpoint URL for generating responses.
+     * @returns The endpoint URL as a string.
+     */
     getEndpoint() {
         return `http://localhost:11434/api/generate`;
     }
+    /**
+     * Returns the headers required for making API requests.
+     * @param apiKey - The API key for authorization.
+     * @returns An object containing the headers.
+     */
     getHeaders(apiKey) {
         return {
             Authorization: `Bearer ${apiKey}`,
             'Content-Type': 'application/json',
         };
     }
+    /**
+     * Constructs the payload for the API request.
+     * @param request - The GPT request object containing the prompt.
+     * @param stream - Boolean indicating if the response should be streamed.
+     * @returns An object containing the payload.
+     */
     getPayload(request, stream = false) {
         return {
             model: this.model,
@@ -47,6 +72,12 @@ class OllamaAdapter {
             stream,
         };
     }
+    /**
+     * Extracts the response from the API response data.
+     * @param data - The response data from the API.
+     * @returns The extracted response as a string.
+     * @throws Will throw an error if the response structure is invalid.
+     */
     extractResponse(data) {
         try {
             if (data && typeof data === 'object' && 'response' in data) {
@@ -62,13 +93,11 @@ class OllamaAdapter {
             throw error;
         }
     }
-    // data example:
-    // {
-    //   model: 'dolphin-llama3:latest',
-    //   created_at: '2024-08-06T21:04:34.616355Z',
-    //   response: 'The',
-    //   done: false
-    // }
+    /**
+     * Converts a stream of data into an OpenAIStreamChunk.
+     * @param data - The string data to be converted.
+     * @returns An OpenAIStreamChunk object or null if conversion fails.
+     */
     convertStream(data) {
         let beginningChar = 0;
         let lastChar = 0;

package/dist/cloving_gpt/adapters/openai.js

@@ -1,24 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIAdapter = void 0;
+// OpenAIAdapter class implements the Adapter interface
 class OpenAIAdapter {
+    // Method to list supported models
     static listSupportedModels() {
         OpenAIAdapter.supportedModels.forEach((model) => {
             console.log(model);
         });
     }
+    // Constructor to initialize the model
     constructor(model) {
         this.model = model;
     }
+    // Method to get the API endpoint
     getEndpoint() {
         return `https://api.openai.com/v1/chat/completions`;
     }
+    // Method to get the headers for the API request
     getHeaders(apiKey) {
         return {
             Authorization: `Bearer ${apiKey}`,
             'Content-Type': 'application/json',
         };
     }
+    // Method to get the payload for the API request
     getPayload(request, stream = false) {
         return {
             model: this.model.replace(':', '-'),
@@ -30,9 +36,11 @@ class OpenAIAdapter {
             stream,
         };
     }
+    // Method to extract the response from the API response data
     extractResponse(data) {
         return data.choices[0].message.content;
     }
+    // Method to convert the stream data into OpenAIStreamChunk format
     // data example:
     //    {
     //      id: 'chatcmpl-9tL477A98d54qvVQqJT010bm8BLJl',
@@ -78,6 +86,7 @@ class OpenAIAdapter {
     }
 }
 exports.OpenAIAdapter = OpenAIAdapter;
+// List of supported models
 OpenAIAdapter.supportedModels = [
     'openai:gpt:4o-2024-08-06',
     'openai:gpt:4o',

package/dist/cloving_gpt/index.js

@@ -16,6 +16,7 @@ const openai_1 = require("./adapters/openai");
 const mistral_1 = require("./adapters/mistral");
 const ollama_1 = require("./adapters/ollama");
 const gemini_1 = require("./adapters/gemini");
+const azureopenai_1 = require("./adapters/azureopenai");
 const config_utils_1 = require("../utils/config_utils");
 class ClovingGPT {
     constructor(options) {
@@ -52,6 +53,12 @@ class ClovingGPT {
             case 'gemini':
                 this.adapter = new gemini_1.GeminiAdapter(model);
                 break;
+            case 'azureopenai':
+                if (!modelConfig.endpoint) {
+                    throw new Error('Azure OpenAI endpoint not configured');
+                }
+                this.adapter = new azureopenai_1.AzureOpenAIAdapter(model, modelConfig.endpoint);
+                break;
             default:
                 throw new Error(`Unsupported provider: ${provider}`);
         }
@@ -165,12 +172,24 @@ class ClovingGPT {
         }
         catch (err) {
             const error = err;
-            let errorMessage = error instanceof Error ? error.message : 'connection error';
-            if (errorMessage === '') {
-                errorMessage = 'connection error';
+            let errorMessage = 'An error occurred while communicating with the AI server';
+            if (error.response) {
+                // The request was made and the server responded with a status code
+                // that falls out of the range of 2xx
+                errorMessage = `Server responded with status ${error.response.status}: ${error.response.statusText}`;
+            }
+            else if (error.request) {
+                // The request was made but no response was received
+                errorMessage = 'No response received from the server';
+            }
+            else {
+                // Something happened in setting up the request that triggered an Error
+                errorMessage = error.message || 'Unknown error occurred';
             }
-            console.error(`Error communicating with the GPT server (${this.adapter.getEndpoint(this.stream)})\n\n${colors_1.default.red.bold(JSON.stringify(error.response?.data || "''", null, 2))}\n`);
-            throw error;
+            console.error(`${colors_1.default.red.bold('ERROR')} ${errorMessage}\n` +
+                `Endpoint: ${this.adapter.getEndpoint(this.stream)}\n` +
+                `Details: ${colors_1.default.yellow(JSON.stringify(error.response?.data || {}, null, 2))}\n`);
+            throw new Error(errorMessage);
         }
     }
     convertStream(data) {

package/dist/commands/config.js

@@ -3,7 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
 const config_utils_1 = require("../utils/config_utils");
 const prompt_utils_1 = require("../utils/prompt_utils");
+// Add this type definition at the top of the file
 const prompts_1 = require("@inquirer/prompts");
+/**
+ * Configures the AI models by prompting the user for various settings.
+ *
+ * @returns {Promise<void>} A promise that resolves when the configuration is complete.
+ */
 const config = async () => {
     let currentConfig = (0, config_utils_1.getConfig)({});
     // Ensure models are initialized properly
@@ -18,23 +24,35 @@ const config = async () => {
     let continueConfig = true;
     while (continueConfig) {
         const providers = [...new Set(models.map((model) => model.split(':')[0]))];
+        /**
+         * Prompts the user to select a provider from the available models.
+         */
         const selectedProvider = await (0, prompts_1.select)({
             message: 'Select a provider:',
             choices: providers.map((provider) => ({ name: provider, value: provider })),
         });
         const providerModels = models.filter((model) => model.startsWith(selectedProvider));
         const modelCategories = [...new Set(providerModels.map((model) => model.split(':')[1]))];
+        /**
+         * Prompts the user to select a category from the selected provider's models.
+         */
         const selectedCategory = await (0, prompts_1.select)({
             message: 'Select a category:',
             choices: modelCategories.map((category) => ({ name: category, value: category })),
         });
         const specificModels = providerModels.filter((model) => model.split(':')[1] === selectedCategory);
+        /**
+         * Prompts the user to select a specific model from the selected category.
+         */
         const modelIndex = await (0, prompts_1.select)({
             message: "Select an AI model you'd like to use:",
             choices: specificModels.map((model, index) => ({ name: model, value: index })),
             pageSize: specificModels.length,
         });
         const selectedModel = specificModels[modelIndex];
+        /**
+         * Prompts the user to enter the API key for the selected model.
+         */
         const apiKey = await (0, prompts_1.input)({
             message: `Enter your API key for ${selectedModel}: `,
         });
@@ -43,10 +61,18 @@ const config = async () => {
         if (!currentConfig.models[provider]) {
             currentConfig.models[provider] = {};
         }
+        /**
+         * Prompts the user to set the selected model as the primary model.
+         */
         const primary = await (0, prompts_1.confirm)({
             message: 'Set this model as the primary? Primary models are used by default if your prompt fits within its context window. You can configure backup models for larger prompts.',
             default: true,
         });
+        /**
+         * Prompts the user to enter the priority for the selected model.
+         *
+         * @returns {string} The priority value as a string.
+         */
         const priority = await (0, prompts_1.input)({
             message: 'Enter the priority for this model (0-100). Higher priority AI APIs are chosen as long as the prompt fits its context window:',
             default: primary ? '100' : '0',
@@ -58,14 +84,25 @@ const config = async () => {
                 return true;
             },
         });
+        /**
+         * Prompts the user to decide if they want to review all prompts before they are sent to the selected model.
+         */
         const review = await (0, prompts_1.confirm)({
             message: `Do you want to review all prompts before they are sent to ${selectedModel}?`,
             default: true,
         });
+        /**
+         * Prompts the user to decide if they trust the selected model with sensitive information.
+         */
         const trust = await (0, prompts_1.confirm)({
             message: `Do you trust ${selectedModel} with sensitive information?`,
             default: false,
         });
+        /**
+         * Prompts the user to enter the temperature setting for the selected model.
+         *
+         * @returns {string} The temperature value as a string.
+         */
         const temperature = await (0, prompts_1.input)({
             message: `Enter the temperature for ${selectedModel} (0.0 - 1.0): [0.2]`,
             default: '0.2',
@@ -78,7 +115,10 @@ const config = async () => {
             },
         });
         const parsedTemperature = parseFloat(temperature);
-        const modelConfig = {
+        /**
+         * Constructs the model configuration object.
+         */
+        let modelConfig = {
             apiKey,
             primary,
             priority: parseInt(priority, 10),
@@ -86,6 +126,21 @@ const config = async () => {
             trust,
             temperature: parsedTemperature,
         };
+        if (provider === 'azureopenai') {
+            /**
+             * Prompts the user to enter the Azure OpenAI endpoint URL.
+             */
+            const endpoint = await (0, prompts_1.input)({
+                message: 'Enter the Azure OpenAI endpoint URL:',
+                validate: (value) => {
+                    if (!value.startsWith('https://')) {
+                        return 'Please enter a valid HTTPS URL';
+                    }
+                    return true;
+                },
+            });
+            modelConfig.endpoint = endpoint;
+        }
         currentConfig.models[provider][model] = modelConfig;
         if (primary) {
             // Ensure only one primary model
@@ -97,6 +152,9 @@ const config = async () => {
                 }
             }
         }
+        /**
+         * Prompts the user to decide if they want to configure another model.
+         */
         const anotherModel = await (0, prompts_1.confirm)({
             message: 'Do you want to configure another model?',
             default: true,

package/dist/commands/generate/documentation.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const DocumentationManager_1 = __importDefault(require("../../managers/DocumentationManager"));
+const documentation = async (options) => {
+    const documentationManager = new DocumentationManager_1.default(options);
+    await documentationManager.generateDocumentation();
+};
+exports.default = documentation;

package/dist/commands/models.js

@@ -5,6 +5,7 @@ const openai_1 = require("../cloving_gpt/adapters/openai");
 const ollama_1 = require("../cloving_gpt/adapters/ollama");
 const gemini_1 = require("../cloving_gpt/adapters/gemini");
 const mistral_1 = require("../cloving_gpt/adapters/mistral");
+const azureopenai_1 = require("../cloving_gpt/adapters/azureopenai");
 const listModels = async () => {
     claude_1.ClaudeAdapter.listSupportedModels();
     gemini_1.GeminiAdapter.listSupportedModels();
@@ -16,5 +17,6 @@ const listModels = async () => {
         // do nothing, no ollama server running
     }
     openai_1.OpenAIAdapter.listSupportedModels();
+    azureopenai_1.AzureOpenAIAdapter.listSupportedModels();
 };
 exports.default = listModels;

package/dist/index.js

@@ -17,6 +17,7 @@ const commit_1 = __importDefault(require("./commands/generate/commit"));
 const context_1 = __importDefault(require("./commands/generate/context"));
 const unit_tests_1 = __importDefault(require("./commands/generate/unit_tests"));
 const review_1 = __importDefault(require("./commands/generate/review"));
+const documentation_1 = __importDefault(require("./commands/generate/documentation"));
 const prompt_utils_1 = require("./utils/prompt_utils");
 const program = new commander_1.Command();
 program
@@ -121,4 +122,13 @@ generate
     .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
     .option('-t, --temperature <temperature>', 'Temperature for the model (default 0.2)')
     .action(review_1.default);
+generate
+    .command('documentation')
+    .alias('d')
+    .description('Generate documentation for the project')
+    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .option('-f, --files <filenames...>', 'Specify filenames for files you want to document')
+    .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
+    .option('-t, --temperature <temperature>', 'Temperature for the model (default 0.2)')
+    .action(documentation_1.default);
 program.parse(process.argv);

package/dist/managers/DocumentationManager.js

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const prompts_1 = require("@inquirer/prompts");
+const colors_1 = __importDefault(require("colors"));
+const cli_highlight_1 = __importDefault(require("cli-highlight"));
+const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
+const config_utils_1 = require("../utils/config_utils");
+const prompt_utils_1 = require("../utils/prompt_utils");
+const string_utils_1 = require("../utils/string_utils");
+/**
+ * Manages the generation of documentation for specified files.
+ */
+class DocumentationManager {
+    /**
+     * Creates a new DocumentationManager instance.
+     * @param {ClovingGPTOptions} options - Configuration options for the DocumentationManager.
+     */
+    constructor(options) {
+        this.options = options;
+        this.contextFiles = {};
+        this.chatHistory = [];
+        this.options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+        this.gpt = new cloving_gpt_1.default(options);
+    }
+    /**
+     * Generates documentation for the specified files.
+     * @returns {Promise<void>}
+     */
+    async generateDocumentation() {
+        try {
+            await this.loadContextFiles();
+            if (this.chatHistory.length === 0) {
+                this.chatHistory.push({ role: 'user', content: prompt_utils_1.CODEGEN_INSTRUCTIONS });
+                this.chatHistory.push({ role: 'assistant', content: 'What would you like to do?' });
+            }
+            const prompt = this.generateDocumentationPrompt();
+            this.chatHistory.push({ role: 'user', content: prompt });
+            const response = await this.gpt.generateText({ prompt, messages: this.chatHistory });
+            this.displayGeneratedDocumentation(response);
+            const currentNewBlocks = (0, string_utils_1.extractCurrentNewBlocks)(response);
+            if (currentNewBlocks.length > 0) {
+                const shouldSave = await (0, prompts_1.confirm)({
+                    message: 'Do you want to save the generated documentation?',
+                    default: true,
+                });
+                if (shouldSave) {
+                    await (0, string_utils_1.applyAndSaveCurrentNewBlocks)(currentNewBlocks);
+                    console.log(colors_1.default.green('\nDocumentation has been saved to the respective files.'));
+                }
+            }
+        }
+        catch (error) {
+            console.error(colors_1.default.red('Error generating documentation:'), error);
+        }
+    }
+    /**
+     * Displays the generated documentation in the console with syntax highlighting.
+     * @param {string} rawDocumentationResponse - The raw documentation response from the GPT model.
+     */
+    displayGeneratedDocumentation(rawDocumentationResponse) {
+        (0, string_utils_1.parseMarkdownInstructions)(rawDocumentationResponse).map((code) => {
+            if (code.trim().startsWith('```')) {
+                const lines = code.split('\n');
+                const language = code.match(/```(\w+)/)?.[1] || 'plaintext';
+                console.log(lines[0]);
+                try {
+                    console.log((0, cli_highlight_1.default)(lines.slice(1, -1).join('\n'), { language }));
+                }
+                catch (error) {
+                    // don't highlight if it fails
+                    console.log(lines.slice(1, -1).join('\n'));
+                }
+                console.log(lines.slice(-1)[0]);
+            }
+            else {
+                console.log((0, cli_highlight_1.default)(code, { language: 'markdown' }));
+            }
+        });
+    }
+    /**
+     * Loads the context files specified in the options.
+     * @returns {Promise<void>}
+     */
+    async loadContextFiles() {
+        if (this.options.files) {
+            for (const file of this.options.files) {
+                this.contextFiles = await (0, prompt_utils_1.addFileOrDirectoryToContext)(file, this.contextFiles, this.options);
+            }
+        }
+        else {
+            console.log(colors_1.default.yellow('No files specified. Please provide files using the -f option.'));
+            process.exit(1);
+        }
+    }
+    /**
+     * Generates the documentation prompt to be sent to the GPT model.
+     * @returns {string} The generated documentation prompt.
+     */
+    generateDocumentationPrompt() {
+        const contextFileContents = Object.entries(this.contextFiles)
+            .map(([file, content]) => `### File: ${file}\n\n\`\`\`\n${content}\n\`\`\`\n`)
+            .join('\n\n');
+        return `Please generate documentation for the following files. Add or update documentation comments for functions, classes, and modules as appropriate. Use the standard documentation format for the respective language (e.g., JSDoc for JavaScript/TypeScript, docstrings for Python, etc.).
+
+${contextFileContents}
+
+Please provide the updated files with added documentation using the CURRENT/NEW block format. Only include the parts of the files that have changed.`;
+    }
+}
+exports.default = DocumentationManager;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloving",
-  "version": "0.3.9",
+  "version": "0.3.11",
   "packageManager": "yarn@1.22.22",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloving",
-  "version": "0.3.9",
+  "version": "0.3.11",
   "packageManager": "yarn@1.22.22",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",