使用SED或尴尬的GitConfig别名自动文档

Question

我当前正在使用以下代码（被黑客入侵）来使用'git别名'为我的git别名生成文档。这假设每个别名都以###开头有一个评论，并且别名格式为" alias_name =命令"。这是有效的，但是有人有更好的方法吗？：）

当前代码（$HOME/.bin/bin/gdoc的内容）：

grep --no-group-separator -A1 '###' "$HOME"/.gitconfig | awk 'END{if((NR%2))print p}!(NR%2){print$0p}{p=$0}' | sed -re 's/( =)(.*)(###)/:*/g' | awk -F* '{printf "33[1;31m%-30s33[0m %sn", $1, $2}' | sort

示例别名：

### use difftool to view differences in file
dt = difftool
# https://stackoverflow.com/questions/3321492/git-alias-with-positional-parameters/39523506#39523506
### add and commit a file, arg1=file, arg2=commit_message
ac = "!cd -- "${GIT_PREFIX:-.}" && git add "$1" && git commit -m "$2" #"
### remove any files that are in gitignore from tracking
ig = "!git rm --cached `git ls-files -i --exclude-from=.gitignore` #"
### print out available aliases
alias = "!$HOME/.bin/bin/gdoc #"
### add a file to gitignore
ignore = "!([ ! -e .gitignore ] && touch .gitignore) | echo $1 >> .gitignore #"
### git rm files that have been deleted without using git
r = "!git ls-files -z --deleted | xargs -0 git rm #"
# https://stackoverflow.com/questions/38057261/git-config-alias-escaping/39616600#39616600
### Quote a sh command, converting it to a git alias string
quote-string = "!read -r l; printf \"!; printf %s "$l" | sed 's/\([\"]\)/\\\1/g'; printf " #\"\n" #"
### Unquote a git alias command command, converting it to a sh command
quote-string-undo = "!read -r l; printf %s "$l" | sed 's/\\\([\"]\)/\1/g'; printf "\n" #"
### debug git aliases - 'git debug <alias>'
debug = "!set -x; GIT_TRACE=2 GIT_CURL_VERBOSE=2 GIT_TRACE_PERFORMANCE=2 GIT_TRACE_PACK_ACCESS=2 GIT_TRACE_PACKET=2 GIT_TRACE_PACKFILE=2 GIT_TRACE_SETUP=2 GIT_TRACE_SHALLOW=2 git"

当前输出：

ac:                         add and commit a file, arg1=file, arg2=commit_message
alias:                      print out available aliases
debug:                      debug git aliases - 'git debug <alias>'
dt:                         use difftool to view differences in file
ig:                         remove any files that are in gitignore from tracking
ignore:                     add a file to gitignore
quote-string-undo:          Unquote a git alias command command, converting it to a sh command
quote-string:               Quote a sh command, converting it to a git alias string
r:                          git rm files that have been deleted without using git

Answer 1

这样：

awk 'a{print $1""c;a=0}/###/{$1="";c=$0;a=1}' "$HOME"/.gitconfig | sort

在同一管道中使用awk，grep和sed主要是一个标志，表明它们没有被有效使用。通常，它们可以用单个awk命令代替。

对于缩进的输出，您可以使用column：

awk 'a{print $1"%"c;a=0}/###/{$1="";c=$0;a=1}' "$HOME"/.gitconfig | sort | column -ts%

注意：我正在向%分隔符注入awk，该分离器用于用column

缩进输出

输出：

ac                  add and commit a file, arg1=file, arg2=commit_message
alias               print out available aliases
debug               debug git aliases - 'git debug <alias>'
dt                  use difftool to view differences in file
ignore              add a file to gitignore
ig                  remove any files that are in gitignore from tracking
quote-string        Quote a sh command, converting it to a git alias string
quote-string-undo   Unquote a git alias command command, converting it to a sh command
r                   git rm files that have been deleted without using git

---

如果您有gawk（GNU尴尬），也可以使用尴尬，这样：

#!/usr/bin/gawk -f
in_alias{
    aliases[$1]=comment
    in_alias=0
    len=length($1)
    if(len > maxlen){
        maxlen = len
    }
}
/###/{
    $1=""
    comment=$0
    in_alias=1
}
END{
    n = asorti(aliases, sorted) # <-- Requires gawk
    for(i = 1; i <= n; i ++){
        pad = maxlen - length(sorted[i]) + 1
        printf "%s%"pad"s%sn",sorted[i]," ",aliases[sorted[i]]
    }
}

将其保存到文件中，例如，/usr/locar/bin/git-aliases ，使其可执行：

chmod +x /usr/local/bin/git-aliases
git-aliases "$HOME"/.gitconfig