@sujithx1/optimizeguard 1.0.1 → 1.0.3

package/README.md

@@ -1,11 +1,69 @@
-To install dependencies:
-```sh
-bun install
-```
+# 🚀 OptimizeGuard
+
+OptimizeGuard is a lightweight **code optimization guard** that helps developers check whether their code is **optimized, safe, and type-correct before committing or pushing**.
+
+It runs with **one simple command** and gives **clear, human-readable feedback** — no complex setup needed.
+
+---
+
+## 🌟 Why OptimizeGuard?
+
+Many code issues are found **after pushing** or during **code review**.
+OptimizeGuard catches them **early**, right on your machine.
+
+✔ Faster feedback  
+✔ Cleaner commits  
+✔ Better code quality  
+✔ Developer-friendly output  
+
+---
+
+## 🔍 What does it check?
+
+### ⚡ Performance
+- `await` inside loops
+- Blocking or inefficient patterns
+
+### 🧠 Type Safety
+- Usage of `any`
+- Unsafe or missing TypeScript types
+
+### 🔐 Security
+- Hardcoded secrets
+- `eval()` and unsafe executions
+
+### 🧹 Code Quality
+- Common anti-patterns
+- Unoptimized logic hints
+
+---
+
+## 📦 Installation
+
+```bash
+npm install -g @sujithx1/optimizeguard
+
+
+▶️ Usage
+optimizeguard
+
+Example output
+❌ OptimizeGuard failed
+
+• Performance issue: await inside loop (src/api/user.ts)
+• Type issue: usage of 'any' (src/services/auth.ts)
+
+Fix the issues and try again.
+
+
+If everything is good:
+✅ OptimizeGuard passed
+Your code is optimized and safe to commit 🎉
+
+
+🔗 Use as Pre-Commit Hook (Recommended)
+
+Automatically block bad commits.
+npx husky add .husky/pre-commit "optimizeguard"
 
-To run:
-```sh
-bun run dev
-```
 
-open http://localhost:3000

package/bun.lock

@@ -1,5 +1,6 @@
 {
   "lockfileVersion": 1,
+  "configVersion": 0,
   "workspaces": {
     "": {
       "name": "sdk-server",

package/package.json

@@ -1,6 +1,6 @@
 {
 "name": "@sujithx1/optimizeguard",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "type": "module",
   
   "bin": {

package/sdk.md

@@ -1,5 +1,5 @@
-84f314b3ed646e5b431a36dd5aae66d0e10c67e5397c25c4b6ca3b58b6626d0f
-9130c7d5e62160aaa72e33696b4282ed4b9f73f2a8e13925caaaf167fd0de31f
-d2456011201d030099de954eda56a8be9ab94d32e87241b19cbce98ad7a1d410
-c2b041f9d8a7f333350d8233c4357eaa3398ccc51aa3dd2d20dc46c552450947
+84f314b3ed646e5b431a36dd5aae66d0e10c67e5397c25c4b6ca3b58b6626d0f
+9130c7d5e62160aaa72e33696b4282ed4b9f73f2a8e13925caaaf167fd0de31f
+d2456011201d030099de954eda56a8be9ab94d32e87241b19cbce98ad7a1d410
+c2b041f9d8a7f333350d8233c4357eaa3398ccc51aa3dd2d20dc46c552450947
 56bea1d7da7273c042fef8764f82e7e6e89e36e32abdf40f9f320bf5be9e8ab7

package/src/cli.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env bun
-import { runOptimizeGuard } from "./engine.js";
-
-const result = await runOptimizeGuard();
-
-if (!result.ok) process.exit(1);
+import { runOptimizeGuard } from "./engine.js";
+
+const result = await runOptimizeGuard();
+
+if (!result.ok) process.exit(1);

package/src/engine.ts

@@ -1,14 +1,14 @@
-import { scanProject } from "./scanner.js";
-import { runRules } from "./rules/index.js";
-import { report } from "./rules/reporter.js";
-
-export async function runOptimizeGuard() {
-  console.log("⚡ OptimizeGuard v1 running...\n");
-
-  const files = await scanProject();
-  const issues = await runRules(files);
-
-  report(issues);
-
-  return { ok: issues.length === 0 };
-}
+import { scanProject } from "./scanner.js";
+import { runRules } from "./rules/index.js";
+import { report } from "./rules/reporter.js";
+
+export async function runOptimizeGuard() {
+  console.log("⚡ OptimizeGuard v1 running...\n");
+
+  const files = await scanProject();
+  const issues = await runRules(files);
+
+  report(issues);
+
+  return { ok: issues.length === 0 };
+}

package/src/rules/index.ts

@@ -1,16 +1,16 @@
-import { perfRules } from "./performance";
-import { securityRules } from "./security";
-import { typeRules } from "./type";
-
-export async function runRules(files: string[]) {
-  const all = [...perfRules, ...securityRules, ...typeRules];
-  const issues: any[] = [];
-
-  for (const file of files) {
-    for (const rule of all) {
-      issues.push(...(await rule.check(file)));
-    }
-  }
-
-  return issues;
-}
+import { perfRules } from "./performance";
+import { securityRules } from "./security";
+import { typeRules } from "./type";
+
+export async function runRules(files: string[]) {
+  const all = [...perfRules, ...securityRules, ...typeRules];
+  const issues: any[] = [];
+
+  for (const file of files) {
+    for (const rule of all) {
+      issues.push(...(await rule.check(file)));
+    }
+  }
+
+  return issues;
+}

package/src/rules/performance.ts

@@ -1,12 +1,12 @@
-import * as fs from "fs";
-export const perfRules = [
-  {
-    name: "await-in-loop",
-    async check(file: string) {
-      const content = fs.readFileSync(file, "utf8");
-      return /for\s*\(.*\)\s*{[\s\S]*await/.test(content)
-        ? [{ type: "PERF", file, msg: "await inside loop" }]
-        : [];
-    },
-  },
-];
+import * as fs from "fs";
+export const perfRules = [
+  {
+    name: "await-in-loop",
+    async check(file: string) {
+      const content = fs.readFileSync(file, "utf8");
+      return /for\s*\(.*\)\s*{[\s\S]*await/.test(content)
+        ? [{ type: "PERF", file, msg: "await inside loop" }]
+        : [];
+    },
+  },
+];

package/src/rules/reporter.ts

@@ -1,9 +1,9 @@
-export function report(issues: any[]) {
-  if (!issues.length) return console.log("✅ Code is optimized and safe!\n");
-
-  for (const i of issues) {
-    console.log(`❌ [${i.type}] ${i.msg} → ${i.file}`);
-  }
-
-  console.log(`\nScore: ${Math.max(0, 100 - issues.length * 5)} / 100`);
-}
+export function report(issues: any[]) {
+  if (!issues.length) return console.log("✅ Code is optimized and safe!\n");
+
+  for (const i of issues) {
+    console.log(`❌ [${i.type}] ${i.msg} → ${i.file}`);
+  }
+
+  console.log(`\nScore: ${Math.max(0, 100 - issues.length * 5)} / 100`);
+}

package/src/rules/security.ts

@@ -1,13 +1,13 @@
-import * as fs from "fs";
-
-export const securityRules = [
-  {
-    name: "hardcoded-secret",
-    async check(file: string) {
-      const content = fs.readFileSync(file, "utf8");
-      return /(API_KEY|SECRET|TOKEN)\s*=\s*['"]/i.test(content)
-        ? [{ type: "SEC", file, msg: "Hardcoded secret detected" }]
-        : [];
-    },
-  },
-];
+import * as fs from "fs";
+
+export const securityRules = [
+  {
+    name: "hardcoded-secret",
+    async check(file: string) {
+      const content = fs.readFileSync(file, "utf8");
+      return /(API_KEY|SECRET|TOKEN)\s*=\s*['"]/i.test(content)
+        ? [{ type: "SEC", file, msg: "Hardcoded secret detected" }]
+        : [];
+    },
+  },
+];

package/src/rules/type.ts

@@ -1,23 +1,23 @@
-// src/rules/types.ts
-import { execSync } from "child_process";
-
-export const typeRules = [
-  {
-    name: "typescript-check",
-    async check(_file: string) {
-      try {
-        // Run tsc in noEmit mode
-        execSync("tsc --noEmit", { stdio: "pipe" });
-        return [];
-      } catch (e: any) {
-        // Extract errors
-        const output = e.stdout?.toString() || e.message || "Type check failed";
-        const errors = output
-          .split("\n")
-          .filter((line: string) => line.trim() !== "")
-          .map((line: string) => ({ type: "TYPE", file: "ts", msg: line }));
-        return errors;
-      }
-    },
-  },
-];
+// src/rules/types.ts
+import { execSync } from "child_process";
+
+export const typeRules = [
+  {
+    name: "typescript-check",
+    async check(_file: string) {
+      try {
+        // Run tsc in noEmit mode
+        execSync("tsc --noEmit", { stdio: "pipe" });
+        return [];
+      } catch (e: any) {
+        // Extract errors
+        const output = e.stdout?.toString() || e.message || "Type check failed";
+        const errors = output
+          .split("\n")
+          .filter((line: string) => line.trim() !== "")
+          .map((line: string) => ({ type: "TYPE", file: "ts", msg: line }));
+        return errors;
+      }
+    },
+  },
+];

package/src/scanner.ts

@@ -1,5 +1,18 @@
-import {glob} from "glob";
-
-export async function scanProject() {
-  return glob.sync("**/*.{ts,js}", { ignore: ["node_modules/**", "dist/**"] });
-}
+
+import { glob } from "glob";
+
+import fs from "node:fs";
+
+export async function scanProject() {
+
+  if(!fs.existsSync('src'))
+  {
+    console.log('🚫 No src folder found. Please run this command from the root of your project or Skiping Scan.')
+    return []
+  }
+
+
+  return glob("src/**/*.{ts,tsx,js,jsx}", {
+    nodir: true,
+  });
+}