TheRock/rocm-systems/projects/rccl/maint/run-clang-format.sh

#!/usr/bin/env bash
# run-clang-format.sh — Apply clang-format to all NCCL source files.
#
# The default is reformatting src/**.
# Clang-format will ignore any path listed in the top-level .clang-format-ignore file.
#
# Usage:
#   ./run-clang-format.sh [path]            # Apply formatting in-place
#   ./run-clang-format.sh --list [path]     # Print list of files that would be formatted
#   ./run-clang-format.sh --diff [path]     # Show unified diff of changes without applying

set -euo pipefail

MIN_VERSION=22

usage() {
  echo "Usage: $0 [--list | --diff] [path]" >&2
}

# ---------------------------------------------------------------------------
# Parse arguments
# ---------------------------------------------------------------------------
MODE=""
TARGET_PATH="$PWD/src"
TARGET_SET=0
while [[ $# -gt 0 ]]; do
  case "$1" in
    --list | --diff)
      if [[ -n "$MODE" ]]; then
        usage
        exit 1
      fi
      MODE="$1"
      ;;
    -h | --help)
      usage
      exit 0
      ;;
    --*)
      usage
      exit 1
      ;;
    *)
      if [[ "$TARGET_SET" -eq 1 ]]; then
        usage
        exit 1
      fi
      TARGET_PATH="$1"
      TARGET_SET=1
      ;;
  esac
  shift
done

# ---------------------------------------------------------------------------
# Locate clang-format and verify version
# ---------------------------------------------------------------------------
CLANG_FORMAT="${CLANG_FORMAT:-clang-format}"

if ! command -v "$CLANG_FORMAT" &>/dev/null; then
  echo "ERROR: clang-format not found. Install clang-format >= $MIN_VERSION." >&2
  exit 2
fi

VERSION=$("$CLANG_FORMAT" --version 2>&1 | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -1 | cut -d. -f1)
if [[ -z "$VERSION" || "$VERSION" -lt "$MIN_VERSION" ]]; then
  echo "ERROR: clang-format >= $MIN_VERSION required, found: $("$CLANG_FORMAT" --version)" >&2
  exit 2
fi

# ---------------------------------------------------------------------------
# Collect files, excluding vendored directories
# Top-level .clang-format-ignore controls which files won't be reformatted
# ---------------------------------------------------------------------------
FILES=()
if [[ -f "$TARGET_PATH" ]]; then
  FILES+=("$TARGET_PATH")
elif [[ -d "$TARGET_PATH" ]]; then
  while IFS= read -r f; do
    FILES+=("$f")
  done < <(
    find "$TARGET_PATH" \
      -type f \
      \( -name '*.cc' -o -name '*.cu' -o -name '*.cuh' -o -name '*.h' \) \
      | sort
  )
else
  echo "ERROR: path not found: $TARGET_PATH" >&2
  exit 1
fi

if [[ ${#FILES[@]} -eq 0 ]]; then
  echo "No source files found under $TARGET_PATH." >&2
  exit 0
fi

# ---------------------------------------------------------------------------
# Mode dispatch
# ---------------------------------------------------------------------------
case "$MODE" in
  --list)
    echo "Files that would be formatted (${#FILES[@]} total):"
    for f in "${FILES[@]}"; do
      echo "  $f"
    done
    ;;

  --diff)
    echo "Showing diff for ${#FILES[@]} files..."
    ANY=0
    for f in "${FILES[@]}"; do
      DIFF=$("$CLANG_FORMAT" --style=file "$f" | diff -u "$f" - || true)
      if [[ -n "$DIFF" ]]; then
        echo "--- $f"
        echo "$DIFF"
        ANY=1
      fi
    done
    if [[ "$ANY" -eq 0 ]]; then
      echo "All files already formatted."
    fi
    ;;

  "")
    echo "Formatting ${#FILES[@]} files..."
    "$CLANG_FORMAT" -i --style=file "${FILES[@]}"
    echo "Done."
    ;;

  *)
    usage
    exit 1
    ;;
esac