cloving 0.3.4 → 0.3.6

package/dist/utils/string_utils.js

@@ -68,7 +68,20 @@ const extractJsonMetadata = (response) => {
     return jsonString;
 };
 exports.extractJsonMetadata = extractJsonMetadata;
-// Function to extract markdown from the AI response
+/**
+ * Extracts markdown content from a given response string.
+ *
+ * This function attempts to extract markdown content from the input string,
+ * focusing on content within code blocks and removing any surrounding metadata.
+ *
+ * @param {string} response - The input string containing markdown and possibly other content.
+ * @returns {string} The extracted markdown content.
+ *
+ * @example
+ * const response = '```markdown\n# Title\nContent\n```\nOther text';
+ * const markdown = extractMarkdown(response);
+ * console.log(markdown); // Outputs: "# Title\nContent"
+ */
 const extractMarkdown = (response) => {
     let markdownString = response;
     // Regular expression to match any ```<word> block
@@ -91,12 +104,28 @@ const extractMarkdown = (response) => {
     return markdownString;
 };
 exports.extractMarkdown = extractMarkdown;
+/**
+ * Parses markdown instructions into separate blocks.
+ *
+ * This function takes a string input containing markdown instructions and
+ * separates it into an array of strings, where each string represents a
+ * distinct block of content (either a code block or a text block).
+ *
+ * @param {string} input - The input string containing markdown instructions.
+ * @returns {string[]} An array of strings, each representing a distinct block of content.
+ *
+ * @example
+ * const input = "# Title\n```js\nconst x = 1;\n```\nSome text";
+ * const blocks = parseMarkdownInstructions(input);
+ * console.log(blocks);
+ * // Outputs: ["# Title", "```js\nconst x = 1;\n```", "Some text"]
+ */
 const parseMarkdownInstructions = (input) => {
     const lines = input.split('\n');
     const result = [];
     let buffer = [];
     let inCodeBlock = false;
-    lines.forEach(line => {
+    lines.forEach((line) => {
         if (line.trim().startsWith('```')) {
             if (inCodeBlock) {
                 // End of code block
@@ -126,6 +155,18 @@ const parseMarkdownInstructions = (input) => {
     return result;
 };
 exports.parseMarkdownInstructions = parseMarkdownInstructions;
+/**
+ * Finds the indices of a CURRENT/NEW block within the input string.
+ *
+ * This function searches for the start, divider, and end markers of a CURRENT/NEW block
+ * in the input string, starting from the given index. It returns the indices of these
+ * markers if a complete block is found.
+ *
+ * @param {string} input - The input string to search for block indices.
+ * @param {number} startIndex - The index in the input string to start searching from.
+ * @returns {BlockIndices | null} An object containing the indices of the block components,
+ *                                or null if a complete block is not found.
+ */
 const findBlockIndices = (input, startIndex) => {
     const blockStart = input.indexOf(BLOCK_START, startIndex);
     if (blockStart === -1)
@@ -142,10 +183,20 @@ const findBlockIndices = (input, startIndex) => {
         start: blockStart,
         filePathEnd,
         divider: dividerIndex,
-        end: blockEnd
+        end: blockEnd,
     };
 };
 exports.findBlockIndices = findBlockIndices;
+/**
+ * Extracts the content of a CURRENT/NEW block using the provided indices.
+ *
+ * This function takes the input string and a set of block indices, and extracts
+ * the file path, current content, and new content from the block.
+ *
+ * @param {string} input - The input string containing the CURRENT/NEW block.
+ * @param {BlockIndices} indices - An object containing the indices of the block components.
+ * @returns {CurrentNewBlock} An object containing the extracted file path, current content, and new content.
+ */
 const extractBlock = (input, indices) => {
     const filePath = input.slice(indices.start + BLOCK_START.length, indices.filePathEnd).trim();
     const currentContent = input.slice(indices.filePathEnd + 1, indices.divider).trim();
@@ -247,8 +298,8 @@ const updateFileContent = (currentContent, block) => {
         return block.newContent;
     }
     // 2) split currentContent and block.currentContent into new lines and trim() all the lines, then put back the new lines
-    const currentLines = currentContent.split('\n').map(line => line.trim());
-    const blockLines = block.currentContent.split('\n').map(line => line.trim());
+    const currentLines = currentContent.split('\n').map((line) => line.trim());
+    const blockLines = block.currentContent.split('\n').map((line) => line.trim());
     // 3) see if the trimmed block.currentContent matches a section of code in the trimmed currentContent
     const blockContent = blockLines.join('\n');
     const currentContentTrimmed = currentLines.join('\n');
@@ -259,11 +310,16 @@ const updateFileContent = (currentContent, block) => {
     }
     // 5) compare the first line of block.currentContent with the matchingLine line of currentContent, putting any preceeding spaces that are in currentContent but not in block.currentContent into a variable named preceedingSpaces
     const firstLineIndex = currentContent.indexOf(blockLines[0]);
-    const precedingSpaces = currentContent.substring(firstLineIndex, firstLineIndex + currentLines[0].length).match(/^\s*/);
+    const precedingSpaces = currentContent
+        .substring(firstLineIndex, firstLineIndex + currentLines[0].length)
+        .match(/^\s*/);
     // 6) add preceedingSpaces to the start of each line in both block.currentContent and block.newContent
     if (precedingSpaces) {
         const precedingSpacesValue = precedingSpaces[0];
-        const indentedNewContent = block.newContent.split('\n').map(line => precedingSpacesValue + line).join('\n');
+        const indentedNewContent = block.newContent
+            .split('\n')
+            .map((line) => precedingSpacesValue + line)
+            .join('\n');
         // 7) finally, do a simple currentContent.replace(block.currentContent, block.newContent) with the modified (added preceeding spaces to match) variables
         return currentContent.replace(block.currentContent, indentedNewContent);
     }
@@ -272,6 +328,42 @@ const updateFileContent = (currentContent, block) => {
     }
 };
 exports.updateFileContent = updateFileContent;
+/**
+ * Analyzes the content of a block against the file content to find matching lines.
+ *
+ * This function compares the trimmed content of a block with the trimmed content of a file
+ * to identify all occurrences of the block content within the file.
+ *
+ * @param {CurrentNewBlock} block - The block containing the content to be searched for.
+ * @param {string} fileContent - The content of the file to be analyzed.
+ * @returns {Promise<{ matchingLines: number[]; currentContentTrimmed: string }>} A promise that resolves to an object containing:
+ *   - matchingLines: An array of line numbers where the block content matches in the file.
+ *   - currentContentTrimmed: The trimmed content of the file.
+ */
+const analyzeBlockContent = async (block, fileContent) => {
+    const currentLines = fileContent.split('\n').map((line) => line.trim());
+    const blockLines = block.currentContent.split('\n').map((line) => line.trim());
+    const blockContent = blockLines.join('\n');
+    const currentContentTrimmed = currentLines.join('\n');
+    const matchingLines = [];
+    let matchingLine = -1;
+    while ((matchingLine = currentContentTrimmed.indexOf(blockContent, matchingLine + 1)) !== -1) {
+        matchingLines.push(matchingLine);
+    }
+    return { matchingLines, currentContentTrimmed };
+};
+/**
+ * Processes a single block by applying its changes to the corresponding file.
+ *
+ * This function handles the following scenarios:
+ * 1. Creating a new file if it doesn't exist.
+ * 2. Updating an existing file if the block's current content matches exactly once.
+ * 3. Logging errors if the current content is not found or matches multiple times.
+ *
+ * @param {CurrentNewBlock} block - The block containing the changes to be applied.
+ * @param {number} index - The index of the block being processed (used for logging).
+ * @returns {Promise<void>} A promise that resolves when the block has been processed.
+ */
 const processBlock = async (block, index) => {
     const filePath = path_1.default.resolve(block.filePath);
     let fileContent = await readFileContent(filePath);
@@ -280,8 +372,13 @@ const processBlock = async (block, index) => {
         console.log(`[${index + 1}] ${colors_1.default.green.bold(block.filePath)} has been ${colors_1.default.green.bold('created')}`);
         return;
     }
-    if (block.currentContent.trim() !== '' && !fileContent.includes(block.currentContent)) {
-        console.log(`[${index + 1}] ${colors_1.default.green.bold(block.filePath)} ${colors_1.default.red.bold(`ERROR: Current content not found to replace in the file`)}`);
+    const { matchingLines } = await analyzeBlockContent(block, fileContent);
+    if (matchingLines.length === 0) {
+        console.log(`[${index + 1}] ${colors_1.default.red.bold(block.filePath)} ${colors_1.default.red.bold('ERROR: Current content not found to replace in the file')}`);
+        return;
+    }
+    else if (matchingLines.length > 1) {
+        console.log(`[${index + 1}] ${colors_1.default.red.bold(block.filePath)} ${colors_1.default.red.bold(`ERROR: Current content matches multiple (${matchingLines.length}) parts in the file`)}`);
         return;
     }
     const updatedContent = (0, exports.updateFileContent)(fileContent, block);
@@ -352,9 +449,19 @@ const checkBlocksApplicability = async (blocks) => {
         if (fileContent === '') {
             summary.push(`[${index + 1}] ${colors_1.default.green.bold(block.filePath)} can be ${colors_1.default.green.bold('created')}`);
         }
-        else if (block.currentContent.trim() !== '' && !fileContent.includes(block.currentContent)) {
-            allApplicable = false;
-            summary.push(`[${index + 1}] ${colors_1.default.red.bold(block.filePath)} ${colors_1.default.red.bold('cannot be applied: Current content not found')}`);
+        else if (block.currentContent.trim() !== '') {
+            const { matchingLines } = await analyzeBlockContent(block, fileContent);
+            if (matchingLines.length === 0) {
+                allApplicable = false;
+                summary.push(`[${index + 1}] ${colors_1.default.red.bold(block.filePath)} ${colors_1.default.red.bold('cannot be applied: Current content not found')}`);
+            }
+            else if (matchingLines.length > 1) {
+                allApplicable = false;
+                summary.push(`[${index + 1}] ${colors_1.default.red.bold(block.filePath)} ${colors_1.default.red.bold(`cannot be applied: Current content matches multiple (${matchingLines.length}) parts in the file`)}`);
+            }
+            else {
+                summary.push(`[${index + 1}] ${colors_1.default.green.bold(block.filePath)} can be ${colors_1.default.yellow.bold('updated')}`);
+            }
         }
         else {
             summary.push(`[${index + 1}] ${colors_1.default.green.bold(block.filePath)} can be ${colors_1.default.yellow.bold('updated')}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloving",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "packageManager": "yarn@1.22.22",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,8 @@
     "watch": "tsc -w",
     "check": "bash -c 'npx tsc --noEmit --skipLibCheck'",
     "test": "bash -c jest",
-    "prepare": "husky"
+    "prepare": "husky",
+    "format": "prettier --write \"src/**/*.ts\""
   },
   "bin": "./dist/index.js",
   "files": [
@@ -23,7 +24,8 @@
   "description": "",
   "lint-staged": {
     "*.ts": [
-      "yarn run check"
+      "yarn run check",
+      "prettier --write"
     ]
   },
   "lint-prepush": {
@@ -31,7 +33,8 @@
     "tasks": {
       "*.ts": [
         "yarn run check",
-        "yarn run test"
+        "yarn run test",
+        "yarn run format"
       ]
     }
   },
@@ -42,14 +45,14 @@
     "colors": "^1.4.0",
     "commander": "^12.1.0",
     "copy-paste": "^1.5.3",
-    "eslint": "^9.9.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-raine": "^0.5.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jsdoc": "^50.1.0",
-    "eslint-plugin-n": "^17.10.2",
-    "eslint-plugin-promise": "^7.1.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.6.0",
     "express": "^4.19.2",
     "ignore": "^5.3.2",
     "ini": "^4.1.3",
@@ -70,12 +73,14 @@
     "jest": "^29.7.0",
     "lint-prepush": "^2.2.2",
     "lint-staged": "^15.2.9",
+    "prettier": "^3.2.5",
     "ts-jest": "^29.2.4",
     "typescript": "^5.5.4"
   },
   "resolutions": {
     "eslint": "8.57.0",
     "eslint-plugin-n": "16.6.2",
-    "eslint-plugin-import": "2.29.1"
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-promise": "6.6.0"
   }
 }