cloving 0.1.1 → 0.1.3

package/README.md

@@ -20,7 +20,7 @@ Cloving is an innovative tool designed to seamlessly integrate AI into various a
 
 1. Clone this repository:
    ```bash
-   git clone https://github.com/clovingai/cloving-cli.git
+   git clone https://github.com/cloving-ai/cloving-cli.git
    ```
 
 2. Navigate to the project directory:
@@ -28,15 +28,15 @@ Cloving is an innovative tool designed to seamlessly integrate AI into various a
    cd cloving-cli
    ```
 
-3. Install dependencies:
+3. Install dependencies and link the package:
    ```bash
    yarn install
+   yarn link
    ```
 
-4. Set up your AI chat model environment variables:
+4. Configure Cloving with your API key and model:
    ```bash
-   export CLOVING_MODEL=your_preferred_model
-   export CLOVING_API_KEY=your_api_key
+   cloving config
    ```
 
 ## Usage

package/dist/cloving_gpt/index.js

@@ -58,7 +58,7 @@ class ClovingGPT {
                     less.stdin.end();
                     less.on('close', (code) => {
                         if (code !== 0) {
-                            console.error('less command exited with an error.');
+                            console.error('less command exited with an error');
                             resolve(false);
                             return;
                         }
@@ -69,7 +69,13 @@ class ClovingGPT {
                         rlConfirm.question('Do you still want to continue? [Yn]: ', (confirmAnswer) => {
                             rlConfirm.close();
                             confirmAnswer = confirmAnswer.trim().toLowerCase();
-                            resolve(confirmAnswer === 'y' || confirmAnswer === '');
+                            if (confirmAnswer !== 'y' && confirmAnswer !== '') {
+                                console.error('User cancelled the operation');
+                                process_1.default.exit(1);
+                            }
+                            else {
+                                resolve(true);
+                            }
                         });
                     });
                     less.stdin.on('error', (err) => {

package/dist/commands/config.js

@@ -18,8 +18,7 @@ const config = async () => {
         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.');
+        if (isNaN(modelIndex) || modelIndex < 0 || modelIndex >= models.length) {
             throw new Error('Invalid selection');
         }
         const selectedModel = models[modelIndex];

package/dist/commands/init.js

@@ -22,19 +22,19 @@ const init = async (options) => {
         if (specialFileNames.length > 0) {
             console.log(`Cloving will analyze the list of files and the contents of the following files:
 
-  ${specialFileNames.join("\n")}
+${specialFileNames.join("\n")}
 
-  Cloving will send AI a request to summarize the technologies used in this project.
+Cloving will send AI a request to summarize the technologies used in this project.
 
-  This will provide better context for future Cloving requests.
+This will provide better context for future Cloving requests.
 
-  For increased privacy, you can run \`cloving config\` and make sure to configure a local ollama model (llama3:70b-instruct currently works well for this) so that this data is not sent to an AI service provider.
+For increased privacy, you can run \`cloving config\` and make sure to configure a local ollama model (llama3:70b-instruct currently works well for this) so that this data is not sent to an AI service provider.
   `);
         }
         else {
             console.log(`
-  This script will analyze the list of files in the current directory using GPT to summarize the
-  technologies used. This will provide better context for future Cloving requests.
+This script will analyze the list of files in the current directory using GPT to summarize the
+technologies used. This will provide better context for future Cloving requests.
       `);
         }
     }
