Skip to content

dev-vikas-soni/gradle-lighthouse

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Gradle Lighthouse

Architecture Intelligence for Android & Kotlin Multiplatform

Gradle Lighthouse analyzes your Gradle project, detects architectural risks, evaluates build health, and generates actionable recommendations to improve maintainability, scalability, and developer productivity.

Gradle Plugin Portal Version: 2.3.1 License: MIT Kotlin Gradle 8.x-9.x

lighthouse-hero-image

Why Gradle Lighthouse?

Most teams know they have technical debt.

What they don't know is:

  • Which modules are slowing development
  • Where architectural boundaries are leaking
  • Why builds are becoming slower
  • Which issues deserve attention first
  • How their architecture evolves over time

Gradle Lighthouse answers those questions with a single audit.

./gradlew lighthouseAudit lighthouseAggregate

What You Get

Architectural Health Score

A transparent health model that evaluates:

  • Architecture
  • Security
  • Build Performance
  • Dependency Hygiene
  • Complexity
  • Modernization
  • Quality
  • Application Size

Instead of showing hundreds of findings, Lighthouse highlights the areas that have the greatest architectural impact.

Path to 90

Lighthouse generates an improvement roadmap showing which fixes produce the largest score gains.

Example:

Current Score: 72

Top Opportunities
──────────────────────────────────────
+7  Migrate KAPT processors to KSP
+5  Remove dependency cycles
+4  Enable configuration cache
+3  Reduce oversized modules

Architecture Health Breakdown

See exactly why a project scored the way it did.

Architecture         85
Security            100
Build Performance    63
Complexity           58
Modernization        76
arch_health_breakdown

Industry Benchmarking

Compare your project against architectural reference snapshots generated by Lighthouse.

Benchmarking provides context for your score and helps teams understand where they stand relative to similar projects.

Galaxy Graph

Interactive module dependency visualization with:

  • Cycle detection
  • Dependency exploration
  • Refactoring sandbox mode
  • Impact analysis
lighthouse_galaxy_view

CI/CD Integration

Export findings as:

  • HTML Reports
  • SARIF
  • JUnit XML

Integrates naturally with GitHub Actions and modern CI pipelines.


Installation

Apply the plugin to your root project:

plugins {
    id("io.github.dev-vikas-soni.lighthouse") version "2.3.1"
}

Quick Start

Run a complete audit:

./gradlew lighthouseAudit lighthouseAggregate

Reports:

build/reports/lighthouse/project-dashboard.html

Per-module reports:

<module>/build/reports/lighthouse/index.html

Key Features

Feature Description
Health Score Engine Category-based architecture scoring
Architecture Breakdown Visibility into architectural strengths and weaknesses
Path to 90 Prioritized improvement roadmap
Galaxy Graph Interactive dependency visualization
Benchmark Engine Relative comparison against architectural baselines
Baseline Support Ignore historical debt and focus on new issues
Lighthouse Fix Automated configuration improvements
CI/CD Support SARIF, HTML and JUnit exports

Benchmark Operations

Export a Benchmark Snapshot

./gradlew lighthouseExportBenchmark

Output:

build/reports/lighthouse/benchmark.json

View Loaded Benchmarks

./gradlew lighthouseBenchmarkStatus

Scoring Philosophy

Gradle Lighthouse focuses on architectural health rather than issue counts.

Category-Based Scoring

Each finding contributes to a specific architectural domain.

Weakest-Link Principle

A project cannot be considered healthy if a critical category is failing.

Actionable Feedback

Every deduction is traceable to findings and improvement opportunities.

Benchmark-Aware Context

Scores are evaluated relative to project structure and benchmark baselines.


Documentation

Document Description
docs/architecture.md System architecture and execution flow
docs/scoring-model.md Health score model and weighting
docs/benchmarking.md Benchmark engine and percentile calculations
docs/USER_MANUAL.md Tasks, DSL and configuration

License

MIT License.

About

Analyze Android module graphs, detect circular dependencies, audit Gradle builds, and uncover architecture bottlenecks before they impact build performance.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors