https://github.com/avdaredevil/git-loc
Get Github PR line-of-change stats for all Repos you work with on Github
https://github.com/avdaredevil/git-loc
delta git line-of-code lines-of-code perf performance-review prs stats
Last synced: 11 months ago
JSON representation
Get Github PR line-of-change stats for all Repos you work with on Github
- Host: GitHub
- URL: https://github.com/avdaredevil/git-loc
- Owner: avdaredevil
- Created: 2020-02-28T16:46:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-08T04:13:33.000Z (over 2 years ago)
- Last Synced: 2025-01-21T12:23:52.130Z (12 months ago)
- Topics: delta, git, line-of-code, lines-of-code, perf, performance-review, prs, stats
- Language: JavaScript
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Git-Loc
**CLI for reading your PR contribution stats across various repo's.** This tool is written as a single-entrypoint CLI, much like `git` with commands and options as the primary driver for interaction (rather than seperate scripts).
***Note:** This will ONLY track activity that you did using PRs, direct commits to `master` will not count!*
## General Usage
### CLI Flags
#### Get-Github-Data
Fetch github contribution data for user
```shell
git-stats get-github-data [ldap] [repos..] [aliases: get-data, get-prs]
```
| Key | Type | Default Value | Description |
| --- | --- | --- | --- |
| `ldap` | `string` | avdaredevil | Which user to get data for |
| `repos` | `string[]` | * | The Kubeflow repos to scan in |
| `files-to-ignore` | `string[]` | * | Files or regexes (marked as `r////`, ex. `r///\.jpg$/`) |
| `default-repo-namespace` | `string` | kubeflow | If repo is a single word, look under this Github Org / User |
| `pr-cache-freshness` | `number` | 1 | How old can the last PR be be before the cache is marked dirty, and I fetch newer PRs only (in days) |
| `expire-cache` | `boolean` | false | Expire the cache, fetch all github PR data from scratch, and re-cache |
| `verbose` | `boolean` | false | Increase the output verbosity of this tool. This includes throttle errors, passive debug logs, etc |
| `input-folder` | `string` | . | Input folder to use (uses $cwd, unless overridden) |
| `casual-commit-threshold` | `number` | 500 | How much can max(loc_a, loc_d) be before it seems to be an auto-generated file? (Will generate a warning) |
| `github-api-token-file` | `string` | 1 | You need to create a github personal access token at https://github.com/settings/tokens, because github has a very strict limit on anonymous API usage. |
#### Calculate
Calculate contributions for user for a give time-range
```shell
git-stats calculate [from] [to] [aliases: count]
```
| Key | Type | Default Value | Description |
| --- | --- | --- | --- |
| `from` | `string` | 6 months ago | <num> ago OR *A date like input (what date to look from)* |
| `to` | `string` | 0 months ago | <num> ago OR *A date like input (what date to look from)* |
### Setup
```bash
$ npm i -g git-loc
```
### Running (with installation)
```bash
$ git-loc -h # For help
$ git-loc get-github-data [github_user] [repos]
$ git-loc calculate "1 year ago" "2 quarters ago"
```
### Running (without installation)
```bash
$ cd
$ npm start -- get-github-data
```
---
***By**: [Apoorv Verma [AP]](http://linked.in/in/apoorvverma)*