cloving 0.1.3 → 0.1.7

package/README.md

@@ -1,6 +1,8 @@
+Here's the updated README.md incorporating the latest changes:
+
 # 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.
+Cloving is an innovative CLI tool designed to seamlessly integrate AI into various aspects of the developer workflow. It enhances productivity and code quality by leveraging AI for tasks such as generating commit messages, conducting code reviews, creating unit tests, and even assisting with entire project lifecycles.
 
 ## Features
 
@@ -9,15 +11,43 @@ Cloving is an innovative tool designed to seamlessly integrate AI into various a
 - **AI-assisted unit test generation**
 - **Seamless integration with existing development workflows**
 - **Customizable AI prompts for different tasks**
+- **Project initialization, planning, and building with AI assistance**
+- **Support for multiple AI models including OpenAI, Claude, and Ollama**
 
 ## Prerequisites
 
 - Node.js (version 20 or higher)
 - Git
-- API access to AI chat models (e.g., OpenAI GPT-4o, Claude, etc.)
+- API access to AI chat models (e.g., OpenAI GPT-4, Claude, Ollama, etc.)
 
 ## Installation
 
+You have three options to install and use Cloving:
+
+### 1. Global Installation via npm
+
+Install Cloving globally using npm:
+
+```bash
+npm install cloving -g
+```
+
+This allows you to run `cloving` commands from anywhere in your terminal.
+
+### 2. Run with npx
+
+You can use npx to run Cloving without installing it globally:
+
+```bash
+npx cloving [command]
+```
+
+This method downloads and executes Cloving on-the-fly, ensuring you always use the latest version.
+
+### 3. Clone and Install from Source
+
+For development or to use the latest unreleased features:
+
 1. Clone this repository:
    ```bash
    git clone https://github.com/cloving-ai/cloving-cli.git
@@ -34,76 +64,127 @@ Cloving is an innovative tool designed to seamlessly integrate AI into various a
    yarn link
    ```
 
-4. Configure Cloving with your API key and model:
-   ```bash
-   cloving config
-   ```
+After installation, configure Cloving with your API key and preferred model:
+
+```bash
+cloving config
+```
+
+Choose the installation method that best suits your needs and workflow. The global npm installation is recommended for most users, while npx is great for one-off usage or trying out Cloving. Cloning from source is ideal for contributors or those who want the absolute latest features.
 
 ## Usage
 
 Cloving provides several commands to help integrate AI into your development workflow:
 
-### Generating Commit Messages
+### Configuration
 
-Run the following command in your Git repository:
+Configure Cloving with your API key and model:
 ```bash
-cloving commit
+cloving config
 ```
-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
+### Initialization
 
-To get an AI-powered code review for your latest changes:
+Set up Cloving in the current project:
 ```bash
-cloving review
+cloving init
 ```
+Options:
+- `-s, --silent`: Run without asking for confirmation of submitting prompts
+- `-m, --model <model>`: Select the model to use
 
-### Generating Unit Tests
+### Listing Available Models
 
-To generate unit tests for a specific file or function:
+List the available AI models:
 ```bash
-cloving unit-tests [file_path_to_test]
+cloving models
 ```
 
-### Initial Setup
+### Generating Commit Messages
 
-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:
+Generate an AI-powered commit message:
 ```bash
-cloving init
+cloving commit
+```
+or
+```bash
+cloving generate commit
 ```
+Options:
+- `-s, --silent`: Run without asking for confirmation
+- `-m, --model <model>`: Select the model to use
 
-### Configuration
+### Generating Unit Tests
 
-To configure Cloving with your API key and model:
+Generate unit tests for changes or specific files:
 ```bash
-cloving config
+cloving generate unit-tests
 ```
+Options:
+- `-s, --silent`: Run without asking for confirmation
+- `-f, --files <filenames...>`: Specify filenames for the unit tests
+- `-m, --model <model>`: Select the model to use
 
-### Listing Available Models
+### Code Reviews
 
-To list the available AI models:
+Get an AI-powered code review:
 ```bash
-cloving models
+cloving generate review
 ```
+Options:
+- `-s, --silent`: Run without asking for confirmation
+- `-m, --model <model>`: Select the model to use
+
+### Project Commands
+
+Cloving now includes commands for managing entire projects:
+
+- Initialize a new project inside a git branch:
+  ```bash
+  cloving project init
+  ```
+
+- Plan the steps to complete the project:
+  ```bash
+  cloving project plan
+  ```
+
+- Generate code to build the project:
+  ```bash
+  cloving project build
+  ```
+
+- Clean up and finalize the project:
+  ```bash
+  cloving project complete
+  ```
 
 ## 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
