Our Journey In The Open Source World - spyone

Do you know we built an awesome caching library for Node at Jointly? No?! Well, check this out!

Today we want to present you our latest fatigue, spyone!

spyone is a tool that generates a JSON heatmap of any Git repository's commits showing most edited files.

It comes from the italian word spione, which means spy.

Please, keep in mind this project is not perfect. It was made to analyze our most edited files to create some sort of heatmap of the technical debt of our internal projects.

What does it do?

This script downloads any Git repository and extracts statistics from its commits. The resulting data is then sorted by commit count, and if there is a tie, by the sum of additions and deletions in descending order. The result is opened in your default browser and you're able to save it in any location on your computer.

Usage

To use it, run the following command:

npx @jointly/spyone <repo-url> <days-to-cover> <branch-name> <output-format>

The JSON output opens in your default browser.

Parameters

• repo-url: the URL of the GitHub repository to extract statistics from. This can be either an https or ssh URL.
• days-to-cover: the number of days before today to consider when extracting data from commits. We suggest 30 for highly updated projects and 90 days for common day-to-day work projects.
• branch-name (optional): the name of the branch to consider. Defaults to main.
• output-format (optional): Accepts {html|json}. Defaults to json.