averello/git-quick-stats-mirror
1
0
Fork 0
mirror of https://github.com/git-quick-stats/git-quick-stats.git synced 2025-12-16 12:00:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

update manpage

Browse Source
This commit is contained in:
arzzen
2025-06-17 19:01:38 +02:00
parent 95136d3f92 cebb5a8f48
commit 376887a394
4 changed files with 40 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -222,10 +222,13 @@ export _GIT_SORT_BY="name-asc"
### Color themes ### Color themes
You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy` You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`.
You can completely disable the color theme by setting the `_MENU_THEME` variable to `none`.
```bash ```bash
export _MENU_THEME="legacy" export _MENU_THEME="legacy"
# or
export _MENU_THEME="none"
``` ```
![legacyThemeScreenshot](https://github.com/user-attachments/assets/3b319c1a-827f-47b8-bbfa-b8b59a39deef) ![legacyThemeScreenshot](https://github.com/user-attachments/assets/3b319c1a-827f-47b8-bbfa-b8b59a39deef)

23
git-quick-stats
View File

@@ -275,14 +275,15 @@ ADDITIONAL USAGE
ex: export _GIT_MERGE_VIEW=enable ex: export _GIT_MERGE_VIEW=enable
You can also set _GIT_MERGE_VIEW to only show merge commits You can also set _GIT_MERGE_VIEW to only show merge commits
ex: export _GIT_MERGE_VIEW=exclusive ex: export _GIT_MERGE_VIEW=exclusive
You can set _MENU_THEME to display the legacy color scheme You can change to the legacy color scheme by toggling the variable \"_MENU_THEME\" between \"default\" and \"legacy\".
You can completely disable the color theme by setting the \"_MENU_THEME\" variable to \"none\".
ex: export _MENU_THEME=legacy ex: export _MENU_THEME=legacy
You can set _GIT_BRANCH to set the branch of the stats You can set _GIT_BRANCH to set the branch of the stats
ex: export _GIT_BRANCH=master ex: export _GIT_BRANCH=master
You can set _GIT_IGNORE_AUTHORS to filter out specific authors You can set _GIT_IGNORE_AUTHORS to filter out specific authors
ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\" ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\"
You can sort contribution stats by field name, commits, insertions, deletions, or lines - total lines changed and order - asc, desc You can sort contribution stats by field \"name\", \"commits\", \"insertions\", \"deletions\", or \"lines\" - total lines changed and order - \"asc\", \"desc\"
ex: export _GIT_SORT_BY=name-asc" ex: export _GIT_SORT_BY=\"name-asc\""
} }
################################################################################ ################################################################################
@@ -305,19 +306,29 @@ function showMenu() {
EXIT_TXT="" EXIT_TXT=""
# Adjustable color menu option # Adjustable color menu option
if [[ "${_theme}" == "legacy" ]]; then case "${_theme}" in
"legacy" )
TITLES="${BOLD}${RED}" TITLES="${BOLD}${RED}"
TEXT="${NORMAL}${CYAN}" TEXT="${NORMAL}${CYAN}"
NUMS="${BOLD}${YELLOW}" NUMS="${BOLD}${YELLOW}"
HELP_TXT="${NORMAL}${YELLOW}" HELP_TXT="${NORMAL}${YELLOW}"
EXIT_TXT="${BOLD}${RED}" EXIT_TXT="${BOLD}${RED}"
else ;;
"none" )
TITLES="${BOLD}"
TEXT="${NORMAL}"
NUMS="${BOLD}"
HELP_TXT="${NORMAL}"
EXIT_TXT="${BOLD}"
;;
*)
TITLES="${BOLD}${CYAN}" TITLES="${BOLD}${CYAN}"
TEXT="${NORMAL}${WHITE}" TEXT="${NORMAL}${WHITE}"
NUMS="${NORMAL}${BOLD}${WHITE}" NUMS="${NORMAL}${BOLD}${WHITE}"
HELP_TXT="${NORMAL}${CYAN}" HELP_TXT="${NORMAL}${CYAN}"
EXIT_TXT="${BOLD}${CYAN}" EXIT_TXT="${BOLD}${CYAN}"
fi ;;
esac
printf %b "\\n${TITLES} Generate:${NORMAL}\\n" printf %b "\\n${TITLES} Generate:${NORMAL}\\n"
printf %b "${NUMS} 1)${TEXT} Contribution stats (by author)\\n" printf %b "${NUMS} 1)${TEXT} Contribution stats (by author)\\n"

7
git-quick-stats.1
View File

@@ -165,14 +165,17 @@ You can also set _GIT_MERGE_VIEW to only show merge commits, example:
.PP .PP
.B export _GIT_MERGE_VIEW="exclusive" .B export _GIT_MERGE_VIEW="exclusive"
.PP .PP
You can sort contribution stats by field name, commits, insertions, deletions, or lines (total lines changed) and order (asc, desc). e.g.: commits-desc You can sort contribution stats by field "name", "commits", "insertions", "deletions", or "lines" (total lines changed) and order ("asc", "desc"). e.g.: "commits-desc"
.PP .PP
.B export _GIT_SORT_BY="name-asc" .B export _GIT_SORT_BY="name-asc"
.PP .PP
You can switch to the legacy color scheme, example: You can change to the legacy color scheme by toggling the variable "_MENU_THEME" between "default" and "legacy". You can completely disable the color theme by setting the "_MENU_THEME" variable to "none", example:
.PP .PP
.B export _MENU_THEME=legacy .B export _MENU_THEME=legacy
.PP .PP
or
.B export _MENU_THEME=none
.PP
You can set _GIT_BRANCH to set the branch of the stats, example: You can set _GIT_BRANCH to set the branch of the stats, example:
.PP .PP
.B export _GIT_BRANCH="master" .B export _GIT_BRANCH="master"

7
tests/commands_test.sh
View File

@@ -92,14 +92,15 @@ ADDITIONAL USAGE
ex: export _GIT_MERGE_VIEW=enable ex: export _GIT_MERGE_VIEW=enable
You can also set _GIT_MERGE_VIEW to only show merge commits You can also set _GIT_MERGE_VIEW to only show merge commits
ex: export _GIT_MERGE_VIEW=exclusive ex: export _GIT_MERGE_VIEW=exclusive
You can set _MENU_THEME to display the legacy color scheme You can change to the legacy color scheme by toggling the variable \"_MENU_THEME\" between \"default\" and \"legacy\".
You can completely disable the color theme by setting the \"_MENU_THEME\" variable to \"none\".
ex: export _MENU_THEME=legacy ex: export _MENU_THEME=legacy
You can set _GIT_BRANCH to set the branch of the stats You can set _GIT_BRANCH to set the branch of the stats
ex: export _GIT_BRANCH=master ex: export _GIT_BRANCH=master
You can set _GIT_IGNORE_AUTHORS to filter out specific authors You can set _GIT_IGNORE_AUTHORS to filter out specific authors
ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\" ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\"
You can sort contribution stats by field name, commits, insertions, deletions, or lines - total lines changed and order - asc, desc You can sort contribution stats by field \"name\", \"commits\", \"insertions\", \"deletions\", or \"lines\" - total lines changed and order - \"asc\", \"desc\"
ex: export _GIT_SORT_BY=name-asc" ex: export _GIT_SORT_BY=\"name-asc\""
assert_raises "$src fail" 1 assert_raises "$src fail" 1