kraymer / treeage

Expose aging code by listing contents of repository in a tree-like format with eye-catching age metric.

treeage

/'trēˌāj/

1. n. a process in which things are ranked in terms of importance or priority.
2. n. software that lists contents of directories in a tree-like format with age metric indicated for each file

treeage is typically used to shed some light on antiquated parts¹ of a codebase and identify candidates for a refactoring.

Install

treeage is written for Python 3.6+, install with pip via pip3 install treeage command.

Usage

Usage: treeage.py [OPTIONS] DIRECTORY  

  Lists contents of directories in a tree-like format with age metric
  indicated for each file.  

Options:
  --maxdepth LEVELS    Descend at most LEVELS (a non-negative integer) levels
                       of directories below the seed DIRECTORY
  -i, --include GLOB   List only files whose base name matches GLOB (using
                       wildcard matching)
  -e, --exclude GLOB   Exclude files whose base name matches GLOB (using
                       wildcard matching)
  --before DATE        List only files whose age is older than DATE
  --after DATE         List only files whose age is lower than DATE
  -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
  --version            Show the version and exit.
  -h, --help           Show this message and exit.  

  Examples:
  treeage --maxdepth 2 --before "01 jan 2018"../qifqif
  treeage --include "*.py" --after "3 month ago" .

Screenshot

---

Footnotes

---

1. file age is computed by averaging last modification date of its lines↩

treeage's Issues

Provide a `--heatmap` flag

--heatmap blues|bw|heat|magma (default: bw)

https://github.com/vaab/colour package could be used

Add flag(s) to filter by date

Add flags to list only files anterior/posterior to a given date.
The date should be parsed using dateparser lib.

Examples of possible uses :

treeage --include *.py -- after "3 months ago" . 
treeage --include *.py -- before "29/02/2016" . 

Provide a `--exclude GLOB` flag

eg skip all migrations in a django project