Merge pull request #557 from spacewander/check_integrity

Add check integrity script

check_integrity.sh

@@ -0,0 +1,73 @@
+#!/usr/bin/env bash
+
+err() {
+    echo >&2 "$1"
+    exit 1
+}
+
+check_bash_script() {
+    local cmd="git-$1"
+
+    test -f "bin/$cmd" \
+        || err "Bin/$cmd does not exist"
+
+    test -x "bin/$cmd" \
+        || err "Run 'chmod +x bin/$cmd' to make it executable"
+
+    shebang=$(head -n1 "bin/$cmd")
+    test "$shebang" == "#!/usr/bin/env bash" \
+        || err "Start git-$1 with '#!/usr/bin/env bash'"
+}
+
+check_documentation() {
+    local cmd="git-$1"
+    test -f "man/$cmd.md" || err "create man/$cmd.md"
+
+    if [ ! -f "man/$cmd.1" ] || [ ! -f "man/$cmd.html" ]
+    then
+        err "Run 'make docs' to create man/$cmd.1 and man/$cmd.html"
+    fi
+}
+
+check_Commands_page() {
+    # These are special cases. All listed together, so we ignore them
+    local whitelist=('bug' 'chore' 'feature' 'refactor')
+    for cmd in ${whitelist[*]}; do
+        test "$1" == "$cmd" && return
+    done
+
+    grep "\- \[\`git $1\`\](#git-$1)" Commands.md >/dev/null \
+        || err "Add git-$1 in the list of commands in Commands.md"
+
+    grep "^## git $1" Commands.md >/dev/null \
+        || err "Add description of git-$1 in Commands.md"
+}
+
+check_completion() {
+    grep "$1:" etc/git-extras-completion.zsh > /dev/null || \
+        err "Add git-$1 to the completion list at the end of etc/git-extras-completion.zsh"
+}
+
+check() {
+    check_bash_script "$1"
+    check_documentation "$1"
+    check_Commands_page "$1"
+    check_completion "$1"
+}
+
+usage() {
+    echo >&2 "Usage: ./check_integrity.sh <command-name> [<command-name2> ...]"
+    exit 0
+}
+
+test $# == 0 && usage
+
+for name in "$@"; do
+    name=${name#git-}
+    [[ "$name" == "rscp" || "$name" == "line-summary" ]] && echo "Skip command $name" \
+        && continue
+    check "$name"
+done
+
+echo 'All done'
+exit 0