Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dburriss/hotspot-rs-cli
A CLI tool for finding hotspots in your code.
https://github.com/dburriss/hotspot-rs-cli
domain-metrics metrics team-devon
Last synced: 21 days ago
JSON representation
A CLI tool for finding hotspots in your code.
- Host: GitHub
- URL: https://github.com/dburriss/hotspot-rs-cli
- Owner: dburriss
- License: mit
- Created: 2021-10-01T14:26:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T14:54:50.000Z (almost 2 years ago)
- Last Synced: 2023-08-12T13:22:08.389Z (over 1 year ago)
- Topics: domain-metrics, metrics, team-devon
- Language: Rust
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hotspot
A CLI tool for finding hotspots in your code.
**Features:**
- [x] Code metrics on files ie LoC, Cyclomatic and cognitive complexity,
- [x] List busfactor on files
- [x] List git contributors with metrics
- [x] List "hottest" file ie. those that have changed most frequently
- [ ] recommend actions based on code metrics and git history
## Getting
Currently only available on the releases GitHub page as binaries.
## Usage
`hotspot --help`
```
Hotspot 0.1
Devon B.
Inspect source code for those hotspots based on source code metrics and change cadence
USAGE:
hotspot.exe [FLAGS] [OPTIONS] [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-s Sets to silent mode
-V, --version Prints version information
-v Sets to verbose mode
OPTIONS:
-i, --include Glob representing explicit includes
SUBCOMMANDS:
about Tells more about this CLI tool
busfactor Calculate bus factor of repository contributors
contributors Gathers statistics on repository contributors
help Prints this message or the help of the given subcommand(s)
hottest Lists most changed files
metrics Gathers code metrics on repository
```
### Busfactor
Measures how many people need to be hit by a bus before no one who has touched that code is alive.
**Data**: Path, Bus factor
```
USAGE:
hotspot.exe busfactor
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
ARGS:
Sets the input path of source code to use [default: ./]
```
### Contributors
Lists out contributors to a git repository and some stats on the commits.
**Data**: Contributor, # Commits, # Files Touched
```
USAGE:
hotspot.exe contributors
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
ARGS:
Sets the input path of source code to use [default: ./]
```
### Hottest
List files in order of most changes.
**Data**: Path, # of Changes, Last changed by, Last changed at
```
USAGE:
hotspot.exe hottest [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--top Sets the number on how many results are returned. '0' returns all. [default: 0]
ARGS:
Sets the input path of source code to use [default: ./]
```
### Metrics
Lists some basic code metrics for files in the repository.
**Data**: File, Lines, Cognitive, Cyclomatic
```
USAGE:
hotspot.exe metrics
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
ARGS:
Sets the input path of source code to use [default: ./]
```