cloving 0.3.4 → 0.3.6

package/dist/utils/prompt_utils.js

@@ -0,0 +1,515 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addFileOrDirectoryToContext = exports.readFileContent = exports.fetchModels = exports.runCommand = exports.generateFileList = exports.getAllFilesInDirectory = exports.checkForSpecialFiles = exports.collectSpecialFileContents = exports.generateShellPrompt = exports.generateCodegenPrompt = exports.getPackageVersion = exports.SPECIAL_FILES = exports.INIT_INSTRUCTIONS = exports.CODEGEN_INSTRUCTIONS = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const child_process_1 = require("child_process");
+const isbinaryfile_1 = require("isbinaryfile");
+const colors_1 = __importDefault(require("colors"));
+const path_2 = require("path");
+const config_utils_1 = require("./config_utils");
+exports.CODEGEN_INSTRUCTIONS = `## AI Code Generation Instructions
+
+### General Guidelines
+
+1. **Respond as an expert software developer.**
+2. **Follow best practices and the latest standards found in the **Description of App** section.**
+3. **Adhere to existing conventions and libraries in the codebase.**
+
+### Request Handling
+
+1. **Try to understand the request, but if anything is unclear, ask questions.**
+2. **Decide if you need to propose edits to existing files not in the chat.**
+   - If yes, provide the full path names and ask the user to add them.
+   - Wait for user approval before proceeding.
+3. **Propose changes using *CURRENT/NEW* Blocks.**
+4. **Show the smallest possible *CURRENT* section that uniquely identifies the code.**
+5. **To move code, use two *CURRENT/NEW* blocks: one to remove and one to add.**
+6. **For new files or to replace an existing file, the *CURRENT* block is empty.**
+
+### *CURRENT/NEW* Block Format
+
+1. **Start a block with three backticks and the language name.**
+   \`\`\`typescript
+2. **Next line: seven <, CURRENT, and the file path.**
+   <<<<<<< CURRENT path/to/file.ts
+3. **Include the exact existing code to be changed.**
+4. **Divide with seven =.**
+   =======
+5. **Add the new code.**
+6. **End with seven > and NEW.**
+   >>>>>>> NEW
+7. **Close the block with three backticks.**
+   \`\`\``;
+exports.INIT_INSTRUCTIONS = `You are an AI assistant helping to initialize a project by analyzing its structure and technologies.
+
+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
+  runCommand?: 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 ClovingfileConfig {
+  languages: LanguageConfig[]
+  frameworks: FrameworkConfig[]
+  testingFrameworks?: TestingFrameworkConfig[]
+  buildTools: BuildToolConfig[]
+  packageManager: string
+  linters: LinterConfig[]
+  databases?: DatabaseConfig[]
+  projectType: string
+}
+
+Here is an example response:
+
+{
+  "languages": [
+    {
+      "name": "TypeScript",
+      "version": "~> 5.5.3"
+      "primary": true,
+      "directory": "src",
+      "extension": ".ts"
+    },
+    {
+      "name": "JavaScript",
+      "version": "ES6+",
+      "directory": "src",
+      "extension": ".js"
+    }
+  ],
+  "frameworks": [
+    {
+      "name": "Node.js",
+      "type": "Runtime environment",
+      "primary": true,
+      "directory": "src",
+      "extension": ".js"
+    }
+  ],
+  "testingFrameworks": [
+    {
+      "name": "Jest",
+      "type": "Testing framework",
+      "version": "29.7.0"
+      "directory": "tests"
+      "runCommand": "yarn test"
+    },
+  ],
+  "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",
+}`;
+exports.SPECIAL_FILES = [
+    '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',
+    'top.sls',
+    'requirements.yml',
+    'terraform.tf',
+    'versions.tf',
+    'main.yml',
+    'cabal.project',
+    'Project.toml',
+    'rockspec',
+    'rebar.config',
+    'project.clj',
+    'tsconfig.json',
+    '.eslintrc.js',
+    '.eslintrc.json',
+    '.eslintrc.yaml',
+    '.eslintrc.yml',
+    '.eslintrc',
+    '.prettierrc',
+    '.prettierrc.js',
+    '.prettierrc.json',
+    '.prettierrc.yaml',
+    '.prettierrc.yml',
+    '.prettierrc',
+    '.stylelintrc',
+    '.stylelintrc.json',
+    '.stylelintrc.yaml',
+    '.stylelintrc.yml',
+    '.stylelintrc',
+    'jest.config.js',
+    'jest.config.json',
+    'jest.config.ts',
+    'jest.config.cjs',
+    'jest.config.mjs',
+    'webpack.config.js',
+    'webpack.config.ts',
+    'webpack.config.cjs',
+    'webpack.config.mjs',
+    'webpack.config.common.js',
+];
+const getPackageVersion = () => {
+    const packagePath = (0, path_2.join)(__dirname, '..', 'package.json');
+    const packageJson = JSON.parse(fs_1.default.readFileSync(packagePath, 'utf8'));
+    return packageJson.version;
+};
+exports.getPackageVersion = getPackageVersion;
+const renderAsString = (contextFile) => {
+    if (typeof contextFile === 'string') {
+        return contextFile;
+    }
+    return JSON.stringify(contextFile, null, 2);
+};
+const generateCodegenPrompt = (contextFilesContent) => {
+    const specialFileContents = (0, exports.collectSpecialFileContents)();
+    // detect if specialFileContents[file] is a string or an object
+    const specialFiles = Object.keys(specialFileContents)
+        .map((file) => `### Contents of **${file}**\n\n\`\`\`\n${renderAsString(specialFileContents[file])}\n\`\`\`\n\n`)
+        .join('\n');
+    const contextFileContents = Object.keys(contextFilesContent)
+        .map((file) => `### Contents of **${file}**\n\n\`\`\`\n${contextFilesContent[file]}\n\`\`\`\n\n`)
+        .join('\n');
+    const prompt = `${exports.CODEGEN_INSTRUCTIONS}
+
+## Description of App
+
+\`\`\`json
+${JSON.stringify((0, config_utils_1.getClovingConfig)(), null, 2)}
+\`\`\`
+
+## Special Files
+
+${specialFiles.length > 0 ? specialFiles : 'No special files provided.'}
+
+## Context Files
+
+${contextFileContents.length > 0 ? contextFileContents : 'No context files provided.'}
+
+## Directory structure
+
+${Object.keys(contextFilesContent).join('\n')}
+
+${exports.CODEGEN_INSTRUCTIONS}
+
+### Example 1: Changing a Variable
+
+\`\`\`typescript
+<<<<<<< CURRENT path/to/file.ts
+const myVariable = 'exact'
+const oldVariable = 1
+=======
+const myVariable = 'exact'
+const newVariable = 2
+>>>>>>> NEW
+\`\`\`
+
+### Example 2: Create a New File
+
+\`\`\`ruby
+<<<<<<< CURRENT path/to/newfile.rb
+=======
+def new_function
+  puts 'Hello, world!'
+end
+>>>>>>> NEW
+\`\`\`
+
+### Example 3: Moving a Function
+
+Removing it from path/to/file.py
+
+\`\`\`python
+<<<<<<< CURRENT path/to/file.py
+def old_function():
+  return 'Old function'
+=======
+>>>>>>> NEW
+\`\`\`
+
+Adding it to path/to/newfile.py
+
+\`\`\`python
+<<<<<<< CURRENT path/to/newfile.py
+def existing_function():
+  return 'Existing function'
+
+=======
+def existing_function():
+  return 'Existing function'
+
+def old_function():
+  return 'Old function'
+>>>>>>> NEW
+\`\`\`
+
+### Example 4: Removing a Function
+
+\`\`\`java
+<<<<<<< CURRENT path/to/file.java
+public void oldFunction() {
+  System.out.println("Old function")
+}
+=======
+>>>>>>> NEW
+\`\`\`
+
+### Example 5: Replace a file
+
+This will replace the entire contents of **path/to/file.rb** with the new content:
+
+\`\`\`ruby
+<<<<<<< CURRENT path/to/file.rb
+=======
+def new_function
+  puts 'Hello, world!'
+end
+>>>>>>> NEW
+\`\`\`
+
+## Don't Invent Code That Isn't Provided in Context
+
+A file might be referenced by just the file name without the full path, but the code must be provided in the *Context Files* section.
+
+Unless you believe you are creating a whole new file, never ever under any circumstances make up code in the CURRENT block that was not provided to you in the *Context Files* section.
+
+If a required file hasn't been provided in the *Context Files* section, stop everything and ask the user to provide it in the context by adding -f path/to/file to the command or add path/to/file in the interactive chat.`;
+    return prompt;
+};
+exports.generateCodegenPrompt = generateCodegenPrompt;
+const generateShellPrompt = () => {
+    const shell = (0, child_process_1.execSync)('echo $SHELL').toString().trim();
+    const os = (0, child_process_1.execSync)('echo $OSTYPE').toString().trim();
+    return `Generate an executable ${shell} script that works on ${os}. Try to make it a single line if possible and as simple and straightforward as possible.
+
+Do not add any commentary or context to the message other than the commit message itself.
+
+An example of the output for this should look like the following:
+
+\`\`\`sh
+find . -type f -name "*.ts" -exec sed -i '' 's/old/new/g' {} +
+\`\`\`
+
+Don't use that script, it is only an example.`;
+};
+exports.generateShellPrompt = generateShellPrompt;
+const collectSpecialFileContents = () => {
+    const specialFileContents = {};
+    for (const file of exports.SPECIAL_FILES) {
+        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;
+};
+exports.collectSpecialFileContents = collectSpecialFileContents;
+const checkForSpecialFiles = () => exports.SPECIAL_FILES.some((file) => fs_1.default.existsSync(file));
+exports.checkForSpecialFiles = checkForSpecialFiles;
+const getAllFilesInDirectory = async (dir) => {
+    const subdirs = await fs_1.default.promises.readdir(dir);
+    const files = await Promise.all(subdirs.map(async (subdir) => {
+        const res = path_1.default.resolve(dir, subdir);
+        if (subdir === 'node_modules' || subdir === '.git' || subdir === '.DS_Store') {
+            return [];
+        }
+        const stat = await fs_1.default.promises.stat(res);
+        if (stat.isDirectory()) {
+            return (0, exports.getAllFilesInDirectory)(res);
+        }
+        else {
+            const isBinary = await (0, isbinaryfile_1.isBinaryFile)(res);
+            return isBinary ? [] : res;
+        }
+    }));
+    return files.flat();
+};
+exports.getAllFilesInDirectory = getAllFilesInDirectory;
+const generateFileList = async () => {
+    try {
+        const lsOutput = await (0, exports.runCommand)('ls', []);
+        const findOutput = await (0, exports.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 [];
+    }
+};
+exports.generateFileList = generateFileList;
+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'));
+            }
+        });
+    });
+};
+exports.runCommand = runCommand;
+const fetchModels = async () => {
+    try {
+        const modelsOutput = await (0, exports.runCommand)('cloving', ['models']);
+        return modelsOutput;
+    }
+    catch (error) {
+        console.error('Error fetching models:', error.message);
+        return [];
+    }
+};
+exports.fetchModels = fetchModels;
+const readFileContent = (file) => {
+    try {
+        return fs_1.default.readFileSync(file, 'utf-8');
+    }
+    catch (error) {
+        console.error('Error reading file content:', error.message);
+        return '';
+    }
+};
+exports.readFileContent = readFileContent;
+const addFileToContext = async (filePath, contextFiles, baseDir) => {
+    const relativePath = path_1.default.relative(baseDir, filePath);
+    if (await (0, isbinaryfile_1.isBinaryFile)(filePath)) {
+        return;
+    }
+    const content = await fs_1.default.promises.readFile(filePath, 'utf-8');
+    contextFiles[relativePath] = content;
+};
+const addDirectoryToContext = async (dirPath, contextFiles, baseDir) => {
+    const entries = await fs_1.default.promises.readdir(dirPath, { withFileTypes: true });
+    for (const entry of entries) {
+        const fullPath = path_1.default.join(dirPath, entry.name);
+        if (entry.isDirectory()) {
+            if (entry.name !== 'node_modules' && entry.name !== '.git') {
+                await addDirectoryToContext(fullPath, contextFiles, baseDir);
+            }
+        }
+        else {
+            await addFileToContext(fullPath, contextFiles, baseDir);
+        }
+    }
+};
+const addFileOrDirectoryToContext = async (contextFile, contextFiles, options) => {
+    const filePath = path_1.default.resolve(contextFile);
+    const baseDir = process.cwd();
+    try {
+        const stats = await fs_1.default.promises.stat(filePath);
+        if (stats.isDirectory()) {
+            await addDirectoryToContext(filePath, contextFiles, baseDir);
+        }
+        else if (stats.isFile()) {
+            await addFileToContext(filePath, contextFiles, baseDir);
+        }
+    }
+    catch (error) {
+        console.error(colors_1.default.red(`${colors_1.default.bold('Error')}: File or directory "${contextFile}" does not exist`));
+        process.exit(1);
+    }
+    return contextFiles;
+};
+exports.addFileOrDirectoryToContext = addFileOrDirectoryToContext;