cloving 0.3.10 → 0.3.12

package/dist/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/dist/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]
+  // ...
+}
+```

package/dist/utils/prompts/SHELL_INSTRUCTIONS.md

@@ -0,0 +1,15 @@
+# Shell Script Instructions
+
+Generate an executable script that works on the current operating system. 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.
+
+## Example
+
+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.

package/dist/utils/prompts/SPECIAL_FILES.md

@@ -0,0 +1,66 @@
+# Special Files
+
+The following is a list of special files recognized by the system:
+
+- 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

package/dist/utils/prompts/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REVIEW_INSTRUCTIONS = exports.CODEGEN_EXAMPLES = exports.SPECIAL_FILES = exports.INIT_INSTRUCTIONS = exports.DOCS_INSTRUCTIONS = exports.CODEGEN_COULDNT_APPLY = exports.CODEGEN_INSTRUCTIONS = exports.SHELL_INSTRUCTIONS = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const CODEGEN_COULDNT_APPLY = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'CODEGEN_COULDNT_APPLY.md'), 'utf-8');
+exports.CODEGEN_COULDNT_APPLY = CODEGEN_COULDNT_APPLY;
+const CODEGEN_INSTRUCTIONS = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'CODEGEN_INSTRUCTIONS.md'), 'utf-8');
+exports.CODEGEN_INSTRUCTIONS = CODEGEN_INSTRUCTIONS;
+const CODEGEN_EXAMPLES = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'CODEGEN_EXAMPLES.md'), 'utf-8');
+exports.CODEGEN_EXAMPLES = CODEGEN_EXAMPLES;
+const SHELL_INSTRUCTIONS = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'SHELL_INSTRUCTIONS.md'), 'utf-8');
+exports.SHELL_INSTRUCTIONS = SHELL_INSTRUCTIONS;
+const REVIEW_INSTRUCTIONS = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'REVIEW_INSTRUCTIONS.md'), 'utf-8');
+exports.REVIEW_INSTRUCTIONS = REVIEW_INSTRUCTIONS;
+const DOCS_INSTRUCTIONS = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'DOCS_INSTRUCTIONS.md'), 'utf-8');
+exports.DOCS_INSTRUCTIONS = DOCS_INSTRUCTIONS;
+const INIT_INSTRUCTIONS = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'INIT_INSTRUCTIONS.md'), 'utf-8');
+exports.INIT_INSTRUCTIONS = INIT_INSTRUCTIONS;
+const SPECIAL_FILES_PATH = fs_1.default.readFileSync(path_1.default.resolve(__dirname, 'SPECIAL_FILES.md'), 'utf-8');
+const SPECIAL_FILES = SPECIAL_FILES_PATH.split('\n')
+    .filter((line) => line.startsWith('- '))
+    .map((line) => line.slice(2).trim());
+exports.SPECIAL_FILES = SPECIAL_FILES;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "cloving",
-  "version": "0.3.10",
+  "version": "0.3.12",
   "packageManager": "yarn@1.22.22",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc && cp package.json dist/package.json",
+    "build": "tsc && cp package.json dist/package.json && cp src/utils/prompts/*.md dist/utils/prompts/",
     "start": "node dist/index.js",
     "watch": "tsc -w",
     "check": "bash -c 'npx tsc --noEmit --skipLibCheck'",