Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 1.8 KB

README.md

File metadata and controls

49 lines (36 loc) · 1.8 KB

Repository-Investigator

A local application that allows you to investigate and visualize your repository following principles described in Your Code as a Crime Scene.

Screen Shot 2020-04-11 at 11 06 10 PM

The Heatmap allows you to see the complexity - a combination of LOC and change frequency.

Bigger, darker files are more complex. You can identify the most complex files and use them as entry points when understanding a new code base, because these they represent the big things that have been recently worked on. Alternatively, you can also see them as candidates for code refactoring or when tracking obscure regression bugs.

Stack

D3 js + hyperapp + express + mocha.

Features:

  • Heat map of the repository based on file's lines of code and number of revisions.
  • Display number of revisions, path to file of a particular item.
  • Control the heatmap (zoom, highlight) for a particular item.
  • Display top n-revisited files with configurable parameter n.
  • More forensic traits.
  • More visualizations.

Demo

demo2

Installation

Prerequisite

Usage

Start client:

npm start

Start server:

node server.js

Feature

  • Alt + Click: Display the top n-revisited items of the selected item. Different regions result in different item.
  • Shift + Click: Dispay the details of the selected item.