cloving 0.3.11 → 0.3.12

package/dist/utils/prompt_utils.js

@@ -1,9 +1,13 @@
 "use strict";
+/**
+ * @module prompt_utils
+ * @description Provides utility functions for generating prompts, handling files, and running commands.
+ */
 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;
+exports.addFileOrDirectoryToContext = exports.readFileContent = exports.fetchModels = exports.runCommand = exports.generateFileList = exports.getAllFilesInDirectory = exports.checkForSpecialFiles = exports.collectSpecialFileContents = exports.generateReviewPrompt = exports.generateShellPrompt = exports.generateDocsPrompt = exports.generateCodegenPrompt = exports.getPackageVersion = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const child_process_1 = require("child_process");
@@ -11,241 +15,33 @@ 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, this section should never be just spaces or tabs unless it is a new file.**
-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 prompts_1 = require("./prompts");
+/**
+ * Retrieves the package version from package.json.
+ * @returns {string} The version of the package.
+ */
 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;
+/**
+ * Renders a context file as a string.
+ * @param {Record<string, unknown> | string} contextFile - The context file to render.
+ * @returns {string} The rendered string representation of the context file.
+ */
 const renderAsString = (contextFile) => {
     if (typeof contextFile === 'string') {
         return contextFile;
     }
     return JSON.stringify(contextFile, null, 2);
 };
