cloving 0.3.18 → 0.3.19

package/src/utils/prompt_utils.ts

@@ -0,0 +1,375 @@
+/**
+ * @module prompt_utils
+ * @description Provides utility functions for generating prompts, handling files, and running commands.
+ */
+
+import fs from 'fs'
+import path from 'path'
+import { execSync, spawn } from 'child_process'
+import { isBinaryFile } from 'isbinaryfile'
+import colors from 'colors'
+import { join } from 'path'
+
+import { getNearestClovingConfig } from './config_utils'
+import {
+  REVIEW_INSTRUCTIONS,
+  DOCS_INSTRUCTIONS,
+  CODEGEN_INSTRUCTIONS,
+  SPECIAL_FILES,
+  SHELL_INSTRUCTIONS,
+  CODEGEN_EXAMPLES,
+} from './prompts'
+
+import type { ClovingGPTOptions } from './types'
+
+/**
+ * Retrieves the package version from package.json.
+ * @returns {string} The version of the package.
+ */
+export const getPackageVersion = () => {
+  const packagePath = join(__dirname, '..', 'package.json')
+  const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'))
+  return packageJson.version
+}
+
+/**
+ * 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: Record<string, unknown> | string): string => {
+  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.
+ */
+export const generateCodegenPrompt = (contextFilesContent: Record<string, string>): string => {
+  const specialFileContents = 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 = `${CODEGEN_INSTRUCTIONS}
+
+## Description of App
+
+\`\`\`json
+${JSON.stringify(getNearestClovingConfig().config, 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')}
+
+${CODEGEN_INSTRUCTIONS}
+
+${CODEGEN_EXAMPLES}`
+  return prompt
+}
+
+/**
+ * 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.
+ */
+export const generateDocsPrompt = (contextFilesContent: Record<string, string>): string => {
+  const specialFileContents = 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 = `${DOCS_INSTRUCTIONS}
+
+${CODEGEN_INSTRUCTIONS}
+
+${CODEGEN_EXAMPLES}
+
+## Description of App
+
+\`\`\`json
+${JSON.stringify(getNearestClovingConfig().config, 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')}
+
+${DOCS_INSTRUCTIONS}`
+
+  return prompt
+}
+
+/**
+ * Generates a prompt for shell commands based on the current shell and OS.
+ * @returns {string} The generated prompt for shell commands.
+ */
+export const generateShellPrompt = (): string => {
+  const shell = execSync('echo $SHELL').toString().trim()
+  const os = execSync('echo $OSTYPE').toString().trim()
+  return `${SHELL_INSTRUCTIONS}\n\n## Context\n\nShell: ${shell}\n\nOS: ${os}`
+}
+
+export const generateReviewPrompt = (
+  options: ClovingGPTOptions,
+  contextFiles: Record<string, string>,
+): string => {
+  let prompt = `${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(getNearestClovingConfig().config, null, 2)}
+
+${contextFileContents}
+
+### Request
+
+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
+
+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
+}
+
+/**
+ * Collects the contents of special files.
+ * @returns {Record<string, string | Record<string, unknown>>} An object containing the contents of special files.
+ */
+export const collectSpecialFileContents = (): Record<string, string | Record<string, unknown>> => {
+  const specialFileContents: Record<string, string | Record<string, unknown>> = {}
+  for (const file of SPECIAL_FILES) {
+    if (fs.existsSync(file)) {
+      try {
+        const content = fs.readFileSync(file, 'utf-8')
+        specialFileContents[file] = file.endsWith('.json') ? JSON.parse(content) : content
+      } catch (error) {
+        specialFileContents[file] = fs.readFileSync(file, 'utf-8')
+      }
+    }
+  }
+  return specialFileContents
+}
+
+/**
+ * Checks if any special files exist in the current directory.
+ * @returns {boolean} True if any special files exist, false otherwise.
+ */
+export const checkForSpecialFiles = (): boolean => SPECIAL_FILES.some((file) => fs.existsSync(file))
+
+/**
+ * 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.
+ */
+export const getAllFilesInDirectory = async (dir: string): Promise<string[]> => {
+  const subdirs = await fs.promises.readdir(dir)
+  const files = await Promise.all(
+    subdirs.map(async (subdir) => {
+      const res = path.resolve(dir, subdir)
+      if (subdir === 'node_modules' || subdir === '.git' || subdir === '.DS_Store') {
+        return []
+      }
+      const stat = await fs.promises.stat(res)
+      if (stat.isDirectory()) {
+        return getAllFilesInDirectory(res)
+      } else {
+        const isBinary = await isBinaryFile(res)
+        return isBinary ? [] : res
+      }
+    }),
+  )
+  return files.flat()
+}
+
+/**
+ * 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.
+ */
+export const generateFileList = async (): Promise<string[]> => {
+  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 as Error).message)
+    return []
+  }
+}
+
+/**
+ * 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.
+ */
+export const runCommand = (command: string, args: string[]): Promise<string[]> => {
+  return new Promise((resolve, reject) => {
+    const process = spawn(command, args)
+    const output: string[] = []
+
+    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'))
+      }
+    })
+  })
+}
+
+/**
+ * Fetches available models using the 'cloving models' command.
+ * @returns {Promise<string[]>} A promise that resolves with an array of available models.
+ */
+export const fetchModels = async (): Promise<string[]> => {
+  try {
+    const modelsOutput = await runCommand('cloving', ['models'])
+    return modelsOutput
+  } catch (error) {
+    console.error('Error fetching models:', (error as Error).message)
+    return []
+  }
+}
+
+/**
+ * Reads the content of a file.
+ * @param {string} file - The path to the file.
+ * @returns {string} The content of the file.
+ */
+export const readFileContent = (file: string): string => {
+  try {
+    return fs.readFileSync(file, 'utf-8')
+  } catch (error) {
+    console.error('Error reading file content:', (error as Error).message)
+    return ''
+  }
+}
+
+const addFileToContext = async (
+  filePath: string,
+  contextFiles: Record<string, string>,
+  baseDir: string,
+): Promise<void> => {
+  const relativePath = path.relative(baseDir, filePath)
+  if (await isBinaryFile(filePath)) {
+    return
+  }
+  const content = await fs.promises.readFile(filePath, 'utf-8')
+  contextFiles[relativePath] = content
+}
+
+const addDirectoryToContext = async (
+  dirPath: string,
+  contextFiles: Record<string, string>,
+  baseDir: string,
+): Promise<void> => {
+  const entries = await fs.promises.readdir(dirPath, { withFileTypes: true })
+  for (const entry of entries) {
+    const fullPath = path.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)
+    }
+  }
+}
+
+/**
+ * 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.
+ */
+export const addFileOrDirectoryToContext = async (
+  contextFile: string,
+  contextFiles: Record<string, string>,
+  options: Record<string, any>,
+): Promise<Record<string, string>> => {
+  const filePath = path.resolve(contextFile)
+  const baseDir = process.cwd()
+
+  try {
+    const stats = await fs.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.red(`${colors.bold('Error')}: File or directory "${contextFile}" does not exist`),
+    )
+    process.exit(1)
+  }
+
+  return contextFiles
+}

package/src/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/src/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/src/utils/prompts/CODEGEN_INSTRUCTIONS.md

@@ -0,0 +1,43 @@
+# 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 followed by three backticks and the language name like this:**
+   About to add documentation to the `UserService` class.
+
+   ```typescript
+2. **Next line: seven <, CURRENT, and the file path like this:**
+   <<<<<<< 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.**
+4. **Divide with seven = like this:**
+   =======
+5. **Add the new code.**
+6. **End with seven > and NEW like this:**
+   >>>>>>> NEW
+7. **Close the block with three backticks like this:**
+   ```
+
+## 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/src/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.`

package/src/utils/prompts/INIT_INSTRUCTIONS.md

@@ -0,0 +1,132 @@
+# Initialization 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:
+
+```typescript
+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:
+
+```json
+{
+  "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"
+}
+```

package/src/utils/prompts/REVIEW_INSTRUCTIONS.md

@@ -0,0 +1,49 @@
+### Example of a well-structured response
+
+# Code Review: Enhanced Code Generation and File Handling
+
+## Changes Overview
+
+These changes primarily focus on improving the code generation process and adding more robust file handling capabilities. The main modifications include:
+
+1. Enhancing the code generation prompt with a structured example response.
+2. Implementing a new function to extract file names and contents from the generated code.
+3. Adding a new option to save generated code directly to files.
+4. Improving the copy-to-clipboard functionality to allow copying individual files.
+5. Removing an unused import in the review.ts file.
+
+## Reason for Changes
+
+The changes aim to enhance the usability and flexibility of the code generation tool by providing clearer prompts, better file management, and more control over the generated code.
+
+## Detailed Description
+
+1. **Enhanced Code Generation Prompt** - The `generateCodePrompt` function now includes a structured example of a well-formatted response. This helps guide the AI to produce more consistent and usable output, making it easier to parse and use the generated code.
+2. **File Extraction Function** - A new function `extractFilesAndContent` has been added to parse the raw code command and extract individual file names and their contents. This enables more granular control over the generated code, allowing for file-specific operations.
+3. **Save to File Option** - A new 'Save Source Code to Files' option has been added to the user action menu. This feature allows users to save generated code directly to files in the appropriate directory structure.
+4. **Improved Copy to Clipboard** - The 'Copy Source Code to Clipboard' option has been enhanced to allow users to choose specific files to copy, rather than copying all generated code at once.
+5. **Removed Unused Import** - The unused import of `execFileSync` from 'child_process' has been removed from the review.ts file, improving code cleanliness.
+
+## Potential Bugs and Recommended Fixes
+
+### 1. Possible undefined access in `extractFilesAndContent`
+
+```typescript
+const contentMatch = regex.exec(rawCodeCommand)
+if (contentMatch) {
+  files.push(fileName)
+  let content = contentMatch[1]
+  // ...
+}
+```
+
+There's a potential for `contentMatch[1]` to be undefined if the regex doesn't capture any groups. To fix this, add a null check:
+
+```typescript
+const contentMatch = regex.exec(rawCodeCommand)
+if (contentMatch && contentMatch[1]) {
+  files.push(fileName)
+  let content = contentMatch[1]
+  // ...
+}
+```