@sun-asterisk/impact-analyzer 1.0.0 → 1.0.1

package/README.md

@@ -1,24 +1,28 @@
 # Impact Analyzer
 
-Automated impact analysis tool for TypeScript/JavaScript projects. Analyzes code changes between git references and generates comprehensive impact reports.
+Automated impact analysis for TypeScript/JavaScript projects. Analyzes code changes and generates comprehensive impact reports.
 
-## Overview
+## Quick Start
 
-Impact Analyzer is a powerful tool designed to help development teams understand the full impact of code changes in their TypeScript/JavaScript projects. It detects changes between git commits/branches and automatically analyzes:
+### Installation
 
-- **API Endpoints** - Which REST APIs are affected by the changes
-- **Database Operations** - Which database tables and fields are impacted
-- **Pages/Components** - Which UI components and pages are modified
-- **Logic Impact** - Function call dependencies and impact scope
-- **Test Coverage** - Recommended test cases based on changes
+```bash
+npm install @sun-asterisk/impact-analyzer
+```
+
+### Usage
+
+```bash
+npx @sun-asterisk/impact-analyzer --input=src --base=origin/main
+```
 
-### Key Benefits
+## Features
 
-- 🎯 **Reduce Testing Effort** - Know exactly what to test instead of full regression
-- 🚀 **Faster Code Reviews** - Reviewers can quickly understand the scope of changes
-- 📊 **Risk Assessment** - Automatically calculates impact scores and severity levels
-- 🔍 **Dependency Tracking** - Identifies all files and functions affected by changes
-- 📝 **Automated Reports** - Generates detailed markdown and JSON reports
+- 📡 **API Impact** - Detect affected endpoints
+- 💾 **Database Impact** - Track table and field changes
+- 📄 **Component Impact** - Identify modified UI components
+- 🔄 **Logic Impact** - Analyze function dependencies
+- ✅ **Test Recommendations** - Suggest test cases
 
 ## Analysis Flow
 
