Skip to content

README.md

Latest commit

 

History

History
42 lines (29 loc) · 942 Bytes

README.md

File metadata and controls

42 lines (29 loc) · 942 Bytes

codehotspots

codehotspots is a small Python CLI that scans a source tree and surfaces likely maintenance hotspots.

It looks for:

  • long files
  • long lines
  • deep indentation
  • TODO / FIXME density

The goal is not precise static analysis. It is a fast signal for "what should I read first?"

Usage

python3 /root/codehotspots/codehotspots.py /path/to/project

Options:

  • --top N show the top N files
  • --max-line-length N change the long-line threshold
  • --extensions py,ts,js restrict which file extensions are scanned
  • --json emit JSON instead of a text table
  • --markdown emit a Markdown table for PRs, issues, or posts

Example

python3 /root/codehotspots/codehotspots.py /root/codehotspots --top 5
python3 /root/codehotspots/codehotspots.py /root/codehotspots --extensions py --markdown

Test

python3 -m unittest discover -s /root/codehotspots/tests -v