debt-radar

Scan codebases for architectural, transaction, and naming convention violations.

Updated Jul 22, 2023
One-click install
npx skills add https://github.com/ValerianGuivarch/lsr-nestjs-backend --skill debt-radar
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: debt-radar
Source: https://github.com/ValerianGuivarch/lsr-nestjs-backend/tree/main/.claude/skills/debt-radar
Command: npx skills add https://github.com/ValerianGuivarch/lsr-nestjs-backend --skill debt-radar

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

The debt-radar skill solves the problem of manually auditing and reporting on technical debt in a codebase, automating the process with a detailed read-only report.

Core Features & Use Cases

  • Tech Debt Scanning: Identifies known technical debt violations in code.
  • Read-Only Report: Generates a report without modifying any files.
  • Custom Scope: Allows scanning specific parts of the codebase based on user input.
  • Priority Rules: Prioritizes violations based on severity and impact.
  • Use Case: When you want to quickly understand and prioritize technical debt issues in your code without making changes.

Quick Start

Analyze the tech debt in the 'libs/grants/grants-domain/' directory using the command: debt-radar on libs/grants/grants-domain/

Frequently Asked Questions about debt-radar

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate tech debt analysis in my codebase?

Tech debt scanning identifies architectural, transaction, and naming convention violations in your code. It generates a read-only report prioritizing issues by severity and impact, helping you understand technical debt without modifying files.

How do I audit technical debt in a specific directory without changing code?

To audit technical debt without changing code, run a custom scope scan targeting your specific directory. The tool generates a read-only report of violations, ensuring source files remain completely unmodified during the analysis.

Does technical debt scanning require external dependencies to run?

No, technical debt scanning requires zero external dependencies to run. The audit tool operates independently by scanning your codebase directly and identifying violations using built-in architectural, transaction, and naming convention rules.

What is the best way to prioritize technical debt issues in a large codebase?

The best way to prioritize technical debt is to use a scanner with built-in priority rules that rank violations by severity and impact. This generates a prioritized report so you can focus on the most critical architectural and naming issues first.

Can I scan only a specific part of my code for convention violations?

Yes, you can scan a specific part of your code by utilizing custom scope selection. Provide a target directory path, and the analysis will limit its search for architectural and naming convention violations to only the files within that scope.