summariser v2

Author: libinvbabu

README.md

@@ -0,0 +1,150 @@
+# Codebase Summary Bot
+
+Production-grade codebase summarizer for AI-powered code review, agent pipelines, onboarding, and repository intelligence.
+
+> Optimized for LLMs, AI agents, and automated code reviewers
+> Fully modular architecture, SaaS-ready, CI/CD friendly
+> Supports JavaScript, TypeScript, monorepos, and modern stacks
+
+---
+
+## Features
+
+* Framework detection (frontend + backend)
+* Business vs Utility service classification
+* API route extraction (public vs internal)
+* Database models & schemas extraction
+* Utility function extraction + domain classification
+* Global pattern detection (ORMs, auth, validation, state management, logging, etc)
+* Git metadata capture (SHA, branch, remote)
+* Fully pluggable as GitHub Action or SaaS microservice
+* LLM-optimized output for AI reviewers
+
+---
+
+## Installation
+
+```bash
+npm install -g codebase-summary-bot
+```
+
+Or clone the repo directly:
+
+```bash
+git clone https://github.com/YOUR-ORG/codebase-summary-bot.git
+cd codebase-summary-bot
+npm install
+```
+
+---
+
+## Usage
+
+From your project root directory:
+
+```bash
+codebase-summary-bot
+```
+
+### CLI Options:
+
+| Option     | Description            | Default                 |
+| ---------- | ---------------------- | ----------------------- |
+| `--output` | Output file path       | `codebase-summary.json` |
+| `--limit`  | Max items per category | `100`                   |
+
+Example:
+
+```bash
+codebase-summary-bot --output=./summary.json --limit=50
+```
+
+---
+
+## Output Structure
+
+The bot generates a fully LLM-ready JSON summary:
+
+```json
+{
+  "schemaVersion": "3.0.0",
+  "generatedAt": "...",
+  "git": {
+    "sha": "...",
+    "branch": "...",
+    "remote": "..."
+  },
+  "modules": [...],
+  "services": {
+    "businessServices": [...],
+    "utilityServices": [...]
+  },
+  "apiRoutes": {
+    "publicRoutes": [...],
+    "internalRoutes": [...]
+  },
+  "dbModels": [...],
+  "utils": {
+    "byDomain": {...},
+    "files": [...]
+  },
+  "frameworks": {
+    "frontend": "...",
+    "backend": "..."
+  },
+  "globalPatterns": [...]
+}
+```
+
+---
+
+## Use Cases
+
+* Feed into AI code reviewers
+* Boost LLM agents with repository context
+* Automated pull request quality gates
+* Onboarding docs for new engineers
+* SaaS pipeline integrations
+
+---
+
+## GitHub Action (Coming soon)
+
+You can embed Codebase Summary Bot into your CI:
+
+```yaml
+name: Codebase Summary
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  summarize:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: your-org/codebase-summary-bot@v3
+```
+
+---
+
+## Technology Stack
+
+* Node.js (async / promise-based)
+* Fast-glob (fast concurrent filesystem traversal)
+* Modular extractor architecture
+* SaaS extensible design
+
+---
+
+## License
+
+MIT License — Fully open-source for personal & commercial use.
+
+---
+
+## Credits
+
+Built and designed for modern AI-native development pipelines.

action.yml

@@ -1,14 +1,20 @@
-name: 'Codebase Summarizer'
-description: 'Generate a production-grade codebase summary for AI code reviews'
-author: 'Your Name'
+name: 'Codebase Summary Bot'
+description: 'LLM-optimized codebase summarizer for AI code review pipelines, agents, and onboarding.'
+author: 'Libin V Babu <www.libin.in>'
 branding:
-  icon: 'file-text'
+  icon: 'code'
   color: 'blue'
+
 inputs:
-  output-file:
-    description: 'Output file path'
+  output:
+    description: 'Output file path for the codebase summary JSON'
     required: false
-    default: 'code-review-summary.json'
+    default: 'codebase-summary.json'
+  limit:
+    description: 'Max items per category (default: 100)'
+    required: false
+    default: '100'
+
 runs:
   using: 'node20'
-  main: 'generate-codebase-summary.js'
+  main: 'index.js'

codebase-summary.json