@@ -80,10 +80,65 @@ const init = async (options) => {
 ${JSON.stringify(projectDetails, null, 2)}
 
 Please return JSON-formatted metadata about the project, including:
+
 - The programming language(s) used
 - The detected framework(s) (if any)
 - The version of the language(s)
 
+Here is a typescript interface for the expected response:
+
+interface LanguageConfig {
+  name: string
+  version?: string
+  primary?: boolean
+  directory: string
+  extension: string
+}
+
+interface FrameworkConfig {
+  name: string
+  type: string
+  version?: string
+  primary?: boolean
+  directory?: string
+  extension?: string
+}
+
+interface TestingFrameworkConfig {
+  name: string
+  type: string
+  version?: string
+  directory?: string
+}
+
+interface BuildToolConfig {
+  name: string
+  type: string
+  version?: string
+}
+
+interface LinterConfig {
+  name: string
+  version?: string
+  type?: string
+}
+
+interface DatabaseConfig {
+  name: string
+  primary?: boolean
+}
+
+export interface ClovingGPTConfig {
+  languages: LanguageConfig[]
+  frameworks: FrameworkConfig[]
+  testingFrameworks?: TestingFrameworkConfig[]
+  buildTools: BuildToolConfig[]
+  packageManager: string
+  linters: LinterConfig[]
+  databases?: DatabaseConfig[]
+  projectType: string
+}
+
 Here is an example response:
 
 {
@@ -91,18 +146,24 @@ Here is an example response:
     {
       "name": "TypeScript",
       "version": "~> 5.5.3"
-      "primary": true
+      "primary": true,
+      "directory": "src",
+      "extension": ".ts"
     },
     {
       "name": "JavaScript",
-      "version": "ES6+"
+      "version": "ES6+",
+      "directory": "src",
+      "extension": ".js"
     }
   ],
   "frameworks": [
     {
       "name": "Node.js",
       "type": "Runtime environment",
-      "primary": true
+      "primary": true,
+      "directory": "src",
+      "extension": ".js"
     }
   ],
   "testingFrameworks": [

package/dist/commands/unit_tests.js

@@ -3,33 +3,46 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
+const fs_1 = require("fs");
 const child_process_1 = require("child_process");
 const git_utils_1 = require("../utils/git_utils");
 const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
-// Function to estimate token count
-const estimateTokens = async (text) => {
-    const charCount = text.length;
-    const tokenCount = Math.ceil(charCount / 4);
-    return tokenCount;
+const command_utils_1 = require("../utils/command_utils");
+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);
 };
-// Main function for the unit_tests command
-const unitTests = async (options) => {
-    const gpt = new cloving_gpt_1.default(options);
-    // Generate a temporary file path
-    const tempFilePath = path_1.default.join(os_1.default.tmpdir(), `unit_tests_${Date.now()}.tmp`);
-    try {
-        // Generate the prompt for the AI chat model
-        const gitDiff = await (0, git_utils_1.getGitDiff)();
-        const modelFiles = (0, child_process_1.execFileSync)('find', ['app/models', '-type', 'f']).toString().trim();
-        const testFiles = (0, child_process_1.execFileSync)('find', ['spec', '-type', 'f']).toString().trim();
-        const prompt = `Here is a list of all my model files:
+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 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 ====
 
-==== begin list of models ====
-${modelFiles}
-==== end list of models ====
+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:
 
@@ -37,12 +50,11 @@ Here is a list of all my test files:
 ${testFiles}
 ==== end list of test files ====
 
-Please enumerate all the files in this git diff as well as the file names of any models that
-this code interacts with. Also, list any test files that might be relevant to these changes:
+${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.
 
-==== begin git diff ====
-${gitDiff}
-==== end git diff ====
+Also, list any test files that might be relevant to these files.
 
 Give me this output format for your answer:
 
@@ -51,69 +63,88 @@ Give me this output format for your answer:
 app/models/foo.rb
 app/views/baz/bar.html.erb
 
-## interacted models
-
-app/models/pop.rb
-
 ## relevant test files
 
 test/models/foo_test.rb
 test/controllers/baz_controller_test.rb`;
-        // Estimate and print token count
-        let tokenCount = await estimateTokens(prompt);
-        console.log(`Estimated token count: ${tokenCount}`);
-        // Instantiate ClovingGPT and get the AI chat response
-        const gpt = new cloving_gpt_1.default();
-        const aiChatResponse = await gpt.generateText({ prompt });
-        fs_1.default.writeFileSync(tempFilePath, aiChatResponse);
-        // Handle "files" argument
-        if (process.argv.includes('files')) {
-            console.log(aiChatResponse);
-            fs_1.default.unlinkSync(tempFilePath);
-            process.exit(0);
+};
+const unitTests = async (options) => {
+    const { files } = options;
+    const gpt = new cloving_gpt_1.default(options);
+    // Read the cloving.json file
+    const config = (0, command_utils_1.readClovingConfig)();
+    const testingDirectory = config.testingFrameworks?.find((framework) => framework.directory)?.directory;
+    if (!testingDirectory) {
+        await setupTestingPrompt(gpt, config);
+    }
+    let allSrcFiles = [];
+    // 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
+    allSrcFiles = Array.from(new Set(allSrcFiles));
+    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 input from temporary file
+    contextFiles.split('\n').forEach((line) => {
+        if (line.trim()) {
+            lines.push(line.trim());
         }
-        // Initialize variables
-        const lines = [];
-        // Read input from temporary file
-        const fileContent = fs_1.default.readFileSync(tempFilePath, 'utf-8');
-        fileContent.split('\n').forEach((line) => {
-            if (line.trim()) {
-                lines.push(line.trim());
-            }
-        });
-        // Generate output
-        fs_1.default.writeFileSync(tempFilePath, '## files\n\n');
-        lines.forEach((line) => {
-            if (fs_1.default.existsSync(line) && fs_1.default.statSync(line).isFile()) {
-                const fileContents = fs_1.default.readFileSync(line, 'utf-8');
-                fs_1.default.appendFileSync(tempFilePath, `### **Contents of ${line}**\n\n${fileContents}\n\n`);
-            }
-        });
-        // Handle "code" argument
-        if (process.argv.includes('code')) {
-            console.log(fs_1.default.readFileSync(tempFilePath, 'utf-8'));
-            fs_1.default.unlinkSync(tempFilePath);
-            process.exit(0);
+    });
+    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
+    }
+    // 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
 
-${fs_1.default.readFileSync(tempFilePath, 'utf-8')}`;
-        tokenCount = await estimateTokens(message);
-        console.log(`Estimated token count: ${tokenCount}`);
-        // Clean up
-        fs_1.default.unlinkSync(tempFilePath);
+${context.join('\n\n')}`;
         // Get the model and analysis using ClovingGPT
-        const analysis = await gpt.generateText({ prompt: message });
-        // Print the output
-        console.log(analysis);
-    }
-    catch (error) {
-        console.error('Error processing unit tests:', error.message);
+        analysis = await gpt.generateText({ prompt: message });
     }
+    console.log(analysis);
 };
 exports.default = unitTests;

package/dist/index.js

@@ -25,6 +25,7 @@ program
     .command('unit-tests')
     .description('Generate unit tests for the changes')
     .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .option('-f, --files <filenames...>', 'Specify filenames for the unit tests')
     .action(unit_tests_1.default);
 program
     .command('models')

package/dist/utils/command_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.getConfig = exports.saveConfig = exports.fetchModels = exports.promptUser = exports.runCommand = exports.generateFileList = exports.checkForSpecialFiles = exports.collectSpecialFileContents = exports.SPECIAL_FILES = exports.CONFIG_PATH = void 0;
+exports.readClovingConfig = exports.getConfig = exports.saveConfig = exports.fetchModels = exports.promptUser = exports.runCommand = exports.generateFileList = exports.checkForSpecialFiles = exports.collectSpecialFileContents = exports.SPECIAL_FILES = exports.CONFIG_PATH = void 0;
 const child_process_1 = require("child_process");
 const readline_1 = __importDefault(require("readline"));
 const fs_1 = __importDefault(require("fs"));
@@ -155,3 +155,14 @@ const getConfig = (options) => {
     }
 };
 exports.getConfig = getConfig;
+const readClovingConfig = () => {
+    const configPath = path_1.default.resolve(process.cwd(), 'cloving.json');
+    if (fs_1.default.existsSync(configPath)) {
+        const configFile = fs_1.default.readFileSync(configPath, 'utf-8');
+        return JSON.parse(configFile);
+    }
+    else {
+        throw new Error('cloving.json file not found');
+    }
+};
+exports.readClovingConfig = readClovingConfig;

package/package.json

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