cloving 0.1.15 → 0.1.16

package/README.md

@@ -1,17 +1,32 @@
-# Cloving CLI Documentation
+# Cloving - CLI Code Generation with AI
 
-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.
+Cloving CLI is a command line utility which integrates AI into your development workflow. It provides AI-powered code generation, commit message generation, code reviews, unit test generation, and more.
+
+What makes the Cloving CLI different from other AI tools is that it builds sophisticated context-aware prompts to generate code, commit messages, and more.
+
+Cloving gets to know your specific projects, the frameworks you use, the coding style you prefer, and the patterns you follow, and does its best to generate code that fits your existing project so that it actually works.
+
+It delivers usable code that you can save directly into your project instead of copying and pasting code snippets from chat interactions.
+
+**Read the [introduction announcement](https://cloving.ai/tutorials/introducing-the-cloving-cli).**
+
+> [!WARNING]
+>
+> This project is still in the early stages of development and is not yet stable.
+> Please use it with caution and [report any issues](https://github.com/cloving-ai/cloving-cli/issues) you encounter
 
 ## Features
 
+- **Context-aware AI code generation**
 - **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**
-- **Project initialization, planning, and building with AI assistance**
 - **Support for multiple AI models including OpenAI, Claude, and Ollama**
 
+## Important
+
+The cloving will ask you before submitting any prompt to the AI model. You can use the `-s` or `--silent` flag to run the command without asking for confirmation, but by default you will have the chance to review all prompts with all the context before submitting them. This is to ensure that you are aware of what is being sent to the AI model and can make any necessary changes before submitting the prompt.
+
 ## Prerequisites
 
 - Node.js (version 20 or higher)
@@ -91,13 +106,6 @@ Options:
 - `-s, --silent`: Run without asking for confirmation of submitting prompts
 - `-m, --model <model>`: Select the model to use
 
-### Listing Available Models
-
-List the available AI models:
-```bash
-cloving models
-```
-
 ### Generating Commit Messages
 
 Generate an AI-powered commit message:
@@ -112,17 +120,6 @@ Options:
 - `-s, --silent`: Run without asking for confirmation
 - `-m, --model <model>`: Select the model to use
 
-### Generating Unit Tests
-
-Generate unit tests for changes or specific files:
-```bash
-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
-
 ### Code Reviews
 
 Get an AI-powered code review:
@@ -147,15 +144,6 @@ Options:
 - `-p, --prompt <prompt>`: Specify the prompt to use
 - `-f, --files <filenames...>`: Specify filenames of files with context to use for generating code
 
-### Generating Context
-
-Create a context string for generating prompts outside of the cloving cli:
-```bash
-cloving generate context
-```
-Options:
-- `-f, --files <filenames...>`: Specify filenames of files with context
-
 ### Generating Shell Commands
 
 Generate a shell command based on a prompt:
@@ -171,6 +159,26 @@ Options:
 - `-m, --model <model>`: Select the model to use
 - `-p, --prompt <prompt>`: Specify the prompt to use
 
+### Generating Context
+
+Create a context string for generating prompts outside of the cloving cli:
+```bash
+cloving generate context
+```
+Options:
+- `-f, --files <filenames...>`: Specify filenames of files with context
+
+### Generating Unit Tests
+
+Generate unit tests for changes or specific files:
+```bash
+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
+
 ### Project Commands
 
 Cloving now includes commands for managing entire projects:

package/dist/cloving_gpt/adapters/openai.js

@@ -34,6 +34,7 @@ class OpenAIAdapter {
 exports.OpenAIAdapter = OpenAIAdapter;
 OpenAIAdapter.supportedModels = [
     'openai:gpt:4o',
+    'openai:gpt:4o-mini',
     'openai:gpt:4-turbo',
     'openai:gpt:3.5-turbo',
     'openai:text-embedding:3-large',

package/dist/commands/generate/unit_tests.js

@@ -23,7 +23,10 @@ const extractChangedFiles = (gitDiff) => {
 };
 const generatePrompt = (files, srcFiles, testFiles, gitDiff) => {
     const filesList = files.length > 0 ? files.join('\n') : 'No files provided';
-    return `### List of Code Files
+    return `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.
+
+### List of Code Files
 
 ${filesList}
 
@@ -35,13 +38,13 @@ ${srcFiles}
 
 ${testFiles}
 
-### Git Diff Content
+${gitDiff ? '### Git Diff Content' : ''}
 
-${gitDiff}
+${gitDiff || ''}
 
 ## Example Output
 
-Give me this output format for your answer:
+Here are the files that are relevant:
 
 \`\`\`plaintext
 ## files
@@ -55,14 +58,28 @@ test/models/foo_test.rb
 test/controllers/baz_controller_test.rb
 \`\`\`
 
-### Request
-
-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.
+### Prompt
 
+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.`;
 };
-const handleUserAction = async (analysis) => {
+const handleUserAction = async (analysis, autoSave = false) => {
     const [files, fileContents] = (0, string_utils_1.extractFilesAndContent)(analysis);
+    if (autoSave) {
+        for (const file of files) {
+            if (fileContents[file]) {
+                const filePath = path_1.default.resolve(file);
+                await fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
+                await fs_1.promises.writeFile(filePath, fileContents[file]);
+                console.log(`${file} has been saved.`);
+            }
+            else {
+                console.log(`File content not found for ${file}.`);
+            }
+        }
+        console.log('All unit test files have been saved.');
+        return;
+    }
     const { action } = await inquirer_1.default.prompt([
         {
             type: 'list',
@@ -91,10 +108,9 @@ const handleUserAction = async (analysis) => {
                 ]);
                 if (fileContents[fileToSave]) {
                     const filePath = path_1.default.resolve(fileToSave);
-                    fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true })
-                        .then(() => fs_1.promises.writeFile(filePath, fileContents[fileToSave]))
-                        .then(() => console.log(`${fileToSave} has been saved.`))
-                        .catch((error) => console.error(`Error saving ${fileToSave}:`, error));
+                    await fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
+                    await fs_1.promises.writeFile(filePath, fileContents[fileToSave]);
+                    console.log(`${fileToSave} has been saved.`);
                 }
                 else {
                     console.log('File content not found.');
@@ -114,10 +130,9 @@ const handleUserAction = async (analysis) => {
             for (const file of files) {
                 if (fileContents[file]) {
                     const filePath = path_1.default.resolve(file);
-                    fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true })
-                        .then(() => fs_1.promises.writeFile(filePath, fileContents[file]))
-                        .then(() => console.log(`${file} has been saved.`))
-                        .catch((error) => console.error(`Error saving ${file}:`, error));
+                    await fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
+                    await fs_1.promises.writeFile(filePath, fileContents[file]);
+                    console.log(`${file} has been saved.`);
                 }
                 else {
                     console.log(`File content not found for ${file}.`);
@@ -157,7 +172,7 @@ const handleUserAction = async (analysis) => {
     }
 };
 const unitTests = async (options) => {
-    const { files } = options;
+    const { files, save } = 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)();
@@ -168,15 +183,22 @@ const unitTests = async (options) => {
     const testFiles = (0, child_process_1.execFileSync)('find', [testingDirectory, '-type', 'f']).toString().trim();
     let contextFiles;
     if (files) {
+        console.log('Generating unit tests for the provided files...');
+        console.log('Gathering a list of files related to the changes...');
         const prompt = generatePrompt(files, allSrcFiles.join('\n'), testFiles);
         contextFiles = await gpt.generateText({ prompt });
     }
     else {
+        console.log('Generating unit tests for the git diff between this branch and the default branch...');
+        console.log('Gathering a list of files related to the changes...');
         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 });
     }
+    contextFiles = (0, string_utils_1.extractMarkdown)(contextFiles);
+    console.log(contextFiles);
+    console.log('\nBuilding the tests for these files...');
     // Initialize variables
     const lines = [];
     const context = [];
@@ -189,38 +211,121 @@ const unitTests = async (options) => {
     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}`);
+            context.push(`### Contents of **${codeFile}\n\n${fileContents.split('\n').map(line => `    ${line}`).join('\n')}**\n\n`);
         }
     }
     // Generate the message for unit test creation
     let analysis = '';
     if ((files || []).length > 0) {
-        const message = `please create unit tests for these files:
+        const message = `Create unit tests for the List of Files. Always show filenames for the generated code.
 
-## Begin list of files
+## List of Files
 ${(files || []).join('\n')}
-## End list of files
+
+## Example Response Structure
+
+Here are the unit tests for the provided list of files:
+
+1. **tests/utils/model_utils.test.ts**
+
+\`\`\`typescript
+import { getModel } from '../../src/utils/model_utils'
+
+describe('modelUtils', () => {
+  const originalEnv = process.env
+
+  beforeEach(() => {
+    jest.resetModules()
+    process.env = { ...originalEnv }
+  })
+
+  afterAll(() => {
+    process.env = originalEnv
+  })
+
+  test('getModel should return default model when CLOVING_MODEL is not set', () => {
+    delete process.env.CLOVING_MODEL
+    const result = getModel()
+    expect(result).toBe('claude:claude-3-5-sonnet-20240620')
+  })
+
+  test('getModel should return CLOVING_MODEL when it is set', () => {
+    process.env.CLOVING_MODEL = 'openai:gpt-4'
+    const result = getModel()
+    expect(result).toBe('openai:gpt-4')
+  })
+})
+\`\`\`
 
 ## Context
-${context.join('\n\n')}`;
+
+${context.join('\n\n')}
+
+## Prompt
+
+Create unit tests for the List of Files. Always show filenames for the generated code.`;
         // Get the model and analysis using ClovingGPT
         analysis = await gpt.generateText({ prompt: message });
     }
     else {
-        const message = `please create unit tests for these changes:
+        const message = `Create unit tests for the Code Diff. Always show filenames for the generated code.
+
+## Code Diff
 
-## Begin diff
 ${await (0, git_utils_1.getGitDiff)()}
-## End diff
 
 ## Context
 
-${context.join('\n\n')}`;
+${context.join('\n\n')}
+
+## Example Response Structure
+
+Here are the unit tests for the code diff:
+
+1. **tests/utils/model_utils.test.ts**
+
+\`\`\`typescript
+import { getModel } from '../../src/utils/model_utils'
+
+describe('modelUtils', () => {
+  const originalEnv = process.env
+
+  beforeEach(() => {
+    jest.resetModules()
+    process.env = { ...originalEnv }
+  })
+
+  afterAll(() => {
+    process.env = originalEnv
+  })
+
+  test('getModel should return default model when CLOVING_MODEL is not set', () => {
+    delete process.env.CLOVING_MODEL
+    const result = getModel()
+    expect(result).toBe('claude:claude-3-5-sonnet-20240620')
+  })
+
+  test('getModel should return CLOVING_MODEL when it is set', () => {
+    process.env.CLOVING_MODEL = 'openai:gpt-4'
+    const result = getModel()
+    expect(result).toBe('openai:gpt-4')
+  })
+})
+\`\`\`
+
+## Prompt
+
+Create unit tests for the Code Diff. Always show filenames for the generated code.`;
         // Get the model and analysis using ClovingGPT
         analysis = await gpt.generateText({ prompt: message });
     }
-    console.log((0, cli_highlight_1.default)(analysis));
+    if (analysis) {
+        console.log((0, cli_highlight_1.default)(analysis));
+    }
+    else {
+        console.log('No unit tests generated.');
+    }
     // Add the new user action handling
-    await handleUserAction(analysis);
+    await handleUserAction(analysis, save);
 };
 exports.default = unitTests;

package/dist/index.js

@@ -92,6 +92,7 @@ generate
     .command('unit-tests')
     .alias('u')
     .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('--save', 'Automatically save all files after generating the unit tests')
     .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)')

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloving",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/dist/utils/git_utils.js

@@ -20,7 +20,9 @@ const getGitDiff = async () => {
     try {
         const defaultBranchName = await (0, exports.getDefaultBranchName)();
         const gitDiff = (0, child_process_1.execSync)(`git diff ${defaultBranchName} --`).toString().trim();
-        return gitDiff;
+        // Indent each line by four spaces
+        const indentedDiff = gitDiff.split('\n').map(line => `    ${line}`).join('\n');
+        return indentedDiff;
     }
     catch (error) {
         console.error('Error getting git diff:', error.message);

package/dist/utils/string_utils.js

@@ -92,6 +92,8 @@ const parseMarkdownInstructions = (input) => {
 };
 exports.parseMarkdownInstructions = parseMarkdownInstructions;
 const extractFilesAndContent = (rawCodeCommand) => {
+    if (!rawCodeCommand)
+        return [[], {}];
     const files = [];
     const fileContents = {};
     const matches = rawCodeCommand.match(/(\*{2})([^\*]+)(\*{2})/g);
@@ -107,7 +109,7 @@ const extractFilesAndContent = (rawCodeCommand) => {
             let content = contentMatch[1];
             // Remove the first word after the opening triple backticks
             content = content.split('\n').map((line, idx) => idx === 0 ? line.replace(/^\w+\s*/, '') : line).join('\n');
-            fileContents[fileName] = content;
+            fileContents[fileName] = content.trim();
         }
     }
     return [files, fileContents];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloving",
-  "version": "0.1.15",
+  "version": "0.1.16",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {