pre-commit.sh

#!/bin/bash

#  Purpose   : pre-commit hook
#  Project   : ebib
#  Commenced : 04-Sep-2012

#  NOTES:
#
#    name file : 'pre-commit.sh'
#    symlink   : ln --symbolic pre-commit.sh .git/hooks/pre-commit
#    then      : place under revision control
#
#    the 'pre-commit' hook is the first of four 'git'
#    hooks that are run prior to each commit
#
#    this script regenerates the info file if the source file for the
#    manual (ebib.text) is newer than ebib.info.

# PREAMBLE

SOURCE="manual/ebib.text"                     # markdown source
TEXINFO_BBODY="manual/before-body.texi"       # texinfo headers
TEXINFO="manual/ebib.texi"                    # texinfo output
INFO="ebib.info"                              # GNU info output
HTML_HEADERS="manual/header-include.html"     # HTML header includes
HTML="docs/ebib-manual.html"                  # HTML output
CSS="styles/manual.css"                       # CSS file
SCRIPT=$(basename "$0")

E_SUCCESS=0
E_FAILURE=1

unset GIT_LITERAL_PATHSPECS # See Magit FAQ A.2.10 and https://github.com/magit/magit/discussions/4654

# FUNCTIONS

function confirm_file
{
    local file="$1"
    test -f "$file" && return 0
    echo "$SCRIPT: regular file not found: $file"
    let "errors++"
    return 1
}

function create_texi
{
    local source="$1"
    echo "$SCRIPT: running pandoc to create texinfo"
    pandoc --read=markdown+gfm_auto_identifiers \
           --write=texinfo \
           --output="$TEXINFO" \
           --include-before-body="$TEXINFO_BBODY" \
           --standalone \
           --table-of-contents \
           "$1" && return 0
    echo "$SCRIPT: pandoc -w texinfo failed"
    let "errors++"
    return 1
}

function run_makeinfo
{
    local source="$1"
    echo "$SCRIPT: runnig makeinfo"
    makeinfo "$1" && return 0 # makeinfo puts the output file in the current dir
    echo "$SCRIPT: makeinfo run failed"
    let "errors++"
    return 1
}


function create_html
{
    local source="$1"
    echo "$SCRIPT: running pandoc to create HTML"
    pandoc --read=markdown \
           --write=html \
           --standalone \
           --table-of-contents \
           --css="$CSS" \
           --include-in-header="$HTML_HEADERS" \
           --output="$HTML" \
           "$1" && return 0
    echo "$SCRIPT: pandoc -w html failed"
    let "errors++"
    return 1
}

function check_exit
{
    local errors="$1"
    test "$errors" -eq 0 && return 0
    echo "$SCRIPT: fatal: exit status $E_FAILURE"
    exit $E_FAILURE
}

# ACTIVE code

errors=0

confirm_file "$SOURCE"
confirm_file "$INFO"
check_exit   "$errors"
if [ "$(git status --porcelain manual/ebib.text)" == 'M  manual/ebib.text' ] ; then
    echo "$SCRIPT: regenerating manual files"
    git stash -q --keep-index
    create_texi "$SOURCE" && run_makeinfo "$TEXINFO" && git add "$INFO"
    create_html "$SOURCE" && git add "$HTML"
    git stash pop -q
fi
check_exit   "$errors"

echo "$SCRIPT: documentation is current"
exit $E_SUCCESS

# end of file