cloving 0.1.4 → 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/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,10 +7,9 @@ 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
@@ -202,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);

package/dist/commands/project/build.js

@@ -0,0 +1,88 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildProject = void 0;
+const fs_1 = require("fs");
+const child_process_1 = require("child_process");
+const cli_highlight_1 = __importDefault(require("cli-highlight"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const cloving_gpt_1 = __importDefault(require("../../cloving_gpt"));
+const config_utils_1 = require("../../utils/config_utils");
+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 generatePrompt = async (projectName, projectTask, filesList, incompletePlanItem) => {
+    const context = [];
+    for (const codeFile of filesList) {
+        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}**`);
+        }
+    }
+    return `==== begin task description ====
+Task name: ${projectName}
+Task description: ${projectTask}
+==== end task description ====
+
+${context}
+
+Please implement the following plan item, please include full file path names in all code snippets:
+
+${incompletePlanItem}`;
+};
+const buildProject = async (options) => {
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+    const gpt = new cloving_gpt_1.default(options);
+    const projectName = (0, git_utils_1.getCurrentBranchName)();
+    const projectConfig = (0, config_utils_1.getProjectConfig)(projectName);
+    // Filter out completed plan items for selection
+    const planItems = Object.entries(projectConfig.plan || {});
+    if (planItems.length === 0) {
+        console.log('No plan items found.');
+        process.exit(1);
+    }
+    // Use inquirer to select a plan item
+    const { selectedPlanItemKey } = await inquirer_1.default.prompt([
+        {
+            type: 'list',
+            name: 'selectedPlanItemKey',
+            message: 'Select a plan item:',
+            choices: planItems.map(([key, item]) => ({ name: key, value: key })),
+        },
+    ]);
+    const selectedPlanItem = planItems.find(([key]) => key === selectedPlanItemKey);
+    if (!selectedPlanItem) {
+        console.log('Selected plan item not found.');
+        process.exit(1);
+    }
+    const planText = `## **${selectedPlanItem[0]}**\n\n${selectedPlanItem[1].details.join('\n\n')}`;
+    const prompt = await generatePrompt(projectName, projectConfig.task, projectConfig.files || [], planText);
+    const projectCode = await gpt.generateText({ prompt });
+    (0, string_utils_1.parseMarkdownInstructions)(projectCode).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 project to the clipboard
+    const answer = await (0, command_utils_1.promptUser)('Do you want to copy this project to the clipboard? [Y/n] ');
+    if (answer.toLowerCase() === 'y' || answer === '') {
+        try {
+            (0, child_process_1.execFileSync)('pbcopy', { input: projectCode });
+            console.log('Project copied to clipboard');
+        }
+        catch (error) {
+            console.error('Error: pbcopy command not found. Unable to copy to clipboard.');
+        }
+    }
+};
+exports.buildProject = buildProject;
+exports.default = exports.buildProject;

package/dist/commands/project/complete.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.completeProject = void 0;
+const config_utils_1 = require("../../utils/config_utils");
+const git_utils_1 = require("../../utils/git_utils");
+const completeProject = async (options) => {
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+    const projectName = (0, git_utils_1.getCurrentBranchName)();
+    (0, config_utils_1.removeProjectConfig)(projectName);
+};
+exports.completeProject = completeProject;
+exports.default = exports.completeProject;

package/dist/commands/project/init.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initProject = void 0;
+const fs_1 = require("fs");
+const cloving_gpt_1 = __importDefault(require("../../cloving_gpt"));
+const config_utils_1 = require("../../utils/config_utils");
+const command_utils_1 = require("../../utils/command_utils");
+const git_utils_1 = require("../../utils/git_utils");
+const config_utils_2 = require("../../utils/config_utils");
+const generatePrompt = async (projectName, projectTask) => {
+    const filesList = await (0, config_utils_2.getAllFiles)({}, false);
+    return `Here is a list of all my source files:
+
+==== begin list of source files ====
+${filesList.join("\n")}
+==== end list of source files ====
+
+Please enumerate all the files in the provided list that are pertinent for this task:
+
+==== begin task description ====
+Task name: ${projectName}
+Task description: ${projectTask}
+==== end task description ====
+
+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 initProject = async (options) => {
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+    const gpt = new cloving_gpt_1.default(options);
+    const defaultBranchName = await (0, git_utils_1.getDefaultBranchName)();
+    const projectName = (0, git_utils_1.getCurrentBranchName)();
+    if (projectName === defaultBranchName) {
+        console.log(`You are on the ${defaultBranchName} branch. Please checkout to a git branch and try again. For example: git branch -b my-new-project`);
+        process.exit(1);
+    }
+    const projectTask = await (0, command_utils_1.promptUser)('Describe the task you want to accomplish with this project: ');
+    const prompt = await generatePrompt(projectName, projectTask);
+    const contextFiles = await gpt.generateText({ prompt });
+    // Initialize variables
+    const lines = [];
+    const files = [];
+    // 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)) {
+            files.push(codeFile);
+        }
+    }
+    const projectConfig = {
+        name: projectName,
+        task: projectTask,
+        files
+    };
+    (0, config_utils_1.saveProjectConfig)(projectName, projectConfig);
+};
+exports.initProject = initProject;
+exports.default = exports.initProject;

package/dist/commands/project/plan.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.planProject = void 0;
+const fs_1 = require("fs");
+const cloving_gpt_1 = __importDefault(require("../../cloving_gpt"));
+const config_utils_1 = require("../../utils/config_utils");
+const git_utils_1 = require("../../utils/git_utils");
+const parsePlan = (plan) => {
+    const lines = plan.split('\n').map(line => line.trim());
+    const structured = {};
+    let currentTitle = null;
+    let currentDetails = [];
+    lines.forEach(line => {
+        const sectionMatch = line.match(/^#### \d+\. \*\*(.+)\*\*$/);
+        const detailMatch = line.match(/^-\s*\*\*(.+)\*\*:?\s*(.+)$/);
+        if (sectionMatch) {
+            if (currentTitle) {
+                structured[currentTitle] = {
+                    details: currentDetails
+                };
+            }
+            currentTitle = sectionMatch[1];
+            currentDetails = [];
+        }
+        else if (detailMatch && currentDetails) {
+            currentDetails.push(`${detailMatch[1]}: ${detailMatch[2]}`);
+        }
+        else if (currentDetails && line.startsWith('- ')) {
+            currentDetails.push(line.replace(/^- /, ''));
+        }
+    });
+    if (currentTitle) {
+        structured[currentTitle] = {
+            details: currentDetails
+        };
+    }
+    return structured;
+};
+const generatePrompt = async (projectName, projectTask, filesList) => {
+    const context = [];
+    for (const codeFile of filesList) {
+        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}**`);
+        }
+    }
+    return `==== begin task description ====
+Task name: ${projectName}
+Task description: ${projectTask}
+==== end task description ====
+
+${context}
+
+Please create a plan to execute this project. Do not include the Implementation Steps. Only include Plan for Project Execution.
+
+Here is an example plan. Do not use any of the information from this plan in your response, only use it as a template to create your own plan.
+
+==== begin example plan ====
+### Plan for Project Execution
+
+#### 1. **Understanding Existing Code**
+   - **Review existing command implementations**: Familiarize yourself with the structure and implementation style of existing commands such as project init and project plan.
+   - **Identify utility functions**: Note the utility functions being used across the commands, such as those in config_utils, git_utils, and command_utils.
+
+#### 2. **Design New Commands**
+   - **Define functionalities**: Clearly outline what each new command should accomplish:
+     - project build: This command should compile or prepare the project based on the planned actions.
+     - project complete: This command should finalize the project, possibly including cleanup, documentation, or deployment steps.
+
+#### 3. **Implement project build**
+   - **Create build.ts**: Implement the logic for building the project.
+     - **Generate prompt**: Create a prompt that describes the build process based on the project configuration.
+     - **Invoke AI Model**: Use an AI model to generate the steps or scripts needed to build the project.
+     - **Execute Build Steps**: Implement logic to execute the build steps.
+
+#### 4. **Implement project complete**
+   - **Create complete.ts**: Implement the logic for completing the project.
+     - **Generate prompt**: Create a prompt that describes the completion process based on the project configuration.
+     - **Invoke AI Model**: Use an AI model to generate the steps or scripts needed to complete the project.
+     - **Execute Completion Steps**: Implement logic to execute the completion steps.
+
+#### 5. **Integration and Testing**
+   - **Integrate new commands**: Ensure the new commands are integrated into the existing command structure.
+   - **Unit tests**: Develop unit tests for the new commands to ensure they function correctly.
+   - **End-to-end tests**: Run end-to-end tests to validate the entire workflow from project initialization to completion.
+
+#### 6. **Documentation and Cleanup**
+   - **Update README**: Document the new commands and their usage.
+   - **Code cleanup**: Refactor and clean up any redundant code or comments.
+==== end example plan ====`;
+};
+const planProject = async (options) => {
+    options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+    const gpt = new cloving_gpt_1.default(options);
+    const projectName = (0, git_utils_1.getCurrentBranchName)();
+    const projectConfig = (0, config_utils_1.getProjectConfig)(projectName);
+    const prompt = await generatePrompt(projectName, projectConfig.task, projectConfig.files || []);
+    const projectPlan = await gpt.generateText({ prompt });
+    const planItems = parsePlan(projectPlan);
+    console.log(planItems);
+    projectConfig.plan = planItems;
+    (0, config_utils_1.saveProjectConfig)(projectName, projectConfig);
+};
+exports.planProject = planProject;
+exports.default = exports.planProject;

package/dist/index.js

@@ -5,48 +5,82 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
-const commit_1 = __importDefault(require("./commands/commit"));
-const unit_tests_1 = __importDefault(require("./commands/unit_tests"));
-const review_1 = __importDefault(require("./commands/review"));
-const init_1 = __importDefault(require("./commands/init"));
 const config_1 = __importDefault(require("./commands/config"));
+const init_1 = __importDefault(require("./commands/init"));
 const models_1 = __importDefault(require("./commands/models"));
+const commit_1 = __importDefault(require("./commands/generate/commit"));
+const unit_tests_1 = __importDefault(require("./commands/generate/unit_tests"));
+const review_1 = __importDefault(require("./commands/generate/review"));
+const init_2 = __importDefault(require("./commands/project/init"));
+const plan_1 = __importDefault(require("./commands/project/plan"));
+const build_1 = __importDefault(require("./commands/project/build"));
+const complete_1 = __importDefault(require("./commands/project/complete"));
 const program = new commander_1.Command();
 program
     .name('cloving')
     .description('Integrate AI into your development workflow for generating commit messages, code reviews, and unit tests.')
     .version('1.0.0');
+program
+    .command('config')
+    .description('Configure cloving with your API key and models to use')
+    .action(config_1.default);
+program
+    .command('init')
+    .description('Setup cloving in the current directory')
+    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
+    .action(init_1.default);
+program
+    .command('models')
+    .description('List available models')
+    .action(models_1.default);
 program
