cloving 0.3.10 → 0.3.11

package/dist/cloving_gpt/adapters/azureopenai.js

@@ -16,7 +16,7 @@ class AzureOpenAIAdapter {
     }
     getHeaders(apiKey) {
         return {
-            'api-key': apiKey,
+            Authorization: `Bearer ${apiKey}`,
             'Content-Type': 'application/json',
         };
     }

package/dist/commands/config.js

@@ -5,6 +5,11 @@ 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
@@ -19,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}: `,
         });
@@ -44,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',
@@ -59,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',
@@ -79,6 +115,9 @@ const config = async () => {
             },
         });
         const parsedTemperature = parseFloat(temperature);
+        /**
+         * Constructs the model configuration object.
+         */
         let modelConfig = {
             apiKey,
             primary,
@@ -88,6 +127,9 @@ const config = async () => {
             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) => {
@@ -110,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/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.10",
+  "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.10",
+  "version": "0.3.11",
   "packageManager": "yarn@1.22.22",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",