@@ -115,216 +119,45 @@ Controller (@Get/@Post) ──┐
     Database ─────────────┘
 ```
 
-**Component Separation**
-- `MethodCallGraph`: Pure graph construction logic (no logging)
-- `EndpointDetector`: Endpoint impact analysis + verbose logging
-- `DatabaseDetector`: Database impact analysis + verbose logging
-- `ImpactAnalyzer`: Orchestration and aggregation
-
-## Features
-
-### 1. Change Detection
-- Detects modified, added, and deleted files between git references
-- Extracts changed symbols (functions, classes, methods) using AST parsing
-- Categorizes files by type (source, test, config)
-- Calculates line changes for each file
-
-### 2. API Endpoint Analysis
-- Automatically detects affected REST API endpoints
-- Supports multiple frameworks:
-  - NestJS decorators (`@Get()`, `@Post()`, etc.)
-  - Express routes (`app.get()`, `router.post()`, etc.)
-  - Fastify routes
-- Groups endpoints by controller
-- Shows impact level for each endpoint
-
-### 3. Database Impact Analysis
-- Detects database operations across ORMs:
-  - Prisma
-  - TypeORM
-  - Sequelize
-- Identifies affected tables and fields
-- Lists database operations (CREATE, UPDATE, DELETE, etc.)
-- Checks for migration files
-- Shows sample queries
-
-### 4. Pages/Components Detection
-- Automatically detects UI changes
-- Supports:
-  - Pages (React, Next.js, Vue, etc.)
-  - Components
-  - Views
-  - Screens (React Native)
-- Groups by type for easy review
-- Shows status and line changes
-
-### 5. Logic Impact Analysis
-- Builds dependency graphs
-- Finds direct and indirect callers of changed functions
-- Calculates risk levels based on impact scope
-- Detects control flow changes
-
-### 7. Comprehensive Reporting
-- **Markdown Reports** - Formatted, readable reports with tables and sections
-- **JSON Reports** - Machine-readable output for CI/CD integration
-- **Console Output** - Quick summary with color-coded severity
-- **Impact Scoring** - Numerical score based on change magnitude
-
-## Configuration
-
-### Command Line Options
-
-```bash
-node index.js [OPTIONS]
-```
-
-| Option | Description | Default |
-|--------|-------------|---------|
-| `--input=DIR` | Source directory to analyze | `src` |
-| `--base=REF` | Base git reference (branch/commit) | `origin/main` |
-| `--head=REF` | Head git reference (branch/commit) | `HEAD` |
-| `--exclude=PATHS` | Comma-separated paths to exclude | `node_modules,dist,build,specs,coverage` |
-| `--output=FILE` | Output markdown file path | `impact-report.md` |
-| `--json=FILE` | Optional JSON output file | - |
-| `--max-depth=N` | Maximum dependency traversal depth | `3` |
-| `--include-tests` | Include test files in analysis | `false` |
-| `--no-fail` | Don't exit with error on critical impact | `false` |
-| `--verbose` | Show verbose output | `false` |
-
-### Configuration File
-
-Default configuration in `config/default-config.js`:
-
-```javascript
-{
-  sourceDir: 'src',
-  excludePaths: ['node_modules', 'dist', 'build', 'specs', 'coverage'],
-  baseRef: 'origin/main',
-  headRef: 'HEAD',
-  maxDepth: 3,
-  includeTests: false,
-  verbose: false,
-  outputFormat: 'markdown',
-  outputFile: 'impact-report.md'
-}
-```
-
-### Environment Setup
-
-1. **Prerequisites**
-   - Node.js 16+ 
-   - Git repository
-   - npm or yarn
-
-2. **Installation**
-   ```bash
-   cd impact-analyzer
-   npm install
-   # or
-   yarn install
-   ```
-
 ## Usage
 
-### Basic Usage
-
-Analyze changes between current branch and main:
-
-```bash
-node index.js --input=src --base=origin/main --head=HEAD
-```
-
-### Using the Shell Script
-
-The included shell script provides a convenient wrapper:
-
-```bash
-# Make it executable
-chmod +x run-impact-analysis.sh
-
-# Run with defaults
-./run-impact-analysis.sh
-
-# Run with custom options
-./run-impact-analysis.sh --input=src --base=origin/develop --output=report.md
-```
-
-### NPM Scripts
-
-```bash
-# Analyze local changes
-npm run analyze:local
-
-# Custom analysis
-npm run analyze -- --input=src --base=main --json=impact.json
-```
-
-### Common Scenarios
-
-#### 1. Analyze PR Changes
-
-```bash
-# Compare feature branch against main
-node index.js \
-  --input=src \
-  --base=origin/main \
-  --head=HEAD \
-  --output=pr-impact.md
-```
-
-#### 2. Analyze Specific Commit Range
+### CLI Options
 
 ```bash
-# Compare two commits
-node index.js \
-  --input=src \
-  --base=abc123 \
-  --head=def456 \
-  --output=commit-impact.md
+npx @sun-asterisk/impact-analyzer [options]
 ```
 
-#### 3. Generate JSON Report for CI/CD
+| Option | Description | Required |
+|--------|-------------|----------|
+| `--input` | Source directory path | ✅ |
+| `--base` | Base git reference (branch/commit/tag) | ✅ |
+| `--head` | Head git reference | No (default: `HEAD`) |
+| `--output` | Markdown report output path | No |
+| `--json` | JSON report output path | No |
+| `--verbose` | Enable verbose logging | No |
 
-```bash
-# Generate both markdown and JSON
-node index.js \
-  --input=src \
-  --base=origin/main \
-  --head=HEAD \
-  --output=impact-report.md \
-  --json=impact-report.json
-```
-
-#### 4. Analyze with Verbose Output
+### Examples
 
 ```bash