+    .command('commit')
+    .description('Alias for cloving generate commit')
+    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
+    .action(commit_1.default);
+// Generate commands
+const generate = program
+    .command('generate')
+    .description('Generate various items like unit-tests and code reviews');
+generate
     .command('commit')
     .description('Generate a commit message and commit the changes')
     .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
     .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
     .action(commit_1.default);
-program
+generate
     .command('unit-tests')
     .description('Generate unit tests (if you don\'t specify filenames, it will generate tests for commited changes that differ from the main/master branch)')
     .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
     .option('-f, --files <filenames...>', 'Specify filenames for the unit tests')
     .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
     .action(unit_tests_1.default);
-program
-    .command('models')
-    .description('List available models')
-    .action(models_1.default);
-program
+generate
     .command('review')
     .description('Review the code for commited changes that differ from the main/master branch')
     .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
     .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
     .action(review_1.default);
-program
+// Project commands
+const project = program
+    .command('project')
+    .description('Commands for cloving a project');
+project
     .command('init')
-    .description('Setup cloving in the current project')
-    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
-    .option('-m, --model <model>', 'Select the model to use (e.g., openai, claude, ollama, ollama:llama3, claude:claude-3-5-sonnet-20240620)')
-    .action(init_1.default);
-program
-    .command('config')
-    .description('Configure cloving with your API key and models to use')
-    .action(config_1.default);
+    .description('Setup a new cloving project')
+    .action(init_2.default);
+project
+    .command('plan')
+    .description('Plan a cloving project')
+    .action(plan_1.default);
+project
+    .command('build')
+    .description('Build the next step in the project')
+    .action(build_1.default);
+project
+    .command('complete')
+    .description('Clean up and finalize the project')
+    .action(complete_1.default);
 program.parse(process.argv);

