v0.3.0

Full Changelog: v0.2.0...v0.3.0

New Metrics Added

1. Cyclomatic Complexity Distribution (Easy, Moderate, High).
2. Maximum Nesting Depth for functions.
3. Maintainability Index (scale from 0 to 100).
4. Improved Halstead Complexity placeholders for potential future addition.

This tool now provides insights into maintainability and risk.

v0.2.0

Full Changelog: v0.1.0...v0.2.0

New Features Added:

1. Average Cyclomatic Complexity per Function: Provides an average complexity value for functions.
2. Longest Function (LOC): Tracks the longest function in terms of lines of code.
3. Average Function Length: Offers insights into how granular the functions are.
4. Comment Density: Alerts when the comment-to-code ratio is too low.
5. File with Maximum Complexity: Identifies files that may need refactoring or additional scrutiny.

How to Use:

1. Follow the same steps as before to build and run the tool.
2. The output now includes all the new metrics and corresponding warnings.

This tool now provides a more comprehensive view of code quality, including maintainability and error risk factors. It can serve as a robust addition to CI/CD pipelines to monitor technical debt.

v0.1.0

Full Changelog: https://github.com/Forward-Lang/TechDebt-Tracker/commits/v0.1.0

Features:

1. Lines of Code (LOC): Counts the total lines of code.
2. KLOC: Converts LOC to thousands of lines.
3. Cyclomatic Complexity: Uses Rust's syn crate to parse Rust files and calculate complexity.
4. Number of Functions: Counts the total number of functions.

How to Use:

Build the tool using cargo build --release.
Run the tool:

./target/release/techdebt-tracker <path_to_codebase>

Use it in CI/CD pipelines to monitor code quality.