This is a command-line interface (CLI) tool written in Go that analyzes Git commit history to identify code hotspots. Hotspots are defined as files and directories with the most commits within the last year, indicating areas of frequent change.
- Checks if the current directory is a Git repository.
- Analyzes Git commits from the last 1 year.
- Identifies top hotspot files and directories based on commit count.
- Identifies the top contributor for each file and directory.
- Configurable number of top files and directories to display.
- Presents the hotspots in a clear, terminal-based user interface.
To install the git-hotspots CLI tool, follow these steps:
-
Ensure Go is installed: If you don't have Go installed, you can download it from the official Go website: https://golang.org/doc/install
-
Install the tool:
go install git-hotspots
This command will download the source code, build the executable, and place it in your
$GOPATH/bindirectory (which should be in your system's PATH).
Navigate to the root directory of a Git repository you want to analyze and run the tool:
git-hotspotsAlternatively, you can specify the path to a Git repository:
git-hotspots /path/to/your/repoThe tool will display a terminal UI showing the top hotspot files and directories.
-
--top N: Specify the number of top files and directories to display (default: 10)git-hotspots --top 5
-
--test-mode: Run in test mode without launching the UI (useful for automated testing)git-hotspots --test-mode
┌───────────────────────────────Top Hotspot Files──────────────────────────────┐
│Commits Top Contributor (Commits) File Path │
│----------------------------------------------- │
│ 2 John Doe (2) file1.txt │
│ 1 Jane Smith (1) src/util.go │
│ 1 John Doe (1) src/main.go │
│ 1 Jane Smith (1) file2.txt │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────┘
┌────────────────────────────Top Hotspot Directories───────────────────────────┐
│Commits Top Contributor (Commits) Directory Path │
│--------------------------------------------------- │
│ 2 John Doe (2) src │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────┘
main.go: The main entry point for the CLI application.internal/git/: Contains the core logic for Git repository analysis.pkg/ui/: Contains the logic for the terminal user interface.
To run the unit and integration tests, navigate to the project root and execute:
go test ./...Feel free to open issues or submit pull requests if you have suggestions or improvements.