package/dist/utils/config_utils.js

@@ -3,13 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPrimaryModel = exports.saveConfig = exports.readClovingConfig = exports.getConfig = exports.CLOVINGFILE_PATH = exports.CLOVING_CONFIG_PATH = void 0;
+exports.getTestingDirectory = exports.getAllFiles = exports.removeProjectConfig = exports.saveProjectConfig = exports.getProjectConfig = exports.getPrimaryModel = exports.saveConfig = exports.readClovingConfig = exports.getConfig = exports.CLOVINGPROJECT_PATH = exports.CLOVINGFILE_PATH = exports.CLOVING_CONFIG_PATH = void 0;
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const ini_1 = __importDefault(require("ini"));
+const child_process_1 = require("child_process");
+const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
 exports.CLOVING_CONFIG_PATH = path_1.default.join(os_1.default.homedir(), '.clovingconfig');
 exports.CLOVINGFILE_PATH = 'cloving.json';
+exports.CLOVINGPROJECT_PATH = '.clovingprojects';
+let clovingConfig;
 const getConfig = (options) => {
     try {
         if (fs_1.default.existsSync(exports.CLOVING_CONFIG_PATH)) {
@@ -48,12 +52,16 @@ const getConfig = (options) => {
 };
 exports.getConfig = getConfig;
 const readClovingConfig = () => {
-    if (fs_1.default.existsSync(exports.CLOVINGFILE_PATH)) {
+    if (clovingConfig) {
+        return clovingConfig;
+    }
+    else if (fs_1.default.existsSync(exports.CLOVINGFILE_PATH)) {
         const configFile = fs_1.default.readFileSync(exports.CLOVINGFILE_PATH, 'utf-8');
-        return ini_1.default.parse(configFile);
+        clovingConfig = JSON.parse(configFile);
+        return clovingConfig;
     }
     else {
-        throw new Error('cloving.ini file not found');
+        throw new Error(`${exports.CLOVING_CONFIG_PATH} file not found`);
     }
 };
 exports.readClovingConfig = readClovingConfig;
@@ -87,3 +95,74 @@ const getPrimaryModel = (partialModel) => {
     }
 };
 exports.getPrimaryModel = getPrimaryModel;
+const getProjectConfig = (name) => {
+    const projectConfigPath = path_1.default.join(exports.CLOVINGPROJECT_PATH, name, 'config.ini');
+    if (fs_1.default.existsSync(projectConfigPath)) {
+        const configFile = fs_1.default.readFileSync(projectConfigPath, 'utf-8');
+        return ini_1.default.parse(configFile);
+    }
+    else {
+        throw new Error(`${projectConfigPath} file not found`);
+    }
+};
+exports.getProjectConfig = getProjectConfig;
+const saveProjectConfig = (name, config) => {
+    const projectConfigPath = path_1.default.join(exports.CLOVINGPROJECT_PATH, name, 'config.ini');
+    const projectConfigDir = path_1.default.dirname(projectConfigPath);
+    // Create directory if it doesn't exist
+    if (!fs_1.default.existsSync(projectConfigDir)) {
+        fs_1.default.mkdirSync(projectConfigDir, { recursive: true });
+    }
+    const iniString = ini_1.default.stringify(config);
+    fs_1.default.writeFileSync(projectConfigPath, iniString);
+    console.log(`Configuration saved to ${projectConfigPath}`);
+};
+exports.saveProjectConfig = saveProjectConfig;
+const removeProjectConfig = (name) => {
+    const projectConfigPath = path_1.default.join(exports.CLOVINGPROJECT_PATH, name, 'config.ini');
+    if (fs_1.default.existsSync(projectConfigPath)) {
+        fs_1.default.unlinkSync(projectConfigPath);
+        console.log(`Project completed and file removed: ${projectConfigPath}`);
+    }
+    else {
+        console.error(`Configuration not found: ${projectConfigPath}`);
+    }
+};
+exports.removeProjectConfig = removeProjectConfig;
+const setupTestingPrompt = async (gpt, config) => {
+    const prompt = `I have the following cloving.json configuration file:
+
+==== begin cloving.json ====
+${JSON.stringify(config, null, 2)}
+==== end cloving.json ====
+
+Please provide instructions on how to set up testing for this project.`;
+    const setupInstructions = await gpt.generateText({ prompt });
+    console.log(setupInstructions);
+    process.exit(0);
+};
+const getAllFiles = async (options, forTesting) => {
+    const gpt = new cloving_gpt_1.default(options);
+    // Read the cloving.json file
+    const config = (0, exports.readClovingConfig)();
+    const testingDirectory = (0, exports.getTestingDirectory)();
+    let allSrcFiles = [];
+    if (forTesting && !testingDirectory) {
+        await setupTestingPrompt(gpt, config);
+    }
+    // Collect srcFiles for each language with specified directory and extension
+    for (const language of config.languages) {
+        if (language.directory && language.extension) {
+            const srcFiles = (0, child_process_1.execFileSync)('find', [language.directory, '-type', 'f', '-name', `*${language.extension}`]).toString().trim().split('\n');
+            allSrcFiles = allSrcFiles.concat(srcFiles);
+        }
+    }
+    // Ensure allSrcFiles is unique
+    return Array.from(new Set(allSrcFiles));
+};
+exports.getAllFiles = getAllFiles;
+const getTestingDirectory = () => {
+    const config = (0, exports.readClovingConfig)();
+    return config.testingFrameworks?.find((framework) => framework.directory)?.directory;
+};
+exports.getTestingDirectory = getTestingDirectory;

package/dist/utils/git_utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGitDiff = exports.generateCommitMessagePrompt = void 0;
+exports.getCurrentBranchName = exports.getDefaultBranchName = exports.getGitDiff = exports.generateCommitMessagePrompt = void 0;
 const child_process_1 = require("child_process");
 const readline_1 = __importDefault(require("readline"));
 const askQuestion = (question) => {
@@ -39,27 +39,8 @@ ${diff}`;
 exports.generateCommitMessagePrompt = generateCommitMessagePrompt;
 const getGitDiff = async () => {
     try {
-        let mainBranchName;
-        mainBranchName = (0, child_process_1.execSync)('git symbolic-ref refs/remotes/origin/HEAD | sed \'s@^refs/remotes/origin/@@\'')
-            .toString()
-            .trim();
-        if (mainBranchName === '') {
-            console.error('Could not determine the default branch.');
-            const answer = await askQuestion('Do you want to run `git remote set-head origin -a`? [Y/n] ');
-            if (answer.toLowerCase() === 'y' || answer === '') {
-                (0, child_process_1.execSync)('git remote set-head origin -a');
-                mainBranchName = (0, child_process_1.execSync)('git symbolic-ref refs/remotes/origin/HEAD | sed \'s@^refs/remotes/origin/@@\'')
-                    .toString()
-                    .trim();
-                if (mainBranchName === '') {
-                    throw new Error('Error: Could not determine the default branch (main or master)');
-                }
-            }
-            else {
-                throw new Error('Operation aborted by user.');
-            }
-        }
-        const gitDiff = (0, child_process_1.execSync)(`git diff ${mainBranchName} --`).toString().trim();
+        const defaultBranchName = await (0, exports.getDefaultBranchName)();
+        const gitDiff = (0, child_process_1.execSync)(`git diff ${defaultBranchName} --`).toString().trim();
         return gitDiff;
     }
     catch (error) {
@@ -68,3 +49,34 @@ const getGitDiff = async () => {
     }
 };
 exports.getGitDiff = getGitDiff;
+const getDefaultBranchName = async () => {
+    let defaultBranchName = (0, child_process_1.execSync)('git symbolic-ref refs/remotes/origin/HEAD | sed \'s@^refs/remotes/origin/@@\'')
+        .toString()
+        .trim();
+    if (defaultBranchName === '') {
+        console.error('Could not determine the default branch.');
+        const answer = await askQuestion('Do you want to run `git remote set-head origin -a`? [Y/n] ');
+        if (answer.toLowerCase() === 'y' || answer === '') {
+            (0, child_process_1.execSync)('git remote set-head origin -a');
+            defaultBranchName = await (0, exports.getDefaultBranchName)();
+            if (defaultBranchName === '') {
+                throw new Error('Error: Could not determine the default branch (main or master)');
+            }
+        }
+        else {
+            throw new Error('Operation aborted by user.');
+        }
+    }
+    return defaultBranchName;
+};
+exports.getDefaultBranchName = getDefaultBranchName;
+const getCurrentBranchName = () => {
+    try {
+        return (0, child_process_1.execSync)('git rev-parse --abbrev-ref HEAD').toString().trim();
+    }
+    catch (error) {
+        console.error('Error getting current branch name:', error.message);
+        process.exit(1);
+    }
+};
+exports.getCurrentBranchName = getCurrentBranchName;

package/dist/utils/string_utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractMarkdown = exports.extractJsonMetadata = exports.estimateTokens = void 0;
+exports.parseMarkdownInstructions = exports.extractMarkdown = exports.extractJsonMetadata = exports.estimateTokens = void 0;
 // Function to estimate token count
 const estimateTokens = async (text) => {
     const charCount = text.length;
@@ -61,3 +61,38 @@ const extractMarkdown = (response) => {
     return markdownString;
 };
 exports.extractMarkdown = extractMarkdown;
+const parseMarkdownInstructions = (input) => {
+    const lines = input.split('\n');
+    const result = [];
+    let buffer = [];
+    let inCodeBlock = false;
+    lines.forEach(line => {
+        if (line.trim().startsWith('```')) {
+            if (inCodeBlock) {
+                // End of code block
+                buffer.push(line);
+                result.push(buffer.join('\n'));
+                buffer = [];
+                inCodeBlock = false;
+            }
+            else {
+                // Start of code block
+                if (buffer.length > 0) {
+                    result.push(buffer.join('\n'));
+                    buffer = [];
+                }
+                buffer.push(line);
+                inCodeBlock = true;
+            }
+        }
+        else {
+            buffer.push(line);
+        }
+    });
+    // If buffer has any remaining lines, add them to the result
+    if (buffer.length > 0) {
+        result.push(buffer.join('\n'));
+    }
+    return result;
+};
+exports.parseMarkdownInstructions = parseMarkdownInstructions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloving",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -38,6 +38,7 @@
   },
   "dependencies": {
     "axios": "^1.7.2",
+    "cli-highlight": "^2.1.11",
     "commander": "^12.1.0",
     "eslint": "^9.6.0",
     "eslint-config-prettier": "^9.1.0",
@@ -49,6 +50,7 @@
     "eslint-plugin-promise": "^6.4.0",
     "ignore": "^5.3.1",
     "ini": "^4.1.3",
+    "inquirer": "^10.0.1",
     "nock": "^13.5.4",
     "vite": "^5.3.3",
     "vite-node": "^2.0.1"