cloving 0.1.0

package/dist/commands/describe.js

@@ -0,0 +1,235 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.describe = void 0;
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const child_process_1 = require("child_process");
+const string_utils_1 = require("../utils/string_utils");
+const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
+const readline_1 = __importDefault(require("readline"));
+const ignore_1 = __importDefault(require("ignore"));
+// List of special files to check
+const specialFiles = [
+    'package.json',
+    'Gemfile',
+    'requirements.txt',
+    'Pipfile',
+    'pyproject.toml',
+    'pom.xml',
+    'build.gradle',
+    '.csproj',
+    'packages.config',
+    'composer.json',
+    'CMakeLists.txt',
+    'conanfile.txt',
+    'conanfile.py',
+    'go.mod',
+    'Cargo.toml',
+    'Package.swift',
+    'build.gradle.kts',
+    'Podfile',
+    'Cartfile',
+    'cpanfile',
+    'DESCRIPTION',
+    'mix.exs',
+    'build.sbt',
+    'pubspec.yaml',
+    'stack.yaml',
+    'cabal.project',
+    'Project.toml',
+    'rockspec',
+    'rebar.config',
+    'project.clj'
+];
+const runCommand = (command, args) => {
+    return new Promise((resolve, reject) => {
+        const process = (0, child_process_1.spawn)(command, args);
+        const output = [];
+        process.stdout.on('data', (data) => {
+            output.push(data.toString());
+        });
+        process.stderr.on('data', (data) => {
+            console.error(`stderr: ${data}`);
+        });
+        process.on('close', (code) => {
+            if (code !== 0) {
+                reject(new Error(`${command} process exited with code ${code}`));
+            }
+            else {
+                resolve(output.join('').trim().split('\n'));
+            }
+        });
+    });
+};
+const generateFileList = async () => {
+    try {
+        const lsOutput = await runCommand('ls', []);
+        const findOutput = await runCommand('find', ['.']);
+        const cleanedFindOutput = findOutput.map(file => file.startsWith('./') ? file.slice(2) : file);
+        const files = [...lsOutput, ...cleanedFindOutput];
+        const uniqueFiles = Array.from(new Set(files));
+        return uniqueFiles.filter(file => file && !file.includes('.git') && !file.includes('node_modules') && !file.includes('tmp'));
+    }
+    catch (error) {
+        console.error('Error generating file list:', error.message);
+        return [];
+    }
+};
+const collectSpecialFileContents = () => {
+    const specialFileContents = {};
+    for (const file of specialFiles) {
+        if (fs_1.default.existsSync(file)) {
+            try {
+                const content = fs_1.default.readFileSync(file, 'utf-8');
+                specialFileContents[file] = file.endsWith('.json') ? JSON.parse(content) : content;
+            }
+            catch (error) {
+                specialFileContents[file] = fs_1.default.readFileSync(file, 'utf-8');
+            }
+        }
+    }
+    return specialFileContents;
+};
+// Main function for the describe command
+const describe = async () => {
+    // Generate a temporary file path
+    const tempFilePath = path_1.default.join(os_1.default.tmpdir(), `describe_${Date.now()}.tmp`);
+    try {
+        // Read .gitignore and create ignore instance
+        const gitignorePath = path_1.default.join(process.cwd(), '.gitignore');
+        const ig = (0, ignore_1.default)();
+        if (fs_1.default.existsSync(gitignorePath)) {
+            const gitignoreContent = fs_1.default.readFileSync(gitignorePath, 'utf-8');
+            ig.add(gitignoreContent);
+        }
+        // Generate the file list excluding .git, node_modules and matching .gitignore patterns
+        const fileList = await generateFileList();
+        const filteredFileList = fileList.filter(file => {
+            try {
+                return !ig.ignores(file);
+            }
+            catch (error) {
+                return false;
+            }
+        });
+        // Limit the file list to the first 100 files
+        const limitedFileList = filteredFileList.slice(0, 100);
+        // Collect the contents of special files
+        const specialFileContents = collectSpecialFileContents();
+        // Generate the JSON object for the AI chat model
+        const projectDetails = {
+            files: limitedFileList,
+            specialFiles: specialFileContents
+        };
+        const prompt = `Here is a JSON object describing my project:
+${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 an example response:
+
+{
+  "languages": [
+    {
+      "name": "TypeScript",
+      "version": "~> 5.5.3"
+      "primary": true
+    },
+    {
+      "name": "JavaScript",
+      "version": "ES6+"
+    }
+  ],
+  "frameworks": [
+    {
+      "name": "Node.js",
+      "type": "Runtime environment",
+      "primary": true
+    }
+  ],
+  "testingFrameworks": [
+    {
+      "name": "Jest",
+      "type": "Testing framework",
+      "version": "29.7.0"
+      "directory": "tests"
+    },
+  ],
+  "buildTools": [
+    {
+      "name": "TypeScript Compiler (tsc)",
+      "type": "Transpiler"
+    },
+    {
+      "name": "Vite",
+      "type": "Build tool",
+      "version": "5.3.3"
+    }
+  ],
+  "packageManager": "Yarn",
+  "linters": [
+    {
+      "name": "ESLint",
+      "version": "9.6.0"
+    }
+  ],
+  "databases": [
+    {
+      "name": "MongoDB",
+      "version": "5.0.3",
+      "primary": true
+    }
+  ],
+  "projectType": "Command-line tool",
+}`;
+        // Estimate and print token count if DEBUG=1
+        if (process.env.DEBUG === '1') {
+            (0, string_utils_1.estimateTokens)(prompt).then(tokenCount => {
+                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 });
+        // Write the AI chat response to a temporary file
+        fs_1.default.writeFileSync(tempFilePath, aiChatResponse);
+        // Extract JSON metadata from the AI response
+        const jsonMetadata = (0, string_utils_1.extractJsonMetadata)(aiChatResponse);
+        if (jsonMetadata) {
+            console.log(jsonMetadata);
+        }
+        else {
+            console.log(aiChatResponse);
+        }
+        const response = jsonMetadata || aiChatResponse;
+        // Clean up
+        fs_1.default.unlinkSync(tempFilePath);
+        // Ask user if they want to save the result to cloving.json
+        const rl = readline_1.default.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        rl.question('Do you want to save this file to cloving.json to improve the context of future cloving requests? [Yn] ', (answer) => {
+            rl.close();
+            if (answer.toLowerCase() === 'y' || answer.trim() === '') {
+                fs_1.default.writeFileSync('cloving.json', response);
+                console.log('File saved to cloving.json');
+            }
+            else {
+                console.log('File not saved.');
+            }
+        });
+    }
+    catch (error) {
+        console.error('Error describing the project:', error.message);
+    }
+};
+exports.describe = describe;
+exports.default = exports.describe;

package/dist/commands/init.js

@@ -0,0 +1,169 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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 command_utils_1 = require("../utils/command_utils");
+// Main function for the describe command
+const init = async (options) => {
+    options.silent = (0, command_utils_1.getConfig)().silent || false;
+    const gpt = new cloving_gpt_1.default(options);
+    const specialFileContents = (0, command_utils_1.collectSpecialFileContents)();
+    const specialFileNames = Object.keys(specialFileContents).map(file => ' - ' + file);
+    if (!options.silent) {
+        if (specialFileNames.length > 0) {
+            console.log(`Cloving will analyze the list of files and the contents of the following files:
+
+  ${specialFileNames.join("\n")}
+
+  Cloving will send AI a request to summarize the technologies used in this project.
+
+  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.
+  `);
+        }
+        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.
+      `);
+        }
+    }
+    const config = (0, command_utils_1.getConfig)();
+    if (!config || !config?.primaryModel || !config?.models) {
+        console.error('No cloving configuration found. Please run `cloving config`');
+        return;
+    }
+    if (!(0, command_utils_1.checkForSpecialFiles)()) {
+        const continueAnswer = await (0, command_utils_1.promptUser)('No special files detected. Are you currently inside a software project\'s main directory? Do you want to continue analyzing this directory for the Cloving setup process? [Yn] ');
+        if (continueAnswer.toLowerCase() !== 'y' && continueAnswer.trim() !== '') {
+            console.log('Operation aborted by the user.');
+            return;
+        }
+    }
+    const tempFilePath = path_1.default.join(os_1.default.tmpdir(), `describe_${Date.now()}.tmp`);
+    try {
+        const gitignorePath = path_1.default.join(process.cwd(), '.gitignore');
+        const ig = (0, ignore_1.default)();
+        if (fs_1.default.existsSync(gitignorePath)) {
+            const gitignoreContent = fs_1.default.readFileSync(gitignorePath, 'utf-8');
+            ig.add(gitignoreContent);
+        }
+        const fileList = await (0, command_utils_1.generateFileList)();
+        const filteredFileList = fileList.filter(file => {
+            try {
+                return !ig.ignores(file);
+            }
+            catch (error) {
+                return false;
+            }
+        });
+        const limitedFileList = filteredFileList.slice(0, 100);
+        if (specialFileNames.length === 0) {
+            console.error('No special files found.');
+            return;
+        }
+        const projectDetails = {
+            files: limitedFileList,
+            specialFiles: specialFileContents
+        };
+        const prompt = `Here is a JSON object describing my project:
+${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 an example response:
+
+{
+  "languages": [
+    {
+      "name": "TypeScript",
+      "version": "~> 5.5.3"
+      "primary": true
+    },
+    {
+      "name": "JavaScript",
+      "version": "ES6+"
+    }
+  ],
+  "frameworks": [
+    {
+      "name": "Node.js",
+      "type": "Runtime environment",
+      "primary": true
+    }
+  ],
+  "testingFrameworks": [
+    {
+      "name": "Jest",
+      "type": "Testing framework",
+      "version": "29.7.0"
+      "directory": "tests"
+    },
+  ],
+  "buildTools": [
+    {
+      "name": "TypeScript Compiler (tsc)",
+      "type": "Transpiler"
+    },
+    {
+      "name": "Vite",
+      "type": "Build tool",
+      "version": "5.3.3"
+    }
+  ],
+  "packageManager": "Yarn",
+  "linters": [
+    {
+      "name": "ESLint",
+      "version": "9.6.0"
+    }
+  ],
+  "databases": [
+    {
+      "name": "MongoDB",
+      "version": "5.0.3",
+      "primary": true
+    }
+  ],
+  "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);
+        fs_1.default.writeFileSync(tempFilePath, cleanAiChatResponse);
+        // Save the AI chat response to cloving.json
+        fs_1.default.writeFileSync('cloving.json', cleanAiChatResponse);
+        console.log('[done] Project data saved to cloving.json');
+        // Prompt the user if they want to review the generated cloving.json
+        if (!options.silent) {
+            const reviewAnswer = await (0, command_utils_1.promptUser)('Do you want to review the generated data? [Yn] ');
+            if (reviewAnswer.toLowerCase() === 'y' || reviewAnswer.trim() === '') {
+                console.log(cleanAiChatResponse);
+            }
+        }
+        // Clean up
+        fs_1.default.unlinkSync(tempFilePath);
+    }
+    catch (error) {
+        console.error('Error describing the project:', error.message);
+    }
+};
+exports.init = init;
+exports.default = exports.init;

package/dist/commands/models.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// models.ts
+const claude_1 = require("../cloving_gpt/adapters/claude");
+const openai_1 = require("../cloving_gpt/adapters/openai");
+const ollama_1 = require("../cloving_gpt/adapters/ollama");
+const listModels = async () => {
+    try {
+        await ollama_1.OllamaAdapter.listSupportedModels();
+    }
+    catch (error) {
+        // do nothing, no ollama server running
+    }
+    claude_1.ClaudeAdapter.listSupportedModels();
+    openai_1.OpenAIAdapter.listSupportedModels();
+};
+exports.default = listModels;

package/dist/commands/review.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const readline_1 = __importDefault(require("readline"));
+const child_process_1 = require("child_process");
+const git_utils_1 = require("../utils/git_utils");
+const string_utils_1 = require("../utils/string_utils");
+const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
+const command_utils_1 = require("../utils/command_utils");
+const review = async (options) => {
+    options.silent = (0, command_utils_1.getConfig)().silent || 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
+        console.log(markdown);
+        // Prompt the user to copy the analysis to the clipboard
+        const rl = readline_1.default.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        rl.question('Do you want to copy the analysis to the clipboard? [Y/n] ', (answer) => {
+            if (answer.toLowerCase() === 'y' || answer === '') {
+                try {
+                    (0, child_process_1.execFileSync)('pbcopy', { input: markdown });
+                    console.log('Analysis copied to clipboard');
+                }
+                catch (error) {
+                    console.error('Error: pbcopy command not found. Unable to copy to clipboard.');
+                }
+            }
+            rl.close();
+        });
+    }
+    catch (error) {
+        console.error('Error during analysis:', error.message);
+    }
+};
+exports.default = review;

package/dist/commands/unit_tests.js

@@ -0,0 +1,119 @@
+"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 os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+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;
+};
+// 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:
+
+==== begin list of models ====
+${modelFiles}
+==== end list of models ====
+
+Here is a list of all my test files:
+
+==== begin list of 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:
+
+==== begin git diff ====
+${gitDiff}
+==== end git diff ====
+
+Give me this output format for your answer:
+
+## files
+
+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);
+        }
+        // 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);
+        }
+        // Generate the message for unit test creation
+        const message = `please create unit tests for these changes:
+
+${await (0, git_utils_1.getGitDiff)()}
+
+## 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);
+        // 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);
+    }
+};
+exports.default = unitTests;

package/dist/commands/update.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (options) => {
+    if (options.force)
+        console.log('Forced update');
+    console.log('Updating something...');
+};

package/dist/index.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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 models_1 = __importDefault(require("./commands/models"));
+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('commit')
+    .description('Generate a commit message and commit the changes')
+    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .action(commit_1.default);
+program
+    .command('unit-tests')
+    .description('Generate unit tests for the changes')
+    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .action(unit_tests_1.default);
+program
+    .command('models')
+    .description('List available models')
+    .action(models_1.default);
+program
+    .command('review')
+    .description('Review the changes and propose ')
+    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .action(review_1.default);
+program
+    .command('init')
+    .description('Setup cloving in the current project')
+    .option('-s, --silent', 'Run the command without asking for confirmation of submitting prompts')
+    .action(init_1.default);
+program
+    .command('config')
+    .description('Configure cloving with your API key and model')
+    .action(config_1.default);
+program.parse(process.argv);