express-fix-any-js 1.4.2 → 1.7.2

package/README.md

@@ -1,50 +1,91 @@
-# EndPoints Fix
+# express-fix-any-js 🚀
 
-Utility for automatically maintaining Express route files.
-started git actions also to https://github.com/keshavsoft/express-fix-endpoints-get-js,
-also started actions
+> **Instantly repair, structure, and align Express.js routing files with automated idempotency & formatting safeguards.**
 
-## Purpose
+[![npm version](https://img.shields.io/npm/v/express-fix-any-js.svg?style=flat-square&color=38bdf8)](https://www.npmjs.com/package/express-fix-any-js)
+[![license](https://img.shields.io/npm/l/express-fix-any-js.svg?style=flat-square&color=34d399)](LICENSE)
+[![GitHub workflows](https://img.shields.io/github/actions/workflow/status/keshavsoft/express-fix-any-js/npm-publish.yml?style=flat-square&label=workflows)](https://github.com/keshavsoft/express-fix-any-js/actions)
 
-This module updates `end-points.js` files by:
+---
+
+## 📖 Overview
+
+`express-fix-any-js` is a lightweight, high-performance JS AST and file modifier utility. It automatically injects missing Express.js route declarations, import statements, and export configurations into your JavaScript files while ensuring complete protection against code duplication.
 
-* Adding new route handlers
-* Preventing duplicate routes
-* Preserving route order
-* Maintaining consistent formatting
+This module acts as the foundation layer for the **KeshavSoft API Generation Suite**, dynamically structuring routes generated via CLI or VS Code extensions.
 
 ---
 
-## Generated Structure
+## ✨ Features
 
-```js
-import express from "express";
+*   **🔒 Duplicate Prevention (Idempotency)**: Checks files before altering them. If a route or pattern already exists, it skips execution silently to avoid code corruption.
+*   **📐 Strict Route Formatting**:
+    *   Inserts clean line spaces after `express.Router()` initialization.
+    *   Maintains zero-line spacing between consecutive route definitions.
+    *   Appends spacing cleanly before the `export` keyword.
+*   **⚡ Multiple File Versions (V1 - V6)**: Supports legacy configuration modifications alongside cutting-edge AST-based insertions.
+*   **🛠️ Developer-First Diagnostics**: Provides clear inline logging of file updates and duplicate line match warnings.
 
-const tableName = "BillsTable";
+---
 
-const router = express.Router();
+## 📁 Repository Integration Map
 
-router.post("/Alter", express.json(), (req, res) =>
-    AlterFunc({ req, res, inTablePath: tablePath })
-);
+`express-fix-any-js` is part of a larger cascading developer ecosystem:
 
-export { router };
+```mermaid
+graph TD
+    ext["vs-code-ext-express-api-gen-get-actions<br/><i>VS Code Extension</i>"]
+    
+    gen["kschema-fs-api-gen-get-actions<br/><i>API Generator Actions</i>"]
+    
+    endpoints["express-fix-endpoints-get-js<br/><i>Endpoint Logic Builder</i>"]
+    
+    anyjs["express-fix-any-js<br/><i>This Core Utility</i>"]
+
+    ext -->|delegates to| gen
+    gen -->|invokes| endpoints
+    endpoints -->|relies on| anyjs
 ```
 
 ---
 
-## Rules
+## 🚀 Quick Start
 
-### First Route
+### Installation
 
-When the first route is inserted:
+```bash
+npm install express-fix-any-js
+```
 
-* Add one blank line after `const router = express.Router();`
-* Add one blank line before `export { router };`
+### Programmatic Usage
 
-Example:
+You can use the core `alterFile` function to modify local routes files safely:
 
-```js
+```javascript
+import alterFile from 'express-fix-any-js/bin/v6/UpdateJs/common/AlterFile/index.js';
+
+alterFile({
+  jsFilePath: './routes/end-points.js',
+  toInsertLine: 'router.post("/Create", express.json(), CreateFunc);',
+  duplicationCheck: 'router.post("/Create"',
+  insertAfter: [
+    'const router = express.Router();',
+    'router.post("/Alter"' // Inserts immediately after this line if found, otherwise after Router init
+  ],
+  showLog: true
+});
+```
+
+---
+
+## 📜 Structuring Rules
+
+The utility operates under strict structural rules to preserve route aesthetics:
+
+### 1. First Route Placement
+When the first route is inserted into an empty routing structure, the file is formatted with breathing space:
+
+```javascript
 const router = express.Router();
 
 router.post("/Alter", express.json(), handler);
@@ -52,28 +93,26 @@ router.post("/Alter", express.json(), handler);
 export { router };
 ```
 
-### Additional Routes
-
-New routes are always appended after the last route.
+### 2. Multi-Route Appending
+Subsequent routes are appended directly after the last matching route with no empty line spacing between them:
 
-Example:
-
-```js
+```javascript
 router.post("/Alter", express.json(), handler);
 router.post("/Alter1", express.json(), handler);
 router.post("/Alter2", express.json(), handler);
 ```
 
-No blank lines are inserted between routes.
-
 ---
 
-## Duplicate Protection
+## 🛠️ Developer & API Reference
 
-If a route already exists, no new route is added.
+For detailed developer notes, architectural mappings, and code analyses:
+*   [Developer Docs Home](./docs/index.html)
+*   [Code Style & Readability Analysis](./docs/code_style_and_readability.md)
+*   [AlterFile Workflow Analysis](./docs/alter_file_analysis.md)
 
 ---
 
-## Goal
+## ⚖️ License
 
-Produce clean and predictable Express route files automatically.
+MIT License. Designed with ❤️ by [KeshavSoft](https://github.com/keshavsoft).

package/bin/{v4 → v6}/UpdateJs/common/AlterFile/buildUpdatedContent.js

@@ -9,6 +9,14 @@ const startFunc = ({
     const isFirstInsert =
         insertInfo.matchedPattern === insertAfter[insertAfter.length - 1];
 
+    if (Array.isArray(toInsertLine)) {
+        return before +
+            (isFirstInsert ? "\n" : "") +
+            toInsertLine.join("\n") +
+            "\n" +
+            content.slice(insertInfo.index);
+    }
+
     return before +
         (isFirstInsert ? "\n" : "") +
         toInsertLine +

package/bin/v6/UpdateJs/common/AlterFile/checkDuplicate.js

@@ -0,0 +1,14 @@
+import { isImportPresent } from "express-check-any-for-import";
+
+const checkUseDuplicate = ({ inContent, inFilePath, inSearchText }) => {
+    const cleanText = inSearchText.match(/['"]([^'"]+)['"]/)?.[1] || inSearchText;
+    const found = isImportPresent(inContent, cleanText) || inContent.includes(inSearchText);
+
+    return {
+        found,
+        filePath: inFilePath,
+        lineNumber: found ? inContent.split("\n").findIndex(line => line.includes(cleanText)) + 1 : null
+    };
+};
+
+export default checkUseDuplicate;

package/bin/{v3 → v6}/UpdateJs/index.js

@@ -1,13 +1,12 @@
-// v2/AppJs/index.js
-
-import checkLines from "./checkLines.json" with {type: "json"};
 import alterFile from "./common/AlterFile/index.js";
+import validateCheckLines from "./validateCheckLines.js";
 
 const updateAppJs = ({ inJsFilePath, inCheckLines,
     showLog = false }) => {
 
-    const localCheckLines = inCheckLines || checkLines;
-    // console.log("bbbbbbbbbbbb : ", localCheckLines);
+    const localCheckLines = inCheckLines;
+    
+    validateCheckLines(localCheckLines);
 
     alterFile({
         jsFilePath: inJsFilePath,

package/bin/v6/UpdateJs/validateCheckLines.js

@@ -0,0 +1,31 @@
+const startFunc = (obj) => {
+    if (typeof obj !== "object" || obj === null || Array.isArray(obj)) {
+        throw new TypeError("inCheckLines must be a valid object.");
+    }
+    for (const key of ["importLines", "useLines"]) {
+        if (!(key in obj)) {
+            throw new Error(`inCheckLines must contain "${key}".`);
+        }
+        const section = obj[key];
+        if (typeof section !== "object" || section === null || Array.isArray(section)) {
+            throw new TypeError(`inCheckLines.${key} must be an object.`);
+        }
+        if (key === "importLines") {
+            if (typeof section.toInsertLine !== "string" && !Array.isArray(section.toInsertLine)) {
+                throw new TypeError(`inCheckLines.importLines.toInsertLine must be a string or an array.`);
+            }
+        } else {
+            if (typeof section.toInsertLine !== "string") {
+                throw new TypeError(`inCheckLines.${key}.toInsertLine must be a string.`);
+            }
+        }
+        if (typeof section.duplicationCheck !== "string") {
+            throw new TypeError(`inCheckLines.${key}.duplicationCheck must be a string.`);
+        }
+        if (!Array.isArray(section.insertAfter)) {
+            throw new TypeError(`inCheckLines.${key}.insertAfter must be an array.`);
+        }
+    }
+};
+
+export default startFunc;

package/bin/{v3 → v7}/UpdateJs/common/AlterFile/buildUpdatedContent.js

@@ -9,6 +9,14 @@ const startFunc = ({
     const isFirstInsert =
         insertInfo.matchedPattern === insertAfter[insertAfter.length - 1];
 
+    if (Array.isArray(toInsertLine)) {
+        return before +
+            (isFirstInsert ? "\n" : "") +
+            toInsertLine.join("\n") +
+            "\n" +
+            content.slice(insertInfo.index);
+    }
+
     return before +
         (isFirstInsert ? "\n" : "") +
         toInsertLine +

package/bin/v7/UpdateJs/common/AlterFile/checkDuplicate.js

@@ -0,0 +1,14 @@
+import { isImportPresent } from "express-check-any-for-import";
+
+const checkUseDuplicate = ({ inContent, inFilePath, inSearchText }) => {
+    const cleanText = inSearchText.match(/['"]([^'"]+)['"]/)?.[1] || inSearchText;
+    const found = isImportPresent(inContent, cleanText) || inContent.includes(inSearchText);
+
+    return {
+        found,
+        filePath: inFilePath,
+        lineNumber: found ? inContent.split("\n").findIndex(line => line.includes(cleanText)) + 1 : null
+    };
+};
+
+export default checkUseDuplicate;

package/bin/{v3 → v7}/UpdateJs/common/AlterFile/index.js

@@ -37,7 +37,6 @@ const alterFile = ({
         return duplicateInfo;
     };
 
-    // const index = locateInsertPoint({ content, importInsertAfter });
     const insertInfo = locateInsertPoint({
         content,
         insertAfter
@@ -51,6 +50,12 @@ const alterFile = ({
     });
 
     writeFile(jsFilePath, updated);
+
+    return {
+        found: false,
+        filePath: jsFilePath,
+        lineNumber: null
+    };
 };
 
 export default alterFile;

package/bin/v7/UpdateJs/index.js

@@ -0,0 +1,30 @@
+import alterFile from "./common/AlterFile/index.js";
+import validateCheckLines from "./validateCheckLines.js";
+
+const updateAppJs = ({ inJsFilePath, inCheckLines,
+    showLog = false }) => {
+
+    const localCheckLines = inCheckLines;
+    
+    validateCheckLines(localCheckLines);
+
+    const importResult = alterFile({
+        jsFilePath: inJsFilePath,
+        toInsertLine: localCheckLines.importLines.toInsertLine,
+        duplicationCheck: localCheckLines.importLines.duplicationCheck,
+        insertAfter: localCheckLines.importLines.insertAfter,
+        showLog
+    });
+
+    const useResult = alterFile({
+        jsFilePath: inJsFilePath,
+        toInsertLine: localCheckLines.useLines.toInsertLine,
+        duplicationCheck: localCheckLines.useLines.duplicationCheck,
+        insertAfter: localCheckLines.useLines.insertAfter,
+        showLog
+    });
+
+    return { importResult, useResult };
+};
+
+export default updateAppJs;

package/bin/v7/UpdateJs/validateCheckLines.js

@@ -0,0 +1,31 @@
+const startFunc = (obj) => {
+    if (typeof obj !== "object" || obj === null || Array.isArray(obj)) {
+        throw new TypeError("inCheckLines must be a valid object.");
+    }
+    for (const key of ["importLines", "useLines"]) {
+        if (!(key in obj)) {
+            throw new Error(`inCheckLines must contain "${key}".`);
+        }
+        const section = obj[key];
+        if (typeof section !== "object" || section === null || Array.isArray(section)) {
+            throw new TypeError(`inCheckLines.${key} must be an object.`);
+        }
+        if (key === "importLines") {
+            if (typeof section.toInsertLine !== "string" && !Array.isArray(section.toInsertLine)) {
+                throw new TypeError(`inCheckLines.importLines.toInsertLine must be a string or an array.`);
+            }
+        } else {
+            if (typeof section.toInsertLine !== "string") {
+                throw new TypeError(`inCheckLines.${key}.toInsertLine must be a string.`);
+            }
+        }
+        if (typeof section.duplicationCheck !== "string") {
+            throw new TypeError(`inCheckLines.${key}.duplicationCheck must be a string.`);
+        }
+        if (!Array.isArray(section.insertAfter)) {
+            throw new TypeError(`inCheckLines.${key}.insertAfter must be an array.`);
+        }
+    }
+};
+
+export default startFunc;

package/bin/{v4 → v7}/start.js

@@ -12,7 +12,7 @@ const run = ({ jsFilePath, inCheckLines, showLog }) => {
 
   if (input.cmd === "--help" || input.cmd === "-h" || input.cmd === "help") return showUsage(version);
 
-  updateJs(input);
+  return updateJs(input);
 };
 
 export default run;

package/index.js

@@ -1,11 +1,21 @@
 import getLatestVersion from "./bin/core/getLatestVersion.js";
+import startV6 from "./bin/v6/start.js";
+import startV7 from "./bin/v7/start.js";
 
-const load = async ({ jsFilePath, inCheckLines, showLog }) => {
+const runners = {
+    v6: startV6,
+    v7: startV7
+};
+
+const load = ({ jsFilePath, inCheckLines, showLog }) => {
     const v = getLatestVersion();
+    const runner = runners[v];
 
-    const module = await import(`./bin/${v}/start.js`);
+    if (!runner) {
+        throw new Error(`Unsupported version: ${v}`);
+    }
 
-    await module.default({ jsFilePath, inCheckLines, showLog });
+    return runner({ jsFilePath, inCheckLines, showLog });
 };
 
-export default load;
+export default load;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-fix-any-js",
-  "version": "1.4.2",
+  "version": "1.7.2",
   "description": "CLI to build for appjs, the endpoints",
   "keywords": [
     "cli",
@@ -9,7 +9,9 @@
     "node",
     "project-generator"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "express-check-any-for-import": "file:../ks1/express-check-any-for-import"
+  },
   "type": "module",
   "exports": {
     ".": "./index.js"

package/bin/v3/UpdateJs/checkLines.json

@@ -1,18 +0,0 @@
-{
-    "importLines": {
-        "toInsertLine": "import funcFrom${endpoint} from './${endpoint}/controller.js';",
-        "duplicationCheck": "from './${endpoint}/controller.js'",
-        "insertAfter": [
-            "import funcFrom",
-            "import express"
-        ]
-    },
-    "useLines": {
-        "toInsertLine": "router.post('/${endpoint}', express.json(), (req, res) => funcFrom${endpoint}({ req, res, inTablePath: tablePath }));",
-        "duplicationCheck": "router.use('/${endpoint}'",
-        "insertAfter": [
-            "router.",
-            "const router = "
-        ]
-    }
-}

package/bin/v3/UpdateJs/common/AlterFile/checkDuplicate.js

@@ -1,21 +0,0 @@
-const checkUseDuplicate = ({
-    inContent,
-    inFilePath,
-    inSearchText
-}) => {
-    const lines = inContent.split("\n");
-
-    const lineIndex = lines.findIndex(line =>
-        line.includes(inSearchText)
-    );
-
-    return {
-        found: lineIndex !== -1,
-        filePath: inFilePath,
-        lineNumber: lineIndex !== -1
-            ? lineIndex + 1
-            : null
-    };
-};
-
-export default checkUseDuplicate;

package/bin/v3/core/createFolder.js

@@ -1,34 +0,0 @@
-import fs from "fs";
-
-export const createFolder = ({ source, destination, checkBeforeCreate = false, isAnnounce = true }) => {
-    if (checkBeforeCreate) {
-        return createFolderWithCheck({ source, destination, isAnnounce });
-    } else {
-        return createOnly({ source, destination });
-    };
-};
-
-const createOnly = ({ source, destination }) => {
-    fs.mkdirSync(destination, { recursive: true });
-
-    fs.cpSync(source, destination, { recursive: true });
-
-    return {
-        KTF: true
-    };
-};
-
-const createFolderWithCheck = ({ source, destination, isAnnounce }) => {
-    if (fs.existsSync(destination)) {
-        if (isAnnounce) console.log("Folder already exists :", destination);
-
-        return {
-            KTF: false,
-            KReason: "Folder already exists"
-        };
-    };
-
-    if (isAnnounce) console.log("Folder created :", destination);
-
-    return createOnly({ source, destination });
-};

package/bin/v4/UpdateJs/checkLines.json

@@ -1,18 +0,0 @@
-{
-    "importLines": {
-        "toInsertLine": "import funcFrom${endpoint} from './${endpoint}/controller.js';",
-        "duplicationCheck": "from './${endpoint}/controller.js'",
-        "insertAfter": [
-            "import funcFrom",
-            "import express"
-        ]
-    },
-    "useLines": {
-        "toInsertLine": "router.post('/${endpoint}', express.json(), (req, res) => funcFrom${endpoint}({ req, res, inTablePath: tablePath }));",
-        "duplicationCheck": "router.use('/${endpoint}'",
-        "insertAfter": [
-            "router.",
-            "const router = "
-        ]
-    }
-}

package/bin/v4/UpdateJs/common/AlterFile/checkDuplicate.js

@@ -1,21 +0,0 @@
-const checkUseDuplicate = ({
-    inContent,
-    inFilePath,
-    inSearchText
-}) => {
-    const lines = inContent.split("\n");
-
-    const lineIndex = lines.findIndex(line =>
-        line.includes(inSearchText)
-    );
-
-    return {
-        found: lineIndex !== -1,
-        filePath: inFilePath,
-        lineNumber: lineIndex !== -1
-            ? lineIndex + 1
-            : null
-    };
-};
-
-export default checkUseDuplicate;

package/bin/v4/UpdateJs/index.js

@@ -1,56 +0,0 @@
-// v2/AppJs/index.js
-
-import checkLines from "./checkLines.json" with {type: "json"};
-import alterFile from "./common/AlterFile/index.js";
-
-const validateCheckLines = (obj) => {
-    if (typeof obj !== "object" || obj === null || Array.isArray(obj)) {
-        throw new TypeError("inCheckLines must be a valid object.");
-    }
-    for (const key of ["importLines", "useLines"]) {
-        if (!(key in obj)) {
-            throw new Error(`inCheckLines must contain "${key}".`);
-        }
-        const section = obj[key];
-        if (typeof section !== "object" || section === null || Array.isArray(section)) {
-            throw new TypeError(`inCheckLines.${key} must be an object.`);
-        }
-        if (typeof section.toInsertLine !== "string") {
-            throw new TypeError(`inCheckLines.${key}.toInsertLine must be a string.`);
-        }
-        if (typeof section.duplicationCheck !== "string") {
-            throw new TypeError(`inCheckLines.${key}.duplicationCheck must be a string.`);
-        }
-        if (!Array.isArray(section.insertAfter)) {
-            throw new TypeError(`inCheckLines.${key}.insertAfter must be an array.`);
-        }
-    }
-};
-
-const updateAppJs = ({ inJsFilePath, inCheckLines,
-    showLog = false }) => {
-
-    const localCheckLines = (inCheckLines && Object.keys(inCheckLines).length > 0) ? inCheckLines : checkLines;
-    
-    validateCheckLines(localCheckLines);
-
-    alterFile({
-        jsFilePath: inJsFilePath,
-        toInsertLine: localCheckLines.importLines.toInsertLine,
-        duplicationCheck: localCheckLines.importLines.duplicationCheck,
-        insertAfter: localCheckLines.importLines.insertAfter,
-        showLog
-    });
-
-    alterFile({
-        jsFilePath: inJsFilePath,
-        toInsertLine: localCheckLines.useLines.toInsertLine,
-        duplicationCheck: localCheckLines.useLines.duplicationCheck,
-        insertAfter: localCheckLines.useLines.insertAfter,
-        showLog
-    });
-
-    return false;
-};
-
-export default updateAppJs;