Configuration
Debtmap is highly configurable through a TOML configuration file. This section covers all configuration options and best practices for tuning debtmap for your codebase.
Quick Start
Create a .debtmap.toml file in your project root:
[scoring]
coverage = 0.50
complexity = 0.35
dependency = 0.15
[thresholds]
complexity = 15
lines = 80
coverage = 0.8
[languages]
rust = true
python = true
javascript = true
Configuration Topics
- Scoring Configuration - Tune debt scoring weights and role multipliers
- Thresholds Configuration - Set complexity and coverage thresholds
- Language Configuration - Enable/disable language support and tune language-specific settings
- Display and Output - Configure output formats and display options
- Advanced Options - Advanced configuration for power users
- Best Practices - Guidelines for effective configuration
Configuration File Location
Debtmap searches for configuration in the following order:
- Path specified with
--configflag .debtmap.tomlin current directory.debtmap.tomlin git repository root- Built-in defaults
Validation
Debtmap validates your configuration on startup. Invalid configurations will produce clear error messages:
$ debtmap analyze .
Error: Invalid configuration
- scoring.coverage + scoring.complexity + scoring.dependency must equal 1.0
- Current sum: 1.10
Default Values
All configuration options have sensible defaults. You only need to specify values you want to override from the defaults documented in each section.