express-fix-any-js 1.5.3 → 1.7.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 KeshavSoft
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to do so, subject to the
-following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 KeshavSoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,79 +1,118 @@
-# EndPoints Fix
-
-Utility for automatically maintaining Express route files.
-started git actions also to https://github.com/keshavsoft/express-fix-endpoints-get-js,
-also started actions
-
-## Purpose
-
-This module updates `end-points.js` files by:
-
-* Adding new route handlers
-* Preventing duplicate routes
-* Preserving route order
-* Maintaining consistent formatting
-
----
-
-## Generated Structure
-
-```js
-import express from "express";
-
-const tableName = "BillsTable";
-
-const router = express.Router();
-
-router.post("/Alter", express.json(), (req, res) =>
-    AlterFunc({ req, res, inTablePath: tablePath })
-);
-
-export { router };
-```
-
----
-
-## Rules
-
-### First Route
-
-When the first route is inserted:
-
-* Add one blank line after `const router = express.Router();`
-* Add one blank line before `export { router };`
-
-Example:
-
-```js
-const router = express.Router();
-
-router.post("/Alter", express.json(), handler);
-
-export { router };
-```
-
-### Additional Routes
-
-New routes are always appended after the last route.
-
-Example:
-
-```js
-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
-
-If a route already exists, no new route is added.
-
----
-
-## Goal
-
-Produce clean and predictable Express route files automatically.
+# express-fix-any-js 🚀
+
+> **Instantly repair, structure, and align Express.js routing files with automated idempotency & formatting safeguards.**
+
+[![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)
+
+---
+
+## 📖 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.
+
+This module acts as the foundation layer for the **KeshavSoft API Generation Suite**, dynamically structuring routes generated via CLI or VS Code extensions.
+
+---
+
+## ✨ Features
+
+*   **🔒 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.
+
+---
+
+## 📁 Repository Integration Map
+
+`express-fix-any-js` is part of a larger cascading developer ecosystem:
+
+```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
+```
+
+---
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+npm install express-fix-any-js
+```
+
+### Programmatic Usage
+
+You can use the core `alterFile` function to modify local routes files safely:
+
+```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);
+
+export { router };
+```
+
+### 2. Multi-Route Appending
+Subsequent routes are appended directly after the last matching route with no empty line spacing between them:
+
+```javascript
+router.post("/Alter", express.json(), handler);
+router.post("/Alter1", express.json(), handler);
+router.post("/Alter2", express.json(), handler);
+```
+
+---
+
+## 🛠️ Developer & API Reference
+
+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)
+
+---
+
+## ⚖️ License
+
+MIT License. Designed with ❤️ by [KeshavSoft](https://github.com/keshavsoft).

package/bin/cli.js

@@ -1,12 +1,12 @@
-#!/usr/bin/env node
-
-import getLatestVersion from "./core/getLatestVersion.js";
-import loadRunner from "./core/loadRunner.js";
-
-const run = async ({ }) => {
-  const version = getLatestVersion();
-  const runner = await loadRunner(version);
-  await runner({});
-};
-
+#!/usr/bin/env node
+
+import getLatestVersion from "./core/getLatestVersion.js";
+import loadRunner from "./core/loadRunner.js";
+
+const run = async ({ }) => {
+  const version = getLatestVersion();
+  const runner = await loadRunner(version);
+  await runner({});
+};
+
 run({}).then();

package/bin/core/getLatestVersion.js

@@ -1,13 +1,13 @@
-import fs from "fs";
-import path from "path";
-import { fileURLToPath } from "url";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-export default function getLatestVersion() {
-    const versions = fs.readdirSync(path.join(__dirname, ".."))
-        .filter(n => /^v\d+$/.test(n))
-        .sort((a, b) => parseInt(a.slice(1)) - parseInt(b.slice(1)));
-
-    return versions.at(-1);
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export default function getLatestVersion() {
+    const versions = fs.readdirSync(path.join(__dirname, ".."))
+        .filter(n => /^v\d+$/.test(n))
+        .sort((a, b) => parseInt(a.slice(1)) - parseInt(b.slice(1)));
+
+    return versions.at(-1);
 };

package/bin/core/loadRunner.js

@@ -1,9 +1,9 @@
-export default async function loadRunner(version) {
-    const mod = await import(`../${version}/start.js`);
-
-    if (typeof mod.default !== "function") {
-        throw new Error(`Invalid start.js in ${version}`);
-    }
-
-    return mod.default;
+export default async function loadRunner(version) {
+    const mod = await import(`../${version}/start.js`);
+
+    if (typeof mod.default !== "function") {
+        throw new Error(`Invalid start.js in ${version}`);
+    }
+
+    return mod.default;
 };

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

@@ -1,27 +1,27 @@
-const startFunc = ({
-    content,
-    insertInfo,
-    toInsertLine,
-    insertAfter
-}) => {
-    const before = content.slice(0, insertInfo.index);
-
-    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 +
-        "\n" +
-        content.slice(insertInfo.index);
-};
-
+const startFunc = ({
+    content,
+    insertInfo,
+    toInsertLine,
+    insertAfter
+}) => {
+    const before = content.slice(0, insertInfo.index);
+
+    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 +
+        "\n" +
+        content.slice(insertInfo.index);
+};
+
 export default startFunc;

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/{v5 → v6}/UpdateJs/common/AlterFile/findInsertIndex.js

@@ -1,30 +1,30 @@
-const findInsertIndex = ({
-    inContent,
-    inPatterns = []
-}) => {
-    const lines = inContent.split("\n");
-
-    let lineNumber = -1;
-    let matchedPattern = null;
-
-    lines.forEach((line, index) => {
-        const pattern = inPatterns.find(item => line.includes(item));
-
-        if (pattern) {
-            lineNumber = index;
-            matchedPattern = pattern;
-        };
-    });
-
-    return {
-        index: lineNumber === -1
-            ? -1
-            : lines
-                .slice(0, lineNumber + 1)
-                .join("\n")
-                .length + 1,
-        matchedPattern
-    };
-};
-
+const findInsertIndex = ({
+    inContent,
+    inPatterns = []
+}) => {
+    const lines = inContent.split("\n");
+
+    let lineNumber = -1;
+    let matchedPattern = null;
+
+    lines.forEach((line, index) => {
+        const pattern = inPatterns.find(item => line.includes(item));
+
+        if (pattern) {
+            lineNumber = index;
+            matchedPattern = pattern;
+        };
+    });
+
+    return {
+        index: lineNumber === -1
+            ? -1
+            : lines
+                .slice(0, lineNumber + 1)
+                .join("\n")
+                .length + 1,
+        matchedPattern
+    };
+};
+
 export default findInsertIndex;

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

@@ -1,55 +1,55 @@
-import readFile from "../readFile.js";
-import checkDuplicate from "./checkDuplicate.js";
-import findInsertIndex from "./findInsertIndex.js";
-import writeFile from "../writeFile.js";
-
-import buildUpdatedContent from "./buildUpdatedContent.js";
-
-const locateInsertPoint = ({ content, insertAfter }) => {
-    return findInsertIndex({
-        inContent: content,
-        inPatterns: insertAfter
-    });
-};
-
-const alterFile = ({
-    jsFilePath,
-    toInsertLine,
-    duplicationCheck,
-    insertAfter = [],
-    showLog = false
-}) => {
-    const content = readFile(jsFilePath);
-
-    const duplicateInfo = checkDuplicate({
-        inContent: content,
-        inFilePath: jsFilePath,
-        inSearchText: duplicationCheck
-    });
-
-    if (duplicateInfo.found) {
-        if (showLog) {
-            console.log(
-                `Duplicate found at line ${duplicateInfo.lineNumber}`
-            );
-        }
-
-        return duplicateInfo;
-    };
-
-    const insertInfo = locateInsertPoint({
-        content,
-        insertAfter
-    });
-
-    const updated = buildUpdatedContent({
-        content,
-        insertInfo,
-        toInsertLine,
-        insertAfter
-    });
-
-    writeFile(jsFilePath, updated);
-};
-
+import readFile from "../readFile.js";
+import checkDuplicate from "./checkDuplicate.js";
+import findInsertIndex from "./findInsertIndex.js";
+import writeFile from "../writeFile.js";
+
+import buildUpdatedContent from "./buildUpdatedContent.js";
+
+const locateInsertPoint = ({ content, insertAfter }) => {
+    return findInsertIndex({
+        inContent: content,
+        inPatterns: insertAfter
+    });
+};
+
+const alterFile = ({
+    jsFilePath,
+    toInsertLine,
+    duplicationCheck,
+    insertAfter = [],
+    showLog = false
+}) => {
+    const content = readFile(jsFilePath);
+
+    const duplicateInfo = checkDuplicate({
+        inContent: content,
+        inFilePath: jsFilePath,
+        inSearchText: duplicationCheck
+    });
+
+    if (duplicateInfo.found) {
+        if (showLog) {
+            console.log(
+                `Duplicate found at line ${duplicateInfo.lineNumber}`
+            );
+        }
+
+        return duplicateInfo;
+    };
+
+    const insertInfo = locateInsertPoint({
+        content,
+        insertAfter
+    });
+
+    const updated = buildUpdatedContent({
+        content,
+        insertInfo,
+        toInsertLine,
+        insertAfter
+    });
+
+    writeFile(jsFilePath, updated);
+};
+
 export default alterFile;

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

@@ -1,8 +1,8 @@
-import fs from "fs";
-
-const readFile = (inAppJsPath) => {
-    const localPath = inAppJsPath;
-    return fs.readFileSync(localPath, "utf-8");
-};
-
+import fs from "fs";
+
+const readFile = (inAppJsPath) => {
+    const localPath = inAppJsPath;
+    return fs.readFileSync(localPath, "utf-8");
+};
+
 export default readFile;

package/bin/{v5 → v6}/UpdateJs/common/writeFile.js

@@ -1,10 +1,10 @@
-import fs from "fs";
-
-const writeFile = (inAppJsPath, inContent) => {
-    const localPath = inAppJsPath;
-    const localContent = inContent;
-
-    fs.writeFileSync(localPath, localContent);
-};
-
+import fs from "fs";
+
+const writeFile = (inAppJsPath, inContent) => {
+    const localPath = inAppJsPath;
+    const localContent = inContent;
+
+    fs.writeFileSync(localPath, localContent);
+};
+
 export default writeFile;

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

@@ -1,30 +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);
-
-    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;
-};
-
+import alterFile from "./common/AlterFile/index.js";
+import validateCheckLines from "./validateCheckLines.js";
+
+const updateAppJs = ({ inJsFilePath, inCheckLines,
+    showLog = false }) => {
+
+    const localCheckLines = inCheckLines;
+    
+    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;