@@ -0,0 +1,57 @@
+{
+  "schemaVersion": "3.0.0",
+  "generatedAt": "2025-06-13T07:29:02.905Z",
+  "git": {
+    "sha": null,
+    "branch": null,
+    "remote": null
+  },
+  "modules": [],
+  "services": {
+    "businessServices": [],
+    "utilityServices": [
+      "UtilityAnalyzer"
+    ]
+  },
+  "apiRoutes": {
+    "publicRoutes": [],
+    "internalRoutes": []
+  },
+  "dbModels": [],
+  "utils": {
+    "byDomain": {
+      "Date/Time": [
+        {
+          "file": "utilityAnalyzer.js",
+          "functions": [
+            "assignments"
+          ]
+        }
+      ]
+    },
+    "files": [
+      {
+        "name": "utilityAnalyzer.js",
+        "domain": "Date/Time",
+        "functions": [
+          "assignments"
+        ]
+      }
+    ]
+  },
+  "frameworks": {
+    "backend": "Node.js",
+    "frontend": "None detected",
+    "dependencies": {
+      "fast-glob": "^3.3.1",
+      "minimist": "^1.2.8"
+    }
+  },
+  "globalPatterns": [
+    "Async/Await Pattern",
+    "Dependency Injection",
+    "Middleware Pattern",
+    "React Hooks",
+    "TypeScript Interfaces"
+  ]
+}

config.js

@@ -0,0 +1,62 @@
+export const DEFAULT_LIMIT = 100;
+
+export const IGNORED_PATHS = [
+  '**/node_modules/**',
+  '**/dist/**',
+  '**/build/**',
+  '**/coverage/**',
+  '**/out/**',
+  '**/test*/**',
+  '**/__tests__/**',
+  '**/tmp/**',
+  '**/.next/**',
+  '**/.git/**',
+  '**/logs/**',
+  '**/.idea/**'
+];
+
+export const MODULE_PATTERNS = [
+  'src/modules/*',
+  'src/*',
+  'packages/*',
+  'apps/*'
+];
+
+export const SERVICE_PATTERNS = [
+  '**/*Service.{js,ts}',
+  '**/services/**/*.{js,ts}',
+  '**/*Util.{js,ts}',
+  '**/*Helper.{js,ts}',
+  '**/*utils*.{js,ts}',
+  '**/*helper*.{js,ts}',
+  '**/*util*.{js,ts}'
+];
+
+export const ROUTE_PATTERNS = [
+  '**/routes/**/*.{js,ts}',
+  '**/controllers/**/*.{js,ts}',
+  '**/api/**/*.{js,ts}',
+  '**/*router*.{js,ts}',
+  '**/*route*.{js,ts}'
+];
+
+export const MODEL_PATTERNS = [
+  '**/models/**/*.{js,ts}',
+  '**/schemas/**/*.{js,ts}',
+  '**/entities/**/*.{js,ts}',
+  '**/*Model.{js,ts}',
+  '**/*Schema.{js,ts}'
+];
+
+export const UTIL_PATTERNS = [
+  '**/utils/**/*.{js,ts}',
+  '**/helpers/**/*.{js,ts}',
+  '**/lib/**/*.{js,ts}',
+  '**/*util*.{js,ts}',
+  '**/*helper*.{js,ts}'
+];
+
+export const SOURCE_PATTERNS = [
+  'src/**/*.{js,ts}',
+  '**/*.{js,ts}'
+];

index.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+import { Summarizer } from './src/summarizer.js';
+import minimist from 'minimist';
+import fs from 'fs/promises';
+import path from 'path';
+import packageData from './package.json' assert { type: 'json' };
+const { version } = packageData;
+
+
+async function run() {
+  console.log(`🚀 Codebase Summary Bot v${version}\n==============================`);
+
+  const args = minimist(process.argv.slice(2));
+  const projectRoot = process.cwd();
+
+  const outputFile = args.output || 'codebase-summary.json';
+  const limit = parseInt(args.limit || '100');
+
+  try {
+    const summarizer = new Summarizer({
+      projectRoot,
+      outputFile,
+      limit
+    });
+
+    const summary = await summarizer.analyze();
+
+    await fs.writeFile(
+      path.join(projectRoot, outputFile),
+      JSON.stringify(summary, null, 2),
+      'utf8'
+    );
+
+    console.log(`✅ Summary written to ${outputFile}`);
+  } catch (err) {
+    console.error('💥 Summary failed:', err);
+    process.exit(1);
+  }
+}
+
+run();