cloving 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Lucas Carlson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# Cloving
+
+Cloving is an innovative tool designed to seamlessly integrate AI into various aspects of the developer workflow. It aims to enhance productivity and code quality by leveraging AI for tasks such as generating commit messages, conducting code reviews, and creating unit tests.
+
+## Features
+
+- **AI-powered Git commit message generation**
+- **Automated code reviews with AI insights**
+- **AI-assisted unit test generation**
+- **Seamless integration with existing development workflows**
+- **Customizable AI prompts for different tasks**
+
+## Prerequisites
+
+- Node.js (version 20 or higher)
+- Git
+- API access to AI chat models (e.g., OpenAI GPT-4o, Claude, etc.)
+
+## Installation
+
+1. Clone this repository:
+   ```bash
+   git clone https://github.com/clovingai/cloving-cli.git
+   ```
+
+2. Navigate to the project directory:
+   ```bash
+   cd cloving-cli
+   ```
+
+3. Install dependencies:
+   ```bash
+   yarn install
+   ```
+
+4. Set up your AI chat model environment variables:
+   ```bash
+   export CLOVING_MODEL=your_preferred_model
+   export CLOVING_API_KEY=your_api_key
+   ```
+
+## Usage
+
+Cloving provides several commands to help integrate AI into your development workflow:
+
+### Generating Commit Messages
+
+Run the following command in your Git repository:
+```bash
+cloving commit
+```
+This will generate an AI-powered commit message based on your recent changes, allow you to review and edit it, and then commit your changes.
+
+### Code Reviews
+
+To get an AI-powered code review for your latest changes:
+```bash
+cloving review
+```
+
+### Generating Unit Tests
+
+To generate unit tests for a specific file or function:
+```bash
+cloving unit-tests [file_path_to_test]
+```
+
+### Initial Setup
+
+To set up Cloving in the current project, generating a `cloving.json` file that includes a GPT-generated project overview with details like the language, framework, and language version:
+```bash
+cloving init
+```
+
+### Configuration
+
+To configure Cloving with your API key and model:
+```bash
+cloving config
+```
+
+### Listing Available Models
+
+To list the available AI models:
+```bash
+cloving models
+```
+
+## Command Line Options
+
+Usage: `cloving [options] [command]`
+
+Integrate AI into your development workflow for generating commit messages, code reviews, and unit tests.
+
+Options:
+- `-V, --version`   output the version number
+- `-h, --help`      display help for command
+
+Commands:
+- `commit`          Generate a commit message and commit the changes
+- `unit-tests`      Generate unit tests for the changes
+- `models`          List available models
+- `review`          Review the changes and propose
+- `init`            Setup Cloving in the current project
+- `config`          Configure Cloving with your API key and model
+- `help [command]`  Display help for command
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## Acknowledgements
+
+- This project is inspired by [aichat](https://github.com/sigoden/aichat) for interfacing with AI models.
+- Special thanks to the open-source community for inspiration and support.

package/dist/abstract_gpt/index.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+class AbstractGPT {
+    constructor() {
+        const clovingModel = process.env.CLOVING_MODEL;
+        this.apiKey = process.env.CLOVING_API_KEY || '';
+        if (!clovingModel || !this.apiKey) {
+            throw new Error("CLOVING_MODEL and CLOVING_API_KEY environment variables must be set");
+        }
+        const [provider, model] = clovingModel.split(':');
+        this.provider = provider;
+        this.model = model;
+    }
+    getEndpoint() {
+        switch (this.provider) {
+            case 'openai':
+                return `https://api.openai.com/v1/engines/${this.model}/completions`;
+            case 'claude':
+                return `https://api.anthropic.com/v1/claude/${this.model}`;
+            case 'gpt4all':
+                return `https://api.gpt4all.io/v1/models/${this.model}/completions`;
+            default:
+                throw new Error(`Unsupported provider: ${this.provider}`);
+        }
+    }
+    async generateText(request) {
+        const endpoint = this.getEndpoint();
+        const response = await axios_1.default.post(endpoint, {
+            model: this.model,
+            prompt: request.prompt,
+            max_tokens: request.maxTokens || 100,
+            temperature: request.temperature || 0.7
+        }, {
+            headers: {
+                'Authorization': `Bearer ${this.apiKey}`,
+                'Content-Type': 'application/json'
+            }
+        });
+        switch (this.provider) {
+            case 'openai':
+                return response.data.choices[0].text;
+            case 'claude':
+                return response.data.completion;
+            case 'gpt4all':
+                return response.data.text;
+            default:
+                throw new Error(`Unsupported provider: ${this.provider}`);
+        }
+    }
+}
+exports.default = AbstractGPT;

package/dist/cloving_gpt/adapters/Adapter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cloving_gpt/adapters/claude.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClaudeAdapter = void 0;
+class ClaudeAdapter {
+    constructor(model) {
+        this.model = model;
+        this.anthropicVersion = '2023-06-01';
+    }
+    static listSupportedModels() {
+        ClaudeAdapter.supportedModels.forEach(model => {
+            console.log(model);
+        });
+    }
+    getEndpoint() {
+        return `https://api.anthropic.com/v1/messages`;
+    }
+    getHeaders(apiKey) {
+        return {
+            'x-api-key': apiKey,
+            'Content-Type': 'application/json',
+            'anthropic-version': this.anthropicVersion
+        };
+    }
+    getPayload(request) {
+        return {
+            model: this.model,
+            system: 'You are a computer programmer giving advice on how to write better code.',
+            messages: [
+                { role: 'user', content: request.prompt }
+            ],
+            max_tokens: request.maxTokens || 4096,
+            temperature: request.temperature || 0.7
+        };
+    }
+    extractResponse(data) {
+        try {
+            if (data && data.content && Array.isArray(data.content) && data.content.length > 0) {
+                return data.content.map((item) => item.text).join('\n');
+            }
+            else {
+                console.error('Unexpected response structure:', data);
+                throw new Error('Invalid response structure');
+            }
+        }
+        catch (error) {
+            console.error('Error extracting response:', error);
+            throw error;
+        }
+    }
+}
+exports.ClaudeAdapter = ClaudeAdapter;
+ClaudeAdapter.supportedModels = [
+    'claude:claude-3-5-sonnet-20240620',
+    'claude:claude-3-opus-20240229',
+    'claude:claude-3-sonnet-20240229',
+    'claude:claude-3-haiku-20240307',
+    // Add more supported models here as needed
+];
+// Example usage:
+// ClaudeAdapter.listSupportedModels()

package/dist/cloving_gpt/adapters/gpt4all.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GPT4AllAdapter = void 0;
+class GPT4AllAdapter {
+    constructor(model) {
+        this.model = model;
+    }
+    getEndpoint() {
+        return `https://api.gpt4all.io/v1/models/${this.model}/completions`;
+    }
+    getHeaders(apiKey) {
+        return {
+            'Authorization': `Bearer ${apiKey}`,
+            'Content-Type': 'application/json'
+        };
+    }
+    getPayload(request) {
+        return {
+            model: this.model,
+            prompt: request.prompt,
+            max_tokens: request.maxTokens,
+            temperature: request.temperature || 0.7
+        };
+    }
+    extractResponse(data) {
+        return data.text;
+    }
+}
+exports.GPT4AllAdapter = GPT4AllAdapter;

package/dist/cloving_gpt/adapters/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cloving_gpt/adapters/ollama.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OllamaAdapter = void 0;
+const axios_1 = __importDefault(require("axios"));
+class OllamaAdapter {
+    constructor(model) {
+        this.model = model;
+    }
+    static async listSupportedModels() {
+        try {
+            const endpoint = 'http://localhost:11434/api/tags';
+            const headers = {
+                'Content-Type': 'application/json'
+            };
+            const response = await axios_1.default.get(endpoint, { headers });
+            const data = response.data;
+            if (data && Array.isArray(data.models)) {
+                OllamaAdapter.supportedModels = data.models.map((model) => `ollama:${model.name}`);
+                OllamaAdapter.supportedModels.forEach(model => {
+                    console.log(model);
+                });
+            }
+            else {
+                console.error('Unexpected response structure:', data);
+            }
+        }
+        catch (error) {
+            // do nothing, no ollama server running
+        }
+    }
+    getEndpoint() {
+        return `http://localhost:11434/api/generate`;
+    }
+    getHeaders(apiKey) {
+        return {
+            'Authorization': `Bearer ${apiKey}`,
+            'Content-Type': 'application/json'
+        };
+    }
+    getPayload(request) {
+        return {
+            model: this.model,
+            prompt: request.prompt,
+            stream: request.stream ?? false
+        };
+    }
+    extractResponse(data) {
+        try {
+            if (data && typeof data === 'object' && 'response' in data) {
+                return data.response;
+            }
+            else {
+                console.error('Unexpected response structure:', data);
+                throw new Error('Invalid response structure');
+            }
+        }
+        catch (error) {
+            console.error('Error extracting response:', error);
+            throw error;
+        }
+    }
+}
+exports.OllamaAdapter = OllamaAdapter;
+OllamaAdapter.supportedModels = [];

package/dist/cloving_gpt/adapters/openai.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAIAdapter = void 0;
+class OpenAIAdapter {
+    static listSupportedModels() {
+        OpenAIAdapter.supportedModels.forEach(model => {
+            console.log(model);
+        });
+    }
+    constructor(model) {
+        this.model = model;
+    }
+    getEndpoint() {
+        return `https://api.openai.com/v1/chat/completions`;
+    }
+    getHeaders(apiKey) {
+        return {
+            'Authorization': `Bearer ${apiKey}`,
+            'Content-Type': 'application/json'
+        };
+    }
+    getPayload(request) {
+        return {
+            model: this.model,
+            messages: [{ role: "user", content: request.prompt }],
+            max_tokens: request.maxTokens,
+            temperature: request.temperature || 0.7
+        };
+    }
+    extractResponse(data) {
+        return data.choices[0].message.content;
+    }
+}
+exports.OpenAIAdapter = OpenAIAdapter;
+OpenAIAdapter.supportedModels = [
+    'openai:gpt-4o',
+    'openai:gpt-4-turbo',
+    'openai:gpt-3.5-turbo',
+    'openai:text-embedding-3-large',
+    // Add more supported models here as needed
+];

package/dist/cloving_gpt/index.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const readline_1 = __importDefault(require("readline"));
+const child_process_1 = require("child_process");
+const process_1 = __importDefault(require("process"));
+const claude_1 = require("./adapters/claude");
+const openai_1 = require("./adapters/openai");
+const gpt4all_1 = require("./adapters/gpt4all");
+const ollama_1 = require("./adapters/ollama");
+const command_utils_1 = require("../utils/command_utils");
+class ClovingGPT {
+    constructor(options = { silent: false }) {
+        const config = (0, command_utils_1.getConfig)();
+        if (!config || !config.primaryModel || !config.models) {
+            throw new Error('No cloving configuration found. Please run `cloving config`');
+        }
+        const clovingModel = config.primaryModel;
+        this.apiKey = config.models[config?.primaryModel || ''].trim();
+        this.silent = options.silent;
+        const parts = clovingModel.split(':');
+        const model = parts.slice(1).join(':');
+        switch (parts[0]) {
+            case 'claude':
+                this.adapter = new claude_1.ClaudeAdapter(model);
+                break;
+            case 'openai':
+                this.adapter = new openai_1.OpenAIAdapter(model);
+                break;
+            case 'gpt4all':
+                this.adapter = new gpt4all_1.GPT4AllAdapter(model);
+                break;
+            case 'ollama':
+                this.adapter = new ollama_1.OllamaAdapter(model);
+                break;
+            default:
+                throw new Error(`Unsupported provider: ${parts[0]}`);
+        }
+    }
+    async askUserToConfirm(prompt, message) {
+        if (this.silent)
+            return true;
+        const rl = readline_1.default.createInterface({
+            input: process_1.default.stdin,
+            output: process_1.default.stdout
+        });
+        return new Promise((resolve) => {
+            rl.question(message, (answer) => {
+                rl.close();
+                answer = answer.trim().toLowerCase();
+                if (answer === 'y' || answer === '') {
+                    const less = (0, child_process_1.spawn)('less', ['-R'], { stdio: ['pipe', process_1.default.stdout, process_1.default.stderr] });
+                    less.stdin.write(prompt);
+                    less.stdin.end();
+                    less.on('close', (code) => {
+                        if (code !== 0) {
+                            console.error('less command exited with an error.');
+                            resolve(false);
+                            return;
+                        }
+                        const rlConfirm = readline_1.default.createInterface({
+                            input: process_1.default.stdin,
+                            output: process_1.default.stdout
+                        });
+                        rlConfirm.question('Do you still want to continue? [Yn]: ', (confirmAnswer) => {
+                            rlConfirm.close();
+                            confirmAnswer = confirmAnswer.trim().toLowerCase();
+                            resolve(confirmAnswer === 'y' || confirmAnswer === '');
+                        });
+                    });
+                    less.stdin.on('error', (err) => {
+                        if (isNodeError(err) && err.code === 'EPIPE') {
+                            resolve(true);
+                        }
+                        else {
+                            console.error('Pipeline error:', err);
+                            resolve(false);
+                        }
+                    });
+                }
+                else {
+                    resolve(true);
+                }
+            });
+        });
+    }
+    async generateText(request) {
+        const endpoint = this.adapter.getEndpoint();
+        const payload = this.adapter.getPayload(request);
+        const headers = this.adapter.getHeaders(this.apiKey);
+        const tokenCount = Math.ceil(request.prompt.length / 4).toLocaleString();
+        const shouldContinue = await this.askUserToConfirm(request.prompt, `Do you want to review the ~${tokenCount} token prompt before sending it to ${endpoint}? [Yn]: `);
+        if (!shouldContinue) {
+            throw 'Operation cancelled by the user.';
+        }
+        try {
+            const response = await axios_1.default.post(endpoint, payload, { headers });
+            return this.adapter.extractResponse(response.data);
+        }
+        catch (error) {
+            let errorMessage = error instanceof Error ? error.message : 'connection error';
+            if (errorMessage === '') {
+                errorMessage = 'connection error';
+            }
+            console.error(`Error communicating with the GPT server (${this.adapter.getEndpoint()}):`, errorMessage);
+            throw error;
+        }
+    }
+}
+function isNodeError(error) {
+    return error instanceof Error && 'code' in error;
+}
+exports.default = ClovingGPT;

package/dist/commands/analyze.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const readline_1 = __importDefault(require("readline"));
+const child_process_1 = require("child_process");
+const git_utils_1 = require("../utils/git_utils");
+const model_utils_1 = require("../utils/model_utils");
+const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
+const analyze = async () => {
+    try {
+        // Define the prompt for analysis
+        const gitDiff = await (0, git_utils_1.getGitDiff)();
+        const model = (0, model_utils_1.getModel)();
+        const prompt = `Explain why the change is being made and document a description of these changes.
+Also list any bugs in the new code as well as recommended fixes for those bugs with code examples.
+
+${gitDiff}`;
+        // Instantiate ClovingGPT and get the analysis
+        const gpt = new cloving_gpt_1.default();
+        const analysis = await gpt.generateText({ prompt });
+        // Print the analysis to the console
+        console.log(analysis);
+        // Prompt the user to copy the analysis to the clipboard
+        const rl = readline_1.default.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        rl.question('Do you want to copy the analysis to the clipboard? [Y/n] ', (answer) => {
+            if (answer.toLowerCase() === 'y' || answer === '') {
+                try {
+                    (0, child_process_1.execFileSync)('pbcopy', { input: analysis });
+                    console.log('Analysis copied to clipboard');
+                }
+                catch (error) {
+                    console.error('Error: pbcopy command not found. Unable to copy to clipboard.');
+                }
+            }
+            rl.close();
+        });
+    }
+    catch (error) {
+        console.error('Error during analysis:', error.message);
+    }
+};
+exports.default = analyze;

package/dist/commands/check.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (options) => {
+    if (options.verbose)
+        console.log('Verbose mode enabled');
+    console.log('Checking something...');
+};

package/dist/commands/commit.js

@@ -0,0 +1,44 @@
+"use strict";
+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 path_1 = __importDefault(require("path"));
+const child_process_1 = require("child_process");
+const git_utils_1 = require("../utils/git_utils");
+const string_utils_1 = require("../utils/string_utils");
+const command_utils_1 = require("../utils/command_utils");
+const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
+const generateAndCommitMessage = async (options) => {
+    options.silent = (0, command_utils_1.getConfig)().silent || false;
+    const gpt = new cloving_gpt_1.default(options);
+    try {
+        // Generate the prompt for commit message
+        const prompt = (0, git_utils_1.generateCommitMessagePrompt)();
+        // Instantiate ClovingGPT and get the commit message
+        const rawCommitMessage = await gpt.generateText({ prompt });
+        // Clean the commit message using extractMarkdown
+        const commitMessage = (0, string_utils_1.extractMarkdown)(rawCommitMessage);
+        // Write the commit message to a temporary file
+        const tempCommitFilePath = path_1.default.join('.git', 'SUGGESTED_COMMIT_EDITMSG');
+        fs_1.default.writeFileSync(tempCommitFilePath, commitMessage);
+        // Commit the changes using the generated commit message
+        try {
+            (0, child_process_1.execFileSync)('git', ['commit', '-a', '--edit', '--file', tempCommitFilePath], { stdio: 'inherit' });
+        }
+        catch (commitError) {
+            // If commit is canceled (non-zero exit), handle it here
+            console.log('Commit was canceled or failed.');
+        }
+        // Remove the temporary file using fs
+        fs_1.default.unlink(tempCommitFilePath, (err) => {
+            if (err)
+                throw err;
+        });
+    }
+    catch (error) {
+        console.error('Could not generate commit message');
+    }
+};
+exports.default = generateAndCommitMessage;

package/dist/commands/config.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+const command_utils_1 = require("../utils/command_utils");
+const config = async () => {
+    let currentConfig = (0, command_utils_1.getConfig)();
+    // Ensure models is initialized properly
+    if (!currentConfig.models) {
+        currentConfig.models = {};
+    }
+    const models = await (0, command_utils_1.fetchModels)();
+    if (models.length === 0) {
+        console.error('No models available.');
+        throw new Error('No models available');
+    }
+    let continueConfig = true;
+    while (continueConfig) {
+        console.log('Available models:');
+        models.forEach((model, index) => console.log(`${index + 1}. ${model}`));
+        const modelIndex = parseInt(await (0, command_utils_1.promptUser)('Select a model by number: '), 10) - 1;
+        if (modelIndex < 0 || modelIndex >= models.length) {
+            console.error('Invalid selection.');
+            throw new Error('Invalid selection');
+        }
+        const selectedModel = models[modelIndex];
+        const apiKey = await (0, command_utils_1.promptUser)(`Enter your API key for ${selectedModel}: `);
+        currentConfig.models[selectedModel] = apiKey;
+        const setAsPrimary = await (0, command_utils_1.promptUser)('Do you want to set this model as the primary model? [Yn]: ');
+        if (setAsPrimary.toLowerCase() === 'y' || setAsPrimary === '') {
+            currentConfig.primaryModel = selectedModel;
+        }
+        const anotherModel = await (0, command_utils_1.promptUser)('Do you want to configure another model? [Yn]: ');
+        if (anotherModel.toLowerCase() !== 'y' && anotherModel !== '') {
+            continueConfig = false;
+        }
+    }
+    (0, command_utils_1.saveConfig)(currentConfig);
+};
+exports.config = config;
+exports.default = exports.config;