cloving 0.3.10 → 0.3.12

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/cloving_gpt/index.js

@@ -3,20 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const axios_1 = __importDefault(require("axios"));
-const child_process_1 = require("child_process");
+const cli_highlight_1 = __importDefault(require("cli-highlight"));
 const process_1 = __importDefault(require("process"));
-const prompts_1 = require("@inquirer/prompts");
 const colors_1 = __importDefault(require("colors"));
+const prompts_1 = require("@inquirer/prompts");
+const axios_1 = __importDefault(require("axios"));
 const claude_1 = require("./adapters/claude");
 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 string_utils_1 = require("../utils/string_utils");
 const config_utils_1 = require("../utils/config_utils");
 class ClovingGPT {
     constructor(options) {
@@ -75,41 +73,36 @@ class ClovingGPT {
             default: true,
         });
         if (reviewPrompt) {
-            const tempFile = path_1.default.join(os_1.default.tmpdir(), `cloving_prompt_${Date.now()}.txt`);
-            fs_1.default.writeFileSync(tempFile, fullPrompt);
-            const editor = 'less';
-            const editProcess = (0, child_process_1.spawn)(editor, [tempFile], { stdio: 'inherit' });
-            return new Promise((resolve, reject) => {
-                editProcess.on('close', async (code) => {
-                    if (code !== 0) {
-                        console.error(`${editor} exited with code ${code}`);
-                        fs_1.default.unlinkSync(tempFile);
-                        reject(new Error(`Editor exited with non-zero code`));
-                        return;
-                    }
-                    const editedPrompt = fs_1.default.readFileSync(tempFile, 'utf-8').trim();
-                    fs_1.default.unlinkSync(tempFile);
-                    if (editedPrompt === '') {
-                        console.log('Prompt is empty.');
-                        resolve(null);
-                        return;
+            (0, string_utils_1.parseMarkdownInstructions)(fullPrompt).map((code) => {
+                if (code.trim().startsWith('```')) {
+                    const lines = code.split('\n');
+                    const language = code.match(/```(\w+)/)?.[1] || 'default';
+                    console.log(lines[0]);
+                    try {
+                        if (language === 'default') {
+                            console.log((0, cli_highlight_1.default)(lines.slice(1, -1).join('\n')));
+                        }
+                        else {
+                            console.log((0, cli_highlight_1.default)(lines.slice(1, -1).join('\n'), { language }));
+                        }
                     }
-                    const confirmPrompt = await (0, prompts_1.confirm)({
-                        message: `Are you sure you want to continue?`,
-                        default: true,
-                    });
-                    if (!confirmPrompt) {
-                        resolve(null);
-                        return;
+                    catch (error) {
+                        // don't highlight if it fails
+                        console.log(lines.slice(1, -1).join('\n'));
                     }
-                    resolve(editedPrompt);
-                });
-                editProcess.on('error', (err) => {
-                    console.error('Error launching editor:', err);
-                    fs_1.default.unlinkSync(tempFile);
-                    reject(err);
-                });
+                    console.log(lines.slice(-1)[0]);
+                }
+                else {
+                    console.log((0, cli_highlight_1.default)(code, { language: 'markdown' }));
+                }
+            });
+            const confirmPrompt = await (0, prompts_1.confirm)({
+                message: `Are you sure you want to continue?`,
+                default: true,
             });
+            if (!confirmPrompt) {
+                process_1.default.exit(1);
+            }
         }
         return prompt;
     }

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/commit.js

@@ -6,6 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const CommitManager_1 = __importDefault(require("../../managers/CommitManager"));
 const commit = async (options) => {
     const commitManager = new CommitManager_1.default(options);
-    await commitManager.commit();
+    await commitManager.generateCommit();
 };
 exports.default = commit;

package/dist/commands/generate/docs.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 DocsManager_1 = __importDefault(require("../../managers/DocsManager"));
+const docs = async (options) => {
+    const docsManager = new DocsManager_1.default(options);
+    await docsManager.generateDocs();
+};
+exports.default = docs;

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/generate/review.js

@@ -6,6 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ReviewManager_1 = __importDefault(require("../../managers/ReviewManager"));
 const review = async (options) => {
     const reviewManager = new ReviewManager_1.default(options);
-    await reviewManager.review();
+    await reviewManager.generateReview();
 };
 exports.default = review;

package/dist/commands/tokens.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * @module tokens
+ * This module provides functionality to estimate the number of tokens in the context files
+ * and project description for GPT processing.
+ */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -7,10 +12,19 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const config_utils_1 = require("../utils/config_utils");
 const prompt_utils_1 = require("../utils/prompt_utils");
+/**
+ * Calculates the estimated number of tokens for the given context files and project description.
+ * @param {ClovingGPTOptions} options - The options for token calculation, including file paths.
+ * @returns {Promise<void>} A promise that resolves when the token estimation is complete.
+ */
 const tokens = async (options) => {
     let contextFiles = {};
     let files = options.files || '.';
     let prompt = '';
+    /**
+     * Expands the given file paths to include all files in directories.
+     * @type {string[]}
+     */
     let expandedFiles = [];
     for (const file of files) {
         const filePath = path_1.default.resolve(file);
@@ -26,6 +40,9 @@ const tokens = async (options) => {
         }
     }
     files = expandedFiles;
+    /**
+     * Reads the content of each file and stores it in the contextFiles object.
+     */
     for (const file of files) {
         const filePath = path_1.default.resolve(file);
         if (await fs_1.default.promises
@@ -36,6 +53,9 @@ const tokens = async (options) => {
             contextFiles[file] = content;
         }
     }
+    /**
+     * Generates the prompt content by combining the app description and context file contents.
+     */
     const contextFileContents = Object.keys(contextFiles)
         .map((file) => `### Contents of ${file}\n\n${contextFiles[file]}\n\n`)
         .join('\n');
@@ -45,6 +65,10 @@ const tokens = async (options) => {
 ${JSON.stringify((0, config_utils_1.getClovingConfig)(), null, 2)}
 
 ${contextFileContents}`;
+    /**
+     * Estimates the number of tokens based on the prompt length.
+     * This is a rough estimation and may not be exact.
+     */
     const tokens = Math.ceil(prompt.length / 4).toLocaleString();
     console.log(`Estimated tokens: ${tokens}`);
 };

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 docs_1 = __importDefault(require("./commands/generate/docs"));
 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('docs')
+    .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(docs_1.default);
 program.parse(process.argv);

package/dist/managers/BlockManager.js

@@ -23,7 +23,17 @@ class BlockManager extends events_1.EventEmitter {
             content = this.buffer + content;
             this.buffer = '';
         }
-        this.processCodeBlocks(content);
+        // if content has multiple \n``` in the string, then we need to split it up
+        if (content.includes('\n```')) {
+            while (content.includes('\n```')) {
+                const index = content.indexOf('\n```');
+                this.processCodeBlocks(content.slice(0, index + 4));
+                content = content.slice(index + 4);
+            }
+        }
+        if (content !== '') {
+            this.processCodeBlocks(content);
+        }
     }
     processCodeBlocks(content) {
         const codeBlockMarker = '\n```';
@@ -65,18 +75,12 @@ class BlockManager extends events_1.EventEmitter {
     emitCodeBlock() {
         if (this.codeBuffer.length > 0) {
             const currentNewBlock = this.parseCodeBuffer();
-            if (currentNewBlock) {
-                this.emit('codeBlock', {
-                    currentNewBlock,
-                    raw: this.codeBuffer,
-                });
-                this.emit('content', this.buffer);
-                this.clearBuffer();
-            }
-            else {
-                this.emit('codeBlock', this.codeBuffer);
-                this.clearBuffer();
-            }
+            this.emit('codeBlock', {
+                currentNewBlock,
+                raw: this.codeBuffer,
+            });
+            this.emit('content', this.buffer);
+            this.clearBuffer();
         }
     }
     /**