clang-format.sh

#!/bin/bash

# This script compares two branches (eg. pr-bugfix - <> develop )# and finds files of types cpp, hpp, c, h
# that have changed between branches and processes each of these files using clang-format.
# The default behavior of clang-format is to auto change the file and format according to the style guide (.clang-format). 
# If these files change the CI will alert fail and alert the user to correct the changes. 
# The user should run this script locally and accept the auto changes proposed by clang-format.
#
# You can also run the clang-format on the entire /src directory if desired. To do that can use the following: 
# using find on for Mac osx 
# find -E ./src -regex '.*\.(cpp|hpp|c|h)$'  | xargs clang-format -style=file -i -fallback-style=none
# using find on linux 
# find ./src -regextype posix-extended -regex '.*\.(cpp|hpp|c|h)$' | xargs clang-format -style=file -i -fallback-style=none

display_usage() {
  echo -e "\nUsage:\ PR_BRANCH_NAME TARGET_BRANCH_NAME \n"
}

if [  $# -le 1 ]
then
  display_usage
  exit 1
fi

PR_BRANCH_NAME=$1
TARGET_BRANCH_NAME=$2

# If pointing at HEAD, then also include uncommited changes, but only the cached (=staged for next commit) so we can use it as a precommit script
if [ $PR_BRANCH_NAME == "HEAD" ]
then
  PR_BRANCH_NAME="--cached "
fi

# first find if any files changed
num=$(git diff $PR_BRANCH_NAME $TARGET_BRANCH_NAME --name-only | grep '.*\.\(cpp\|c\|hpp\|h\)$' | wc -l | tr -d '[:space:]')

if [ $num -eq 0 ]
then
    echo "No files of type (cpp, c, hpp, h) changed. Skipping clang-formatting"
  exit 0
fi

git diff $PR_BRANCH_NAME $TARGET_BRANCH_NAME --name-only | grep '.*\.\(cpp\|c\|hpp\|h\)$' | xargs clang-format -style=file -i -fallback-style=none

# clang-format will auto correct files so prepare the diff and use this as artifact
git diff > clang_format.patch

# Delete if nothhing otherwise exit 1 to indicate a failed job
if [ ! -s clang_format.patch ]
then
    rm clang_format.patch
    exit 0
else
    echo "clang-format auto corrected files:"
    git diff --name-only
    echo -e "\nPlease correct these files. You can run ci/clang-format.sh locally and commit changes"
  exit 1
fi

exit 0