editcodewithai 2.0.0 → 2.1.0

package/README.md

@@ -23,7 +23,11 @@ npm install editcodewithai
 Here's a basic example of how to use `performAiEdit` to update a file:
 
 ```typescript
-import { performAiEdit, LlmFunction } from "editcodewithai";
+import {
+  performAiEdit,
+  FORMAT_INSTRUCTIONS,
+  LlmFunction,
+} from "editcodewithai";
 import { VizFiles } from "@vizhub/viz-types";
 
 // Your function to call the LLM
@@ -102,6 +106,45 @@ The library handles several file operations automatically:
 - **Creating new files**: When the AI suggests new files to add
 - **Deleting files**: When the AI returns empty content for a file
 
+## Format Instructions
+
+The library exports `FORMAT_INSTRUCTIONS` which contains the exact prompt instructions used for each edit format. This can be useful if you want to:
+
+- Use the formatting instructions in your own custom prompts
+- Understand exactly what instructions are sent to the LLM for each format
+- Build your own AI editing tools using the same proven prompt patterns
+
+### Usage
+
+```typescript
+import { FORMAT_INSTRUCTIONS } from "editcodewithai";
+
+// Access instructions for a specific format
+console.log(FORMAT_INSTRUCTIONS.diff);
+console.log(FORMAT_INSTRUCTIONS.whole);
+console.log(FORMAT_INSTRUCTIONS["diff-fenced"]);
+console.log(FORMAT_INSTRUCTIONS.udiff);
+
+// Use in your own prompts
+const customPrompt = `
+${FORMAT_INSTRUCTIONS.diff}
+
+Please update the following code to add error handling:
+${yourCodeHere}
+`;
+```
+
+### Available Formats
+
+The `FORMAT_INSTRUCTIONS` object contains instructions for these edit formats:
+
+- **`whole`**: Instructions for returning complete file contents
+- **`diff`**: Instructions for search-and-replace blocks
+- **`diff-fenced`**: Instructions for search-and-replace blocks with file paths inside code fences
+- **`udiff`**: Instructions for unified diff format
+
+Each instruction set is a string containing detailed formatting guidelines that help ensure the LLM produces properly structured output that can be parsed by the library.
+
 ## Similar Projects
 
 - **Aider**: An AI pair programming tool that integrates with your terminal to assist in code editing within your local git repository. [https://aider.chat/](https://aider.chat/)

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 import type { PerformAiEditParams, PerformAiEditResult } from "./types";
+import { FORMAT_INSTRUCTIONS } from "./prompt";
 export type { LlmFunction, PerformAiEditParams, PerformAiEditResult, EditFormat, } from "./types";
+export { FORMAT_INSTRUCTIONS };
 /**
  * Core AI logic for:
  * - Building the prompt (including context)

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FORMAT_INSTRUCTIONS = void 0;
 exports.performAiEdit = performAiEdit;
 const llm_code_format_1 = require("llm-code-format");
 const prompt_1 = require("./prompt");
+Object.defineProperty(exports, "FORMAT_INSTRUCTIONS", { enumerable: true, get: function () { return prompt_1.FORMAT_INSTRUCTIONS; } });
 const metadata_1 = require("./metadata");
 const fileUtils_1 = require("./fileUtils");
 const debug = false;

package/dist/prompt.d.ts

@@ -1,5 +1,6 @@
 import type { EditFormat } from "./types";
 export declare const PROMPT_TEMPLATE_VERSION = 1;
+export declare const FORMAT_INSTRUCTIONS: Record<EditFormat, string>;
 /**
  * Assembles the full prompt by combining task, files context, and formatting instructions
  */

package/dist/prompt.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROMPT_TEMPLATE_VERSION = void 0;
+exports.FORMAT_INSTRUCTIONS = exports.PROMPT_TEMPLATE_VERSION = void 0;
 exports.assembleFullPrompt = assembleFullPrompt;
 // Versions of the prompt template.
 exports.PROMPT_TEMPLATE_VERSION = 1;
 // Template pieces
 const TASK = (prompt) => `## Your Task\n\n${prompt}`;
 const FILES = (filesContext) => `## Original Files\n\n${filesContext}`;
-const FORMAT_INSTRUCTIONS = {
+exports.FORMAT_INSTRUCTIONS = {
     whole: [
         "## Formatting Instructions\n\n",
         "Suggest changes to the original files using this exact format:\n\n",
@@ -64,6 +64,6 @@ const FORMAT_INSTRUCTIONS = {
  * Assembles the full prompt by combining task, files context, and formatting instructions
  */
 function assembleFullPrompt({ filesContext, prompt, editFormat = "whole", }) {
-    const FORMAT = FORMAT_INSTRUCTIONS[editFormat];
+    const FORMAT = exports.FORMAT_INSTRUCTIONS[editFormat];
     return [TASK(prompt), FILES(filesContext), FORMAT].join("\n\n");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "editcodewithai",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Edit Code With AI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -40,20 +40,20 @@
   },
   "homepage": "https://github.com/vizhub-core/editcodewithai#readme",
   "dependencies": {
-    "@vizhub/viz-types": "^0.1.0",
-    "@vizhub/viz-utils": "^1.1.0",
-    "dotenv": "^17.0.1",
+    "@vizhub/viz-types": "^0.3.0",
+    "@vizhub/viz-utils": "^1.3.0",
+    "dotenv": "^17.2.0",
     "llm-code-format": "^2.0.1"
   },
   "devDependencies": {
-    "@langchain/core": "^0.3.61",
-    "@langchain/openai": "^0.5.16",
-    "langchain": "^0.3.29",
+    "@langchain/core": "^0.3.66",
+    "@langchain/openai": "^0.6.2",
+    "langchain": "^0.3.30",
     "cors": "^2.8.5",
     "express": "^5.1.0",
     "npm-check-updates": "^18.0.1",
     "prettier": "^3.6.2",
-    "puppeteer": "^24.11.2",
+    "puppeteer": "^24.14.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"