+- `-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
+- `config`: Configure Cloving with your API key and models to use
+- `init`: Setup Cloving in the current directory
+- `models`: List available models
+- `commit`: Alias for cloving generate commit
+- `generate`: Generate various items like unit-tests and code reviews
+  - `commit`: Generate a commit message and commit the changes
+  - `unit-tests`: Generate unit tests
+  - `review`: Review the code for committed changes
+- `project`: Commands for managing Cloving projects
+  - `init`: Setup a new Cloving project inside a git branch
+  - `plan`: Plan the steps to complete the project
+  - `build`: Generate code to build the project
+  - `complete`: Clean up and finalize the project
+
+Most commands support the following options:
+- `-s, --silent`: Run the command without asking for confirmation of submitting prompts
+- `-m, --model <model>`: Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)
 
 ## Contributing
 

package/dist/cloving_gpt/index.js

@@ -11,20 +11,24 @@ 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");
+const config_utils_1 = require("../utils/config_utils");
 class ClovingGPT {
     constructor(options = { silent: false }) {
-        const config = (0, command_utils_1.getConfig)(options);
-        if (!config || !config.primaryModel || !config.models) {
+        const { model: partialModel } = options;
+        const config = (0, config_utils_1.getConfig)(options);
+        if (!config || !config.models) {
             console.log('No cloving configuration found. Please run: cloving config');
             process_1.default.exit(1);
         }
-        const clovingModel = config.primaryModel;
-        this.apiKey = config.models[config?.primaryModel || ''].trim();
-        this.silent = options.silent || false;
-        const parts = clovingModel.split(':');
-        const model = parts.slice(1).join(':');
-        switch (parts[0]) {
+        const primaryModel = (0, config_utils_1.getPrimaryModel)(partialModel);
+        if (!primaryModel) {
+            console.log('No primary model found in the configuration. Please run: cloving config');
+            process_1.default.exit(1);
+        }
+        const { provider, model, config: modelConfig } = primaryModel;
+        this.apiKey = modelConfig.apiKey;
+        this.silent = options.silent || modelConfig.silent;
+        switch (provider) {
             case 'claude':
                 this.adapter = new claude_1.ClaudeAdapter(model);
                 break;
@@ -38,7 +42,7 @@ class ClovingGPT {
                 this.adapter = new ollama_1.OllamaAdapter(model);
                 break;
             default:
-                throw new Error(`Unsupported provider: ${parts[0]}`);
+                throw new Error(`Unsupported provider: ${provider}`);
         }
     }
     async askUserToConfirm(prompt, message) {

package/dist/commands/commit.js

@@ -8,10 +8,10 @@ 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 config_utils_1 = require("../utils/config_utils");
 const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
 const generateAndCommitMessage = async (options) => {
-    options.silent = (0, command_utils_1.getConfig)(options).silent || false;
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
     const gpt = new cloving_gpt_1.default(options);
     try {
         // Generate the prompt for commit message

package/dist/commands/config.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
+const config_utils_1 = require("../utils/config_utils");
 const command_utils_1 = require("../utils/command_utils");
 const config = async () => {
-    let currentConfig = (0, command_utils_1.getConfig)({});
+    let currentConfig = (0, config_utils_1.getConfig)({});
     // Ensure models is initialized properly
     if (!currentConfig.models) {
         currentConfig.models = {};
@@ -23,17 +24,43 @@ const config = async () => {
         }
         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 [provider, ...modelParts] = selectedModel.split(':');
+        const model = modelParts.join(':');
+        if (!currentConfig.models[provider]) {
+            currentConfig.models[provider] = {};
+        }
+        const setAsPrimary = await (0, command_utils_1.promptUser)('Do you want to use this model as a primary model? [Yn]: ');
+        const primary = setAsPrimary.toLowerCase() === 'y' || setAsPrimary === '';
+        const priorityNumber = await (0, command_utils_1.promptUser)('Enter the priority for this model (0-100, higher priority will be used as long as the prompt fits the context token limit): [' + (primary ? 100 : 0) + ']');
+        const priority = primary ? 100 : parseInt(priorityNumber, 10);
+        const silentResponse = await (0, command_utils_1.promptUser)('Do you want to review all prompts before they are sent to this model? [Yn]: ');
+        const silent = !(silentResponse.toLowerCase() === 'y' || silentResponse === '');
+        const trustResponse = await (0, command_utils_1.promptUser)('Do you trust this model with sensitive information? [Yn]: ');
+        const trust = trustResponse.toLowerCase() === 'y' || trustResponse === '';
+        const modelConfig = {
+            apiKey,
+            primary,
+            priority,
+            silent,
+            trust,
+        };
+        currentConfig.models[provider][model] = modelConfig;
+        if (primary) {
+            // Ensure only one primary model
+            for (const p in currentConfig.models) {
+                for (const m in currentConfig.models[p]) {
+                    if (p !== provider || m !== model) {
+                        currentConfig.models[p][m].primary = false;
+                    }
+                }
+            }
         }
         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);
+    (0, config_utils_1.saveConfig)(currentConfig);
 };
 exports.config = config;
 exports.default = exports.config;

package/dist/commands/generate/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 config_utils_1 = require("../../utils/config_utils");
+const cloving_gpt_1 = __importDefault(require("../../cloving_gpt"));
+const generateAndCommitMessage = async (options) => {
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || 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/generate/review.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const cli_highlight_1 = __importDefault(require("cli-highlight"));
+const cloving_gpt_1 = __importDefault(require("../../cloving_gpt"));
+const git_utils_1 = require("../../utils/git_utils");
+const string_utils_1 = require("../../utils/string_utils");
+const config_utils_1 = require("../../utils/config_utils");
+const string_utils_2 = require("../../utils/string_utils");
+const command_utils_1 = require("../../utils/command_utils");
+const review = async (options) => {
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+    const gpt = new cloving_gpt_1.default(options);
+    try {
+        // Define the prompt for analysis
+        const gitDiff = await (0, git_utils_1.getGitDiff)();
+        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.
+Format the output of this code review in Markdown format.
+
+${gitDiff}`;
+        // get the analysis
+        const analysis = await gpt.generateText({ prompt });
+        const markdown = (0, string_utils_1.extractMarkdown)(analysis);
+        // Print the analysis to the console
+        (0, string_utils_2.parseMarkdownInstructions)(markdown).map(code => {
+            if (code.trim().startsWith('```')) {
+                const lines = code.split('\n');
+                const language = code.match(/```(\w+)/)?.[1] || 'plaintext';
+                console.log(lines[0]);
+                console.log((0, cli_highlight_1.default)(lines.slice(1, -1).join('\n'), { language }));
+                console.log(lines.slice(-1)[0]);
+            }
+            else {
+                console.log((0, cli_highlight_1.default)(code, { language: 'markdown' }));
+            }
+        });
+        // Prompt the user to copy the analysis to the clipboard
+        const answer = await (0, command_utils_1.promptUser)('Do you want to copy the analysis to the clipboard? [Y/n] ');
+        if (answer.toLowerCase() === 'y' || answer === '') {
+            try {
+                (0, child_process_1.execFileSync)('pbcopy', { input: markdown });
+                console.log('Analysis copied to clipboard');
+            }
+            catch (error) {
+                console.error('Error: pbcopy command not found. Unable to copy to clipboard.');
+            }
+        }
+    }
+    catch (error) {
+        console.error('Error during analysis:', error.message);
+    }
+};
+exports.default = review;

package/dist/commands/generate/unit_tests.js

@@ -0,0 +1,125 @@
+"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 = require("fs");
+const child_process_1 = require("child_process");
+const cli_highlight_1 = __importDefault(require("cli-highlight"));
+const git_utils_1 = require("../../utils/git_utils");
+const config_utils_1 = require("../../utils/config_utils");
+const cloving_gpt_1 = __importDefault(require("../../cloving_gpt"));
+const extractChangedFiles = (gitDiff) => {
+    const fileRegex = /diff --git a\/(.+?) b\/(.+?)\n/g;
+    const files = new Set();
+    let match;
+    while ((match = fileRegex.exec(gitDiff)) !== null) {
+        files.add(match[1]);
+    }
+    return Array.from(files);
+};
+const generatePrompt = (files, srcFiles, testFiles, gitDiff) => {
+    const filesList = files.length > 0 ? files.join('\n') : 'No files provided';
+    const diffSection = gitDiff ? `Here is my git diff:\n\n==== begin git diff ====\n${gitDiff}\n==== end git diff ====\n` : '';
+    return `Here is a list of code files I want to generate unit tests for:
+
+==== begin list of files ====
+${filesList}
+==== end list of files ====
+
+Here is a list of all my source files:
+
+==== begin list of source files ====
+${srcFiles}
+==== end list of source files ====
+
+Here is a list of all my test files:
+
+==== begin list of test files ====
+${testFiles}
+==== end list of test files ====
+
+${diffSection}
+
+Please enumerate all the files in the provided list${gitDiff ? ' and git diff' : ''} as well as the file names of anything that these files interact with.
+
+Also, list any test files that might be relevant to these files.
+
+Give me this output format for your answer:
+
+## files
+
+app/models/foo.rb
+app/views/baz/bar.html.erb
+
+## relevant test files
+
+test/models/foo_test.rb
+test/controllers/baz_controller_test.rb`;
+};
+const unitTests = async (options) => {
+    const { files } = options;
+    const gpt = new cloving_gpt_1.default(options);
+    const allSrcFiles = await (0, config_utils_1.getAllFiles)(options, true);
+    const testingDirectory = (0, config_utils_1.getTestingDirectory)();
+    if (allSrcFiles.length === 0 || !testingDirectory) {
+        console.error('Could not find any source files to generate unit tests. Please run: cloving init. Then try again.');
+        process.exit(1);
+    }
+    const testFiles = (0, child_process_1.execFileSync)('find', [testingDirectory, '-type', 'f']).toString().trim();
+    let contextFiles;
+    if (files) {
+        const prompt = generatePrompt(files, allSrcFiles.join('\n'), testFiles);
+        contextFiles = await gpt.generateText({ prompt });
+    }
+    else {
+        const gitDiff = await (0, git_utils_1.getGitDiff)();
+        const changedFiles = extractChangedFiles(gitDiff);
+        const prompt = generatePrompt(changedFiles, allSrcFiles.join('\n'), testFiles, gitDiff);
+        contextFiles = await gpt.generateText({ prompt });
+    }
+    // Initialize variables
+    const lines = [];
+    const context = [];
+    // Read each line of the context files
+    contextFiles.split('\n').forEach((line) => {
+        if (line.trim()) {
+            lines.push(line.trim());
+        }
+    });
+    for (const codeFile of lines) {
+        if (await fs_1.promises?.stat(codeFile).then(stat => stat.isFile()).catch(() => false)) {
+            const fileContents = await fs_1.promises.readFile(codeFile, 'utf-8');
+            context.push(`### **Contents of ${codeFile}**\n\n${fileContents}\n\n### **End of ${codeFile}**`);
+        }
+    }
+    // Generate the message for unit test creation
+    let analysis = '';
+    if ((files || []).length > 0) {
+        const message = `please create unit tests for these files:
+
+## begin list of files
+${(files || []).join('\n')}
+## end list of files
+
+## context
+${context.join('\n\n')}`;
+        // Get the model and analysis using ClovingGPT
+        analysis = await gpt.generateText({ prompt: message });
+    }
+    else {
+        const message = `please create unit tests for these changes:
+
+## begin diff
+${await (0, git_utils_1.getGitDiff)()}
+## end diff
+
+## context
+
+${context.join('\n\n')}`;
+        // Get the model and analysis using ClovingGPT
+        analysis = await gpt.generateText({ prompt: message });
+    }
+    console.log((0, cli_highlight_1.default)(analysis));
+};
+exports.default = unitTests;

package/dist/commands/init.js

@@ -7,14 +7,14 @@ exports.init = void 0;
 const fs_1 = __importDefault(require("fs"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
-const string_utils_1 = require("../utils/string_utils");
 const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
 const ignore_1 = __importDefault(require("ignore"));
-const string_utils_2 = require("../utils/string_utils");
+const string_utils_1 = require("../utils/string_utils");
+const config_utils_1 = require("../utils/config_utils");
 const command_utils_1 = require("../utils/command_utils");
 // Main function for the describe command
 const init = async (options) => {
-    options.silent = (0, command_utils_1.getConfig)(options).silent || false;
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
     const gpt = new cloving_gpt_1.default(options);
     const specialFileContents = (0, command_utils_1.collectSpecialFileContents)();
     const specialFileNames = Object.keys(specialFileContents).map(file => ' - ' + file);
@@ -38,8 +38,8 @@ technologies used. This will provide better context for future Cloving requests.
       `);
         }
     }
-    const config = (0, command_utils_1.getConfig)(options);
-    if (!config || !config?.primaryModel || !config?.models) {
+    const config = (0, config_utils_1.getConfig)(options);
+    if (!config || !config?.models) {
         console.error('No cloving configuration found. Please run `cloving config`');
         return;
     }
@@ -128,7 +128,7 @@ interface DatabaseConfig {
   primary?: boolean
 }
 
-export interface ClovingGPTConfig {
+export interface ClovingfileConfig {
   languages: LanguageConfig[]
   frameworks: FrameworkConfig[]
   testingFrameworks?: TestingFrameworkConfig[]
@@ -201,13 +201,8 @@ Here is an example response:
   ],
   "projectType": "Command-line tool",
 }`;
-        if (process.env.DEBUG === '1') {
-            (0, string_utils_1.estimateTokens)(prompt).then(tokenCount => {
-                console.log(`Estimated token count: ${tokenCount}`);
-            });
-        }
         const aiChatResponse = await gpt.generateText({ prompt });
-        const cleanAiChatResponse = (0, string_utils_2.extractJsonMetadata)(aiChatResponse);
+        const cleanAiChatResponse = (0, string_utils_1.extractJsonMetadata)(aiChatResponse);
         fs_1.default.writeFileSync(tempFilePath, cleanAiChatResponse);
         // Save the AI chat response to cloving.json
         fs_1.default.writeFileSync('cloving.json', cleanAiChatResponse);