.github/bin/run-format.sh

#!/usr/bin/env bash
# Copyright 2021 The Verible Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -u  # only use variables once assigned
set -e  # error out on error.

SHOW_DIFF=0

while [ $# -ne 0 ]; do
  case $1 in
    --show-diff) SHOW_DIFF=1;;
    *)
      echo "Unknown option $1"
      exit 1
      ;;
  esac
  shift 1
done

FORMAT_OUT=${TMPDIR:-/tmp}/clang-format-diff.out

# Use the provided Clang format binary, or try to fallback to clang-format-17
# or clang-format.
if [[ ! -v CLANG_FORMAT ]]; then
  if command -v "clang-format-17" 2>&1 >/dev/null
  then
    CLANG_FORMAT="clang-format-17"
  elif command -v "clang-format" 2>&1 >/dev/null
  then
    CLANG_FORMAT="clang-format"
  else
    (echo "-- Missing the clang-format binary! --"; exit 1)
  fi
fi

BUILDIFIER=${BUILDIFIER:-buildifier}

# Currently, we're using clang-format 17, as newer versions still have some
# volatility in minor version.
${CLANG_FORMAT} --version | grep "17\." ||
  ( echo "-- Need clang-format 17. Currently CLANG_FORMAT=$CLANG_FORMAT --";
    exit 1)

# Run on all files.

find . -name "*.h" -o -name "*.cc" \
  | egrep -v 'third_party/|external_libs/|.github/' \
  | xargs -P2 ${CLANG_FORMAT} -i

# If we have buildifier installed, use that to format BUILD files
if command -v ${BUILDIFIER} >/dev/null; then
  echo "Run $(buildifier --version)"
  # TODO(hzeller): re-enable -lint=fix once compatible bazel version range again
  ${BUILDIFIER} MODULE.bazel $(find . -name BUILD -o -name "*.bzl")
fi

if [ ${SHOW_DIFF} -eq 1 ]; then
  # Check if we got any diff
  git diff > ${FORMAT_OUT}

  if [ -s ${FORMAT_OUT} ]; then
    echo "Style not matching (see https://github.com/chipsalliance/verible/blob/master/CONTRIBUTING.md#style)"
    echo "Run"
    echo "  .github/bin/run-format.sh"
    echo "-------------------------------------------------"
    echo
    cat ${FORMAT_OUT}
    exit 1
  fi
fi

exit 0