{"id":22105072,"url":"https://github.com/forward-lang/techdebt-tracker","last_synced_at":"2026-01-28T02:52:19.626Z","repository":{"id":265039037,"uuid":"894938470","full_name":"Forward-Lang/TechDebt-Tracker","owner":"Forward-Lang","description":"TechDebt-Tracker 🔎 Help keep your codebase clean, maintainable, and bug-free! 🧹 ","archived":false,"fork":false,"pushed_at":"2024-11-27T10:51:10.000Z","size":14,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-05T00:25:56.235Z","etag":null,"topics":["ci-cd","code-quality","code-quality-analyzer","code-quality-metrics","developer-tools","static-analysis","technical-debt"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Forward-Lang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-27T09:19:25.000Z","updated_at":"2024-12-30T22:31:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"cf0c2abe-4268-4d63-aea9-f920809eb294","html_url":"https://github.com/Forward-Lang/TechDebt-Tracker","commit_stats":null,"previous_names":["forward-lang/techdebt-tracker"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Forward-Lang/TechDebt-Tracker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Forward-Lang%2FTechDebt-Tracker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Forward-Lang%2FTechDebt-Tracker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Forward-Lang%2FTechDebt-Tracker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Forward-Lang%2FTechDebt-Tracker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Forward-Lang","download_url":"https://codeload.github.com/Forward-Lang/TechDebt-Tracker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Forward-Lang%2FTechDebt-Tracker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28835192,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T02:10:51.810Z","status":"ssl_error","status_checked_at":"2026-01-28T02:10:50.806Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci-cd","code-quality","code-quality-analyzer","code-quality-metrics","developer-tools","static-analysis","technical-debt"],"created_at":"2024-12-01T06:38:02.922Z","updated_at":"2026-01-28T02:52:19.609Z","avatar_url":"https://github.com/Forward-Lang.png","language":"Rust","readme":"# **🚀 TechDebt-Tracker** 🚀\n\n**TechDebt-Tracker** is a powerful command-line tool that helps developers **track and manage technical debt** in their codebases. It calculates key **code metrics** like Cyclomatic Complexity, KLOC (thousands of lines of code), and many others to help you identify **areas of your code that need attention**. Whether you're working solo or as part of a team, **TechDebt-Tracker** gives you the insights you need to maintain a **cleaner, more maintainable codebase**.\n\n⚡ **Don't let technical debt slow you down – track it, manage it, and refactor it!**\n\n## 🌟 **Features** 🌟\n\n- **🔢 Cyclomatic Complexity**: Measures the complexity of your code and identifies the parts that might be hard to maintain or prone to errors.\n- **📏 KLOC**: Shows the size of your codebase in thousands of lines, helping you estimate the scale of your project.\n- **📉 Maintainability Index**: Provides a numeric value indicating how maintainable your code is. The higher, the better!\n- **🔍 Halstead Complexity Measures**: Calculates various software metrics such as volume, difficulty, and effort based on operations in your code.\n- **⚠️ Risk of Errors**: Flags areas of code that are more prone to errors due to high complexity.\n- **📈 Easy Integration**: Integrate easily with CI/CD pipelines to automatically flag **code debt** and prompt for necessary refactoring.\n\nWith **TechDebt-Tracker**, you'll be able to keep your codebase **clean, maintainable**, and **error-free** for the long term! 💪\n\n## 🔧 **Installation** 🔧\n\n### **Prerequisites** 📋\n\n- [Rust](https://www.rust-lang.org/learn/get-started) installed on your system.\n\n### **Build from Source** 🔨\n\n1. Clone the repository:\n    ```bash\n    git clone https://github.com/yourusername/TechDebt-Tracker.git\n    cd TechDebt-Tracker\n    ```\n\n2. Build the project:\n    ```bash\n    cargo build --release\n    ```\n\n3. Run the tool:\n    ```bash\n    ./target/release/techdebt-tracker --help\n    ```\n\nAlternatively, you can install **TechDebt-Tracker** directly from Cargo:\n\n\u003e [!NOTE]  \n\u003e Not yet implemented: TODO\n\n```bash\ncargo install techdebt-tracker\n```\n\n## 🏃‍♂️ **Usage**\n\n### **Basic Command** 🖥️\n\nRun the tool to analyze a specific **directory** or **file**:\n\n```bash\ntechdebt-tracker \u003cpath\u003e\n```\n\nWhere `\u003cpath\u003e` is the path to the **file** or **directory** you want to analyze.\n\n### **Example** 🔍\n\n```bash\ntechdebt-tracker ./src\n```\n\nThis command will analyze the `./src` directory and calculate important metrics like **Cyclomatic Complexity**, **KLOC**, and more for all files within it. 📊\n\n### **Available Arguments** ⚙️\n\n- `path`: **Required**. The path to the source code files or directory you want to analyze.\n\n### **Example Output** 💡\n\n```bash\nAnalyzing path: ./src\n\nCyclomatic Complexity: 15\nKLOC (thousands of lines): 2.1\nMaintainability Index: 68\nHalstead Volume: 1100\nHalstead Difficulty: 35\nHalstead Effort: 38500\nRisk of Errors: High (complex code detected)\n```\n\n## 🤖 **CI/CD Integration**\n\n**TechDebt-Tracker** is perfect for integrating into your **CI/CD pipeline** to ensure that **technical debt** is automatically tracked over time. Here's an example using **GitHub Actions**:\n\n### **Example GitHub Actions Workflow** ⚙️\n\n```yaml\nname: Analyze Code Metrics\n\non:\n  push:\n    branches:\n      - main\n  pull_request:\n    branches:\n      - main\n\njobs:\n  analysis:\n    runs-on: ubuntu-latest\n\n    steps:\n    - name: Checkout code\n      uses: actions/checkout@v2\n\n    - name: Install Rust\n      uses: actions/setup-rust@v1\n      with:\n        rust-version: 'stable'\n\n    # Not yet implemented: TODO\n    - name: Build and run TechDebt-Tracker\n      run: |\n        cargo install --path .\n        techdebt-tracker ./src\n```\n\nThis will automatically run **TechDebt-Tracker** every time changes are pushed or a pull request is made to the `main` branch, ensuring **code quality** is always monitored. 🚀\n\n## 🧑‍🤝‍🧑 **Contributing**\n\nWe would **love** your help in making **TechDebt-Tracker** even better! Whether you have a bug fix, a feature idea, or just want to improve the documentation, your contributions are always welcome. 🌟\n\n### **How to Contribute** 👩‍💻👨‍💻\n\n1. Fork the repository 🍴\n2. Create a new branch (`git checkout -b feature-name`) 🌱\n3. Make your changes ✏️\n4. Commit your changes (`git commit -am 'Add new feature'`) 📝\n5. Push to your branch (`git push origin feature-name`) 🚀\n6. Open a **Pull Request** to the `main` branch 🔄\n\nBy contributing, you're helping others build **cleaner, more maintainable code** and fostering a healthy developer ecosystem. 🤝\n\n## 📝 **License**\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. ⚖️\n\n## 💖 **Acknowledgments**\n\nA huge thanks to the following libraries and projects that helped make **TechDebt-Tracker** possible:\n\n- **Clap**: For building the amazing command-line interface. 🖥️\n- **Syn**: For parsing Rust code and extracting valuable metrics. 📊\n\n---\n\n✨ **TechDebt-Tracker** – Track your tech debt before it tracks you! ✨\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforward-lang%2Ftechdebt-tracker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fforward-lang%2Ftechdebt-tracker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforward-lang%2Ftechdebt-tracker/lists"}