+/**
+ * Generates a prompt for code generation based on context files and special files.
+ * @param {Record<string, string>} contextFilesContent - The content of context files.
+ * @returns {string} The generated prompt for code generation.
+ */
 const generateCodegenPrompt = (contextFilesContent) => {
     const specialFileContents = (0, exports.collectSpecialFileContents)();
     // detect if specialFileContents[file] is a string or an object
@@ -255,7 +51,7 @@ const generateCodegenPrompt = (contextFilesContent) => {
     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}
+    const prompt = `${prompts_1.CODEGEN_INSTRUCTIONS}
 
 ## Description of App
 
@@ -275,112 +71,99 @@ ${contextFileContents.length > 0 ? contextFileContents : 'No context files provi
 
 ${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
-\`\`\`
+${prompts_1.CODEGEN_INSTRUCTIONS}
 
-Adding it to path/to/newfile.py
-
-\`\`\`python
-<<<<<<< CURRENT path/to/newfile.py
-def existing_function():
-  return 'Existing function'
+${prompts_1.CODEGEN_EXAMPLES}`;
+    return prompt;
+};
+exports.generateCodegenPrompt = generateCodegenPrompt;
+/**
+ * Generates a prompt for documentation generation based on context files and special files.
+ * @param {Record<string, string>} contextFilesContent - The content of context files.
+ * @returns {string} The generated prompt for documentation generation.
+ */
+const generateDocsPrompt = (contextFilesContent) => {
+    const specialFileContents = (0, exports.collectSpecialFileContents)();
+    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 = `${prompts_1.DOCS_INSTRUCTIONS}
 
-=======
-def existing_function():
-  return 'Existing function'
+${prompts_1.CODEGEN_INSTRUCTIONS}
 
-def old_function():
-  return 'Old function'
->>>>>>> NEW
-\`\`\`
+${prompts_1.CODEGEN_EXAMPLES}
 
-### Example 4: Removing a Function
+## Description of App
 
-\`\`\`java
-<<<<<<< CURRENT path/to/file.java
-public void oldFunction() {
-  System.out.println("Old function")
-}
-=======
->>>>>>> NEW
+\`\`\`json
+${JSON.stringify((0, config_utils_1.getClovingConfig)(), null, 2)}
 \`\`\`
 
-### Example 5: Replace a file
+## Special Files
 
-This will replace the entire contents of **path/to/file.rb** with the new content:
+${specialFiles.length > 0 ? specialFiles : 'No special files provided.'}
 
-\`\`\`ruby
-<<<<<<< CURRENT path/to/file.rb
-=======
-def new_function
-  puts 'Hello, world!'
-end
->>>>>>> NEW
-\`\`\`
+## Context Files
 
-## Don't Invent Code That Isn't Provided in Context
+${contextFileContents.length > 0 ? contextFileContents : 'No context files provided.'}
 
-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.
+## Directory structure
 
-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.
+${Object.keys(contextFilesContent).join('\n')}
 
-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.`;
+${prompts_1.DOCS_INSTRUCTIONS}`;
     return prompt;
 };
-exports.generateCodegenPrompt = generateCodegenPrompt;
+exports.generateDocsPrompt = generateDocsPrompt;
+/**
+ * Generates a prompt for shell commands based on the current shell and OS.
+ * @returns {string} The generated prompt for shell commands.
+ */
 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.
+    return `${prompts_1.SHELL_INSTRUCTIONS}\n\n## Context\n\nShell: ${shell}\n\nOS: ${os}`;
+};
+exports.generateShellPrompt = generateShellPrompt;
+const generateReviewPrompt = (options, contextFiles) => {
+    let prompt = `${prompts_1.REVIEW_INSTRUCTIONS}`;
+    if (options.files) {
+        const contextFileContents = Object.keys(contextFiles)
+            .map((file) => `### Contents of ${file}\n\n${contextFiles[file]}\n\n`)
+            .join('\n');
+        prompt += `### Description of App
+
+${JSON.stringify((0, config_utils_1.getClovingConfig)(), null, 2)}
 
-Do not add any commentary or context to the message other than the commit message itself.
+${contextFileContents}
 
-An example of the output for this should look like the following:
+### Request
 
-\`\`\`sh
-find . -type f -name "*.ts" -exec sed -i '' 's/old/new/g' {} +
-\`\`\`
+I would like you to explain the code and document a description of it.
+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.`;
+    }
+    else {
+        prompt += `### Request
 
-Don't use that script, it is only an example.`;
+Do not use any data from the example response structure, only use the structure.
+I would like you to explain why these change are 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.`;
+    }
+    return prompt;
 };
-exports.generateShellPrompt = generateShellPrompt;
+exports.generateReviewPrompt = generateReviewPrompt;
+/**
+ * Collects the contents of special files.
+ * @returns {Record<string, string | Record<string, unknown>>} An object containing the contents of special files.
+ */
 const collectSpecialFileContents = () => {
     const specialFileContents = {};
-    for (const file of exports.SPECIAL_FILES) {
+    for (const file of prompts_1.SPECIAL_FILES) {
         if (fs_1.default.existsSync(file)) {
             try {
                 const content = fs_1.default.readFileSync(file, 'utf-8');
@@ -394,8 +177,17 @@ const collectSpecialFileContents = () => {
     return specialFileContents;
 };
 exports.collectSpecialFileContents = collectSpecialFileContents;
-const checkForSpecialFiles = () => exports.SPECIAL_FILES.some((file) => fs_1.default.existsSync(file));
+/**
+ * Checks if any special files exist in the current directory.
+ * @returns {boolean} True if any special files exist, false otherwise.
+ */
+const checkForSpecialFiles = () => prompts_1.SPECIAL_FILES.some((file) => fs_1.default.existsSync(file));
 exports.checkForSpecialFiles = checkForSpecialFiles;
+/**
+ * Recursively gets all non-binary files in a directory.
+ * @param {string} dir - The directory to search.
+ * @returns {Promise<string[]>} A promise that resolves with an array of file paths.
+ */
 const getAllFilesInDirectory = async (dir) => {
     const subdirs = await fs_1.default.promises.readdir(dir);
     const files = await Promise.all(subdirs.map(async (subdir) => {
@@ -415,6 +207,10 @@ const getAllFilesInDirectory = async (dir) => {
     return files.flat();
 };
 exports.getAllFilesInDirectory = getAllFilesInDirectory;
+/**
+ * Generates a list of files in the current directory and its subdirectories.
+ * @returns {Promise<string[]>} A promise that resolves with an array of file paths.
+ */
 const generateFileList = async () => {
     try {
         const lsOutput = await (0, exports.runCommand)('ls', []);
@@ -430,6 +226,12 @@ const generateFileList = async () => {
     }
 };
 exports.generateFileList = generateFileList;
+/**
+ * Runs a shell command and returns its output.
+ * @param {string} command - The command to run.
+ * @param {string[]} args - The arguments for the command.
+ * @returns {Promise<string[]>} A promise that resolves with an array of output lines.
+ */
 const runCommand = (command, args) => {
     return new Promise((resolve, reject) => {
         const process = (0, child_process_1.spawn)(command, args);
@@ -451,6 +253,10 @@ const runCommand = (command, args) => {
     });
 };
 exports.runCommand = runCommand;
+/**
+ * Fetches available models using the 'cloving models' command.
+ * @returns {Promise<string[]>} A promise that resolves with an array of available models.
+ */
 const fetchModels = async () => {
     try {
         const modelsOutput = await (0, exports.runCommand)('cloving', ['models']);
@@ -462,6 +268,11 @@ const fetchModels = async () => {
     }
 };
 exports.fetchModels = fetchModels;
+/**
+ * Reads the content of a file.
+ * @param {string} file - The path to the file.
+ * @returns {string} The content of the file.
+ */
 const readFileContent = (file) => {
     try {
         return fs_1.default.readFileSync(file, 'utf-8');
@@ -494,6 +305,13 @@ const addDirectoryToContext = async (dirPath, contextFiles, baseDir) => {
         }
     }
 };
+/**
+ * Adds a file or directory to the context.
+ * @param {string} contextFile - The path to the file or directory to add.
+ * @param {Record<string, string>} contextFiles - The current context files.
+ * @param {Record<string, any>} options - Additional options.
+ * @returns {Promise<Record<string, string>>} A promise that resolves with the updated context files.
+ */
 const addFileOrDirectoryToContext = async (contextFile, contextFiles, options) => {
     const filePath = path_1.default.resolve(contextFile);
     const baseDir = process.cwd();

package/dist/utils/prompts/CODEGEN_COULDNT_APPLY.md

@@ -0,0 +1,5 @@
+## Code Generation Failed
+
+Some of the provided code blocks could not be applied, please match the existing code with a few more lines of context and make sure it is a character for character exact match. Never use "rest of the existing code" or "rest of the code" in your response, instead break the code block into smaller blocks.
+
+## Details

package/dist/utils/prompts/CODEGEN_EXAMPLES.md

@@ -0,0 +1,82 @@
+### 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.

package/dist/utils/prompts/CODEGEN_INSTRUCTIONS.md

@@ -0,0 +1,42 @@
+# 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 a one line description of change**
+1. **Then provide 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, this section should always have some code characters in it, not just spaces or tabs. The only exception is when creating a brand new file.**
+4. **Divide with seven =.**
+   =======
+5. **Add the new code.**
+6. **End with seven > and NEW.**
+   >>>>>>> NEW
+7. **Close the block with three backticks.**
+   ```
+
+## 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.

package/dist/utils/prompts/DOCS_INSTRUCTIONS.md

@@ -0,0 +1,9 @@
+## Documentation Instructions
+
+Add documentation to the files in context. Provide the updated files with added documentation using the CURRENT/NEW block format. Only include the parts of the files that have changed.
+Add or update documentation comments for each function, class, and module definition as appropriate. Use the standard documentation format for the respective language (e.g., JSDoc for JavaScript/TypeScript, docstrings for Python, etc.).
+
+### Note
+
+Whenever possible, break up the changes into pieces and make sure every change is in its own CURRENT / NEW block.
+Do not allow empty CURRENT blocks and if you add content to the CURRENT block, you also have to add the same content to the NEW block.`