errorxplain 1.0.0 → 1.1.0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Surya Shashank Neupane
+
+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 whom the Software is
+furnished 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

@@ -2,6 +2,9 @@
 
 Intelligent Error Explainer CLI & Middleware for backend developers.
 
+<img src="cover.png" alt="Alt text" width="800" height="500">
+
+
 ## Installation
 
 ```bash

package/lib/{rules/rules.json → default_rules.json}

@@ -1,4 +1,4 @@
-[
+{"rules": [
   {
     "pattern": "ECONNREFUSED",
     "meaning": "Connection refused by target service",
@@ -284,4 +284,4 @@
     "meaning": "Promise rejection not handled",
     "fix": "Add catch handlers for promises"
   }
-]
+]}

package/lib/engine.js

@@ -1,88 +1,41 @@
 import fs from "fs";
 import path from "path";
+import { fileURLToPath } from "url";
+import { loadRules, getRules } from "./rules.js";
 
-let rules = [];
+// __dirname fix
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-// Path to JSON rules
-const rulesFile = path.resolve("./lib/rules/rules.json");
+const LOGS_DIR = path.join(process.cwd(), "logs");
+if (!fs.existsSync(LOGS_DIR)) fs.mkdirSync(LOGS_DIR);
 
-// Track last read position for each log file
-const filePositions = {};
-
-// Load rules from JSON and convert patterns to RegExp
-function loadRules() {
-  try {
-    const rawRules = JSON.parse(fs.readFileSync(rulesFile, "utf8"));
-    rules = rawRules.map(r => ({ ...r, pattern: new RegExp(r.pattern) }));
-    console.log(`Loaded ${rules.length} error rules`);
-  } catch (err) {
-    console.error("Failed to load rules.json:", err.message);
-  }
-}
-
-// Initial load
+// Load rules once at startup
 loadRules();
 
-// Hot-reload rules whenever rules.json changes
-fs.watchFile(rulesFile, { interval: 1000 }, () => {
-  console.log("Detected change in rules.json, reloading rules...");
-  loadRules();
-});
-
-// Explain a single error
-export function explainError(errorText) {
-  const match = rules.find(r => r.pattern.test(errorText));
-  if (match) return match;
-  return { meaning: "Unknown error", fix: "Search documentation or logs" };
+function applyRules(logContent) {
+    const rules = getRules();
+    rules.forEach((rule) => {
+        if (logContent.includes(rule.pattern)) {
+            console.log(`   Detected: ${rule.pattern}`);
+            console.log(`   Meaning: ${rule.meaning}`);
+            console.log(`   Fix: ${rule.fix}\n`);
+        }
+    });
 }
 
-// Watch logs in real-time
-export function watchLogs(logDir) {
-  // Ensure folder exists
-  if (!fs.existsSync(logDir)) {
-    fs.mkdirSync(logDir, { recursive: true });
-    console.log(`Created missing logs folder at ${logDir}`);
-  }
-
-  console.log(`Watching logs at ${logDir}...`);
-
-  fs.watch(logDir, (eventType, filename) => {
-    if (!filename) return;
-
-    const filePath = path.join(logDir, filename);
-
-    // Initialize last position
-    if (!filePositions[filePath]) filePositions[filePath] = 0;
-
-    fs.stat(filePath, (err, stats) => {
-      if (err) return console.error("Stat error:", err.message);
-
-      const prevSize = filePositions[filePath];
-      const newSize = stats.size;
-
-      // Only read new content
-      if (newSize > prevSize) {
-        const stream = fs.createReadStream(filePath, {
-          start: prevSize,
-          end: newSize
-        });
-
-        let data = "";
-        stream.on("data", chunk => (data += chunk));
-        stream.on("end", () => {
-          filePositions[filePath] = newSize;
-
-          const lines = data.split("\n").filter(line => line.trim() !== "");
-          lines.forEach(line => {
-            const explanation = explainError(line);
-            if (explanation.meaning !== "Unknown error") {
-              console.log("\nDetected Error:\n", explanation, "\n");
-            }
-          });
-        });
+// Watch logs folder
+fs.watch(LOGS_DIR, (eventType, filename) => {
+    if (filename && eventType === "change") {
+        const filePath = path.join(LOGS_DIR, filename);
+        try {
+            const logContent = fs.readFileSync(filePath, "utf-8");
+            console.log(`\nDetected change in ${filename}`);
+            applyRules(logContent);
+        } catch (err) {
+            console.error(`Failed to read ${filename}:`, err.message);
+        }
+    }
+});
 
-        stream.on("error", e => console.error("Stream error:", e.message));
-      }
-    });
-  });
-}
+console.log(`Watching logs at ${LOGS_DIR}...`);

package/lib/rules.js

@@ -0,0 +1,27 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+// __dirname fix for ES Modules
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Point to the new bundled file
+const defaultRulesPath = path.join(__dirname, "default_rules.json");
+
+let rulesCache = [];
+
+export function loadRules() {
+    try {
+        const data = fs.readFileSync(defaultRulesPath, "utf-8");
+        rulesCache = JSON.parse(data).rules;
+        console.log(`Loaded ${rulesCache.length} bundled rules`);
+    } catch (err) {
+        console.error("Failed to load bundled rules:", err.message);
+        rulesCache = [];
+    }
+}
+
+export function getRules() {
+    return rulesCache;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "errorxplain",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Intelligent Error Explainer CLI & Middleware for backend developers",
   "main": "lib/engine.js",
   "bin": {