README

A command-line tool for analyzing the quality and security of Laravel projects. Zero external dependencies — pure PHP only.

📦 Installation

Option A — Direct use (no composer install required)

git clone https://github.com/your-user/laravel-analyzer
cd laravel-analyzer
chmod +x bin/laravel-analyze
php bin/laravel-analyze /path/to/your-laravel-project

Option B — Global via Composer

composer global require laravel-analyzer/cli
laravel-analyze /path/to/your-project

🚀 Usage

# Analyze the current directory
laravel-analyze .

# Analyze a specific path
laravel-analyze /var/www/my-project

# Run only specific modules
laravel-analyze . --only=security,owasp

# Export HTML report
laravel-analyze . --format=html --output=report.html

# Export JSON for CI/CD
laravel-analyze . --format=json --output=analysis.json

# Export Markdown (for GitHub/GitLab)
laravel-analyze . --format=markdown --output=ANALYSIS.md

# Set a minimum quality threshold
laravel-analyze . --threshold=75

# Disable colors (for logs/CI)
laravel-analyze . --no-color

📊 Analysis Modules

🔗 Coupling & Cohesion (coupling)

Detects violations of the Single Responsibility Principle (SRP).

How to improve?

• Break God Classes into specific services
• Use dependency injection instead of new ClassName()
• Define interfaces for each dependency

🧪 Test Coverage (testing)

Evaluates the quality and coverage of the test suite.

To generate a coverage report:

php artisan test --coverage-clover=coverage.xml
laravel-analyze .  # Detects coverage.xml automatically

💸 Technical Debt (debt)

Identifies indicators of accumulated technical debt.

🧮 Refactoring Complexity (complexity)

Analyzes the Cyclomatic Complexity (CC) of each method.

Formula: CC = 1 + (if + for + foreach + while + case + catch + && + \|\|)

🔒 Laravel Security (security)

Detects vulnerabilities specific to the Laravel ecosystem.

🛡️ OWASP Top 10 (owasp)

Checks the project against the OWASP Top 10 standard (2021).

📋 Output Formats

Console (default)

Colorized terminal view with progress bars.

JSON

{
  "generated_at": "2025-03-21 10:00:00",
  "project": "my-laravel-app",
  "global_score": 72.5,
  "grade": "B",
  "analyses": {
    "coupling": { "score": 78.2, "risk": "MEDIUM", ... },
    "owasp": { "score": 65.0, "risk": "MEDIUM", ... }
  }
}

HTML

Full visual report with tables, progress bars, and OWASP breakdown.

Markdown

Compatible with GitHub/GitLab. Ideal for PRs or documentation wikis.

🔄 CI/CD Integration

GitHub Actions

name: Laravel Quality Check
on: [push, pull_request]

jobs:
  analyze:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.2'

      - name: Run Laravel Analyzer
        run: php bin/laravel-analyze . --format=json --output=analysis.json --no-color

      - name: Check quality threshold
        run: |
          SCORE=$(python3 -c "import json; d=json.load(open('analysis.json')); print(d['global_score'])")
          if python3 -c "exit(0 if $SCORE >= 60 else 1)"; then
            echo "Quality score: $SCORE/100 — OK"
          else
            echo "Quality score ($SCORE) below threshold (60)"; exit 1
          fi

      - name: Upload report
        uses: actions/upload-artifact@v3
        with:
          name: laravel-analysis
          path: analysis.json

GitLab CI

laravel-analysis:
  stage: test
  script:
    - php bin/laravel-analyze . --format=json --output=analysis.json --no-color --threshold=65
  artifacts:
    paths:
      - analysis.json

🛠️ Complementary Tools

📈 Score Interpretation

📝 License

MIT License — Free for commercial and personal use.