Skip to content

readme.md

Latest commit

 

History

History
137 lines (96 loc) · 4.17 KB

readme.md

File metadata and controls

137 lines (96 loc) · 4.17 KB
Raw

CodeCompass 🧭

Go Report Card Go

A comprehensive code quality navigation tool that helps you understand and improve your codebase. CodeCompass combines insights from various sources, including linting results and Git history, to provide detailed leaderboards and metrics.

Table of Contents

🌟 Features

CodeCompass provides a multi-dimensional view of your codebase, represented by compass directions:

  • 🧭 North: Identifies authors who introduced the most lint issues.
  • 🧭 South: Highlights files with the highest number of linting problems.
  • 🧭 East: Shows the most frequently violated ESLint rules.
  • 🧭 West: Ranks files by their lines of code.
  • 🧭 And more: Provides leaderboards for commit activity, code coverage, code churn, bug density, technical debt, and spell-checking.

📦 Installation

From Source

git clone https://github.com/xeoncross/codecompass
cd codecompass
go mod tidy
CGO_ENABLED=0 go build -o codecompass main.go
chmod +x codecompass

Homebrew

brew tap xeoncross/tap
brew install codecompass

🚀 Usage

Basic Usage

Analyze current directory:

./codecompass --all

Analyze a specific repository:

./codecompass /path/to/your/project --all

Show only specific leaderboards:

./codecompass --authors --files --coverage

Generate Configuration File

This creates a .codecompass.rc file with all available options:

./codecompass --generate-config

📋 Command Line Options

Option Description
--authors Show author leaderboard (lint issue contributors)
--files Show file leaderboard (most problematic files)
--rules Show rule leaderboard (most violated rules)
--loc Show lines of code leaderboard
--commits Show regular commit count leaderboard (non-merges)
--merges Show merge commit count leaderboard
--recent Show recent contributors leaderboard
--coverage Show code coverage leaderboard
--churn Show code churn leaderboard
--bugs Show bug density leaderboard
--debt Show technical debt leaderboard
--spellcheck Show spell check leaderboard
--summary Show repository summary
--all Show all leaderboards

For a full list of options, run ./codecompass --help.

⚙️ Configuration

CodeCompass can be configured via a .codecompass.rc file. To generate a sample configuration file, run:

./codecompass --generate-config

The configuration file allows you to ignore files, authors, rules, and paths, as well as set performance-related options.

📊 CI Charts

Every push to the main branch (and manual workflow triggers) automatically generates visualization charts using CodeCompass. These charts include:

  • radar.svg: A comprehensive radar chart showing various code quality metrics
  • trends.csv: Historical trend data for tracking code quality over time

The generated charts are available as downloadable artifacts from the Actions tab. Look for the "Charts" workflow runs to download the latest codecompass-charts artifact containing both files.

🛠️ Development

To run the tests, use the following command:

go test ./...

🤝 Contributing

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/amazing-feature).
  3. Commit your changes (git commit -m 'Add some amazing feature').
  4. Push to the branch (git push origin feature/amazing-feature).
  5. Open a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.