-# Show detailed logs
-node index.js \
-  --input=src \
-  --base=origin/main \
-  --verbose
-```
+# Basic analysis
+npx @sun-asterisk/impact-analyzer --input=src --base=origin/main
 
-#### 5. Continue on Critical Impact
+# Generate reports
+npx @sun-asterisk/impact-analyzer --input=src --base=origin/main --output=report.md --json=report.json
 
-```bash
-# Don't fail CI on critical severity
-node index.js \
-  --input=src \
-  --base=origin/main \
-  --no-fail
+# Compare specific commits
+npx @sun-asterisk/impact-analyzer --input=src --base=abc123 --head=def456
 ```
 
-### CI/CD Integration
+## CI/CD Integration
 
-#### GitHub Actions Example
+### GitHub Actions
 
 ```yaml
 name: Impact Analysis
-
 on:
   pull_request:
-    branches: [main, develop]
+    types: [opened, synchronize]
 
 jobs:
   analyze:
@@ -333,39 +166,26 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
+
+      - uses: actions/setup-node@v3
         with:
           node-version: '18'
-      
-      - name: Install Dependencies
-        run: |
-          cd impact-analyzer
-          npm install
-      
+
       - name: Run Impact Analysis
         run: |
-          cd impact-analyzer
-          node index.js \
-            --input=../src \
+          npx @sun-asterisk/impact-analyzer \
+            --input=src \
             --base=origin/${{ github.base_ref }} \
-            --head=HEAD \
+            --head=${{ github.sha }} \
             --output=impact-report.md \
             --json=impact-report.json
-      
-      - name: Upload Report
-        uses: actions/upload-artifact@v3
-        with:
-          name: impact-report
-          path: impact-analyzer/impact-report.md
-      
+
       - name: Comment PR
         uses: actions/github-script@v6
         with:
           script: |
             const fs = require('fs');
-            const report = fs.readFileSync('impact-analyzer/impact-report.md', 'utf8');
+            const report = fs.readFileSync('impact-report.md', 'utf8');
             github.rest.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
@@ -374,133 +194,85 @@ jobs:
             });
 ```
 
-#### GitLab CI Example
+### GitLab CI
 
 ```yaml
-impact_analysis:
+impact-analysis:
   stage: test
+  image: node:18
   script:
-    - cd impact-analyzer
-    - npm install
-    - |
-      node index.js \
-        --input=../src \
-        --base=origin/main \
-        --head=HEAD \
-        --output=impact-report.md \
+    - npx @sun-asterisk/impact-analyzer
+        --input=src
+        --base=origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME
+        --head=$CI_COMMIT_SHA
+        --output=impact-report.md
         --json=impact-report.json
   artifacts:
     paths:
-      - impact-analyzer/impact-report.md
-      - impact-analyzer/impact-report.json
-    reports:
-      dotenv: impact-analyzer/impact-report.json
+      - impact-report.md
+      - impact-report.json
+  only:
+    - merge_requests
 ```
 
-### Reading the Report
-
-The generated report includes:
-
-1. **📊 Summary** - Overview of changes and severity
-2. **📡 Affected API Endpoints** - List of impacted APIs grouped by controller
-3. **💾 Database Impact** - Tables, fields, and operations affected
-4. **📄 Affected Pages/Components** - UI changes grouped by type
-5. **🔄 Logic Impact** - Call dependencies and risk level
-6. **✅ Recommended Test Cases** - Suggested tests based on changes
-7. **📝 Changed Files** - Complete list of modified files
-
-#### Severity Levels
-
-- 🟢 **LOW** (0-20 points) - Minor changes, low risk
-- 🟡 **MEDIUM** (21-50 points) - Moderate impact, standard testing required
-- 🟠 **HIGH** (51-100 points) - Significant impact, thorough testing needed
-- 🔴 **CRITICAL** (100+ points) - Major changes, full regression testing recommended
-
-#### Impact Scoring
-
-The impact score is calculated based on:
-- Affected endpoints: +10 points each
-- Database tables impacted: +5 points each
-- Direct function callers: +3 points each
-- Indirect function callers: +1 point each
-- High risk logic: 1.5x multiplier
-- Database migration: +20 points
-
-### Example Output
-
-```markdown
-# 🔍 Impact Analysis Report
-
-## 📊 Summary
-
-| Metric | Value |
-|--------|-------|
-| Files Changed | 5 |
-| Symbols Modified | 12 |
-| Impact Score | **45** |
-| Severity | 🟡 **MEDIUM** |
-
-## 📡 Affected API Endpoints
+### Jenkins
+
+```groovy
+pipeline {
+    agent any
+    stages {
+        stage('Impact Analysis') {
+            steps {
+                sh '''
+                    npx @sun-asterisk/impact-analyzer \
+                        --input=src \
+                        --base=origin/main \
+                        --output=impact-report.md \
+                        --json=impact-report.json
+                '''
+            }
+        }
+    }
+}
+```
 
-**Total Endpoints Affected:** 3
+## Report Output
 
-### Endpoint List
-| Method | Path | Controller | Impact |
-|--------|------|------------|--------|
-| **GET** | `/api/users` | UserController | 🟡 medium |
-| **POST** | `/api/users` | UserController | 🔴 high |
+### Severity Levels
 
-## 💾 Database Impact
+- 🟢 **LOW** (0-20) - Minor changes
+- 🟡 **MEDIUM** (21-50) - Moderate impact
+- 🟠 **HIGH** (51-100) - Significant impact
+- 🔴 **CRITICAL** (100+) - Major changes
 
-**Total Tables Affected:** 2
+### Impact Score Calculation
 
-### Tables Summary
-| Table | Operations | Fields Count | Migration |
-|-------|------------|--------------|-----------|
-| `users` | UPDATE | 3 | ✅ Yes |
-| `profiles` | CREATE, UPDATE | 5 | ❌ No |
-```
+- Endpoints: +10 each
+- DB Tables: +5 each
+- Direct Callers: +3 each
+- Indirect Callers: +1 each
+- High Risk Logic: ×1.5
+- DB Migration: +20
 
 ## Troubleshooting
 
 ### Common Issues
 
-1. **"Source directory does not exist"**
-   - Ensure the `--input` path is correct and relative to the analyzer directory
-
-2. **"Base ref does not exist"**
-   - Run `git fetch` to ensure remote branches are up to date
-   - Verify the branch/commit exists: `git show origin/main`
-
-3. **"No changes detected"**
-   - Check if there are actual differences: `git diff origin/main HEAD`
-   - Ensure you're in a git repository
-
-4. **Parse errors for certain files**
-   - The analyzer uses Babel parser with common plugins
-   - Some experimental syntax may not be supported
-   - These files will be logged and skipped
+**"Source directory does not exist"**
+- Verify `--input` path is correct
 
-### Debug Mode
+**"Base ref does not exist"**
+- Run `git fetch` to update branches
+- Verify branch exists: `git show origin/main`
 
-Run with verbose flag to see detailed logs:
+**"No changes detected"**
+- Check differences: `git diff origin/main HEAD`
 
+**Debug Mode**
 ```bash
-node index.js --input=src --base=origin/main --verbose
+npx @sun-asterisk/impact-analyzer --input=src --base=origin/main --verbose
 ```
 
-## Contributing
-
-Contributions are welcome! Please ensure:
-- Code follows existing style (no spaces after dots)
-- All functions have single responsibility
-- Use descriptive variable and function names
-- Add tests for new features
-
 ## License
 
 MIT
-
-## Support
-
-For issues, questions, or suggestions, please create an issue in the repository.

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@sun-asterisk/impact-analyzer",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Automated impact analysis for TypeScript/JavaScript projects",
   "main": "index.js",
   "type": "module",
+  "bin": {
+    "impact-analyzer": "./index.js"
+  },
   "scripts": {
     "analyze": "node index.js",
     "analyze:local": "node index.js --input=src --base=origin/main --head=HEAD",
@@ -21,6 +24,5 @@
     "@babel/traverse": "^7.23.0",
     "glob": "^10.3.0",
     "ts-morph": "^27.0.2"
-  },
-  "devDependencies": {}
+  }
 }