code-format.sh

#!/bin/bash

base='--cached'
target='distributed-main'
show_only=0
fail_on_diff=0
format_all=0

while [ "$#" -gt 0 ]; do
  case $1 in
  -h | --help)
    echo "Usage: $0 [--fail-on-diff] [--show-only] [--format-all] [--base|-b <base(=--cached)>] [--target|-t <target(=origin/master)>]"
    exit 0
    ;;
  --fail-on-diff)
    fail_on_diff=1
    shift
    ;;
  --show-only)
    show_only=1
    shift
    ;;
  --format-all)
    format_all=1
    shift
    ;;
  --base | -b)
    base="$2"
    shift
    shift
    ;;
  --target | -t)
    target="$2"
    shift
    shift
    ;;
  *)
    echo "error: unrecognized option $1"
    exit 1
    ;;
  esac
done

# hack for code format
if [ -f "pre-commit" ]; then
  cp pre-commit .git/hooks/pre-commit
fi

# 生成要检查的文件列表，排除3rdparty目录
files_to_check=()
if [ "$format_all" -eq 1 ]; then
  # 排除3rdparty目录下的所有文件
  files_to_check=($(git ls-files --exclude-standard | grep -v '^3rdparty/' | grep -v "$(git config --file .gitmodules --get-regexp path | awk '{ print $2 }' | xargs -I {} echo -n '\|{}' | cut -c 3-)"))
else
  # 排除3rdparty目录下的所有修改
  files_to_check=($(git diff $base $target --name-only --diff-filter=ACMRT --ignore-submodules | grep -v '^3rdparty/'))
fi

current_dir="$PWD"

# 使用正确的方式传递文件列表给find命令，并排除3rdparty目录
files_to_check_cpp=$(printf "%s\n" "${files_to_check[@]}" | xargs -I {} find {} -type f \
  -regextype posix-extended \
  -regex ".*\.(c|cpp|cc|h|hpp|cu|cuh)$" \
  ! -path "${current_dir}/3rdparty/*" 2>/dev/null)

files_to_check_py=$(printf "%s\n" "${files_to_check[@]}" | grep -v '^3rdparty/' | grep "\.\(py\)$")
files_to_check_pyi=$(printf "%s\n" "${files_to_check[@]}" | grep -v '^3rdparty/' | grep "\.\(pyi\)$")

if [ "$files_to_check_cpp" = "" ] && [ "$files_to_check_py" = "" ] && [ "$files_to_check_pyi" = "" ]; then
  exit 0
fi

if ! clang-format -version >/dev/null; then
  echo "error: clang-format not found, can be installed by: pip3 install clang-format"
  exit 1
fi

if ! command -v yapf &>/dev/null; then
  echo "yapf not found, can be installed by: pip3 install yapf"
  exit 1
fi

# 检查 ruff 是否安装
if ! command -v ruff &>/dev/null; then
  echo "ruff not found, can be installed by: pip install ruff"
  exit 1
fi

if [ "$show_only" -eq 1 ]; then
  has_diff=0
  # cpp files
  for f in $files_to_check_cpp; do
    if [ -L $f ]; then
      continue
    fi
    result=$(diff <(git show :$f) <(git show :$f | clang-format -style=file --assume-filename=$f))
    if [ "$result" != "" ]; then
      echo "===== $f ====="
      echo -e "$result"
      has_diff=1
    fi
  done
  # .py files
  for f in $files_to_check_py; do
    if [ -L $f ]; then
      continue
    fi
    result=$(diff <(git show :$f) <(git show :$f | yapf $f))
    if [ "$result" != "" ]; then
      echo "yapf ===== $f ====="
      echo -e "$result"
      has_diff=1
    fi
    ruff_result=$(ruff check --config python/pyproject.toml --diff $f)
    if [ "$ruff_result" != "" ]; then
      echo "ruff ===== $f ====="
      echo -e "$ruff_result"
      has_diff=1
    fi
  done
  # .pyi files
  for f in $files_to_check_pyi; do
    if [ -L $f ]; then
      continue
    fi
    ruff_result=$(ruff check --config python/pyproject.toml --diff $f)
    if [ "$ruff_result" != "" ]; then
      echo "ruff ===== $f ====="
      echo -e "$ruff_result"
      has_diff=1
    fi
  done
else
  if [[ ! -z $files_to_check_cpp ]]; then
    echo "Formatting cpp files by clang-format..."
    echo $files_to_check_cpp | xargs clang-format -i --style=file
  fi
  if [[ ! -z $files_to_check_py ]]; then
    echo "Formatting py files by yapf..."
    for f in $files_to_check_py; do
      echo $f | xargs yapf -i
    done
  fi
  if [[ ! -z $files_to_check_pyi ]]; then
    echo "Formatting pyi files by yapf..."
    echo $files_to_check_pyi | xargs yapf -i
  fi
  if [[ ! -z $files_to_check_py ]]; then
    echo "Formatting py files by ruff..."
    echo $files_to_check_py | xargs ruff check --config python/pyproject.toml --fix
  fi
  if [[ ! -z $files_to_check_pyi ]]; then
    echo "Formatting pyi files by ruff..."
    echo $files_to_check_pyi | xargs ruff check --config python/pyproject.toml --fix
  fi

  echo "Ensuring final newline for Python files..."
  for f in $files_to_check_py $files_to_check_pyi; do
    # If the file is not empty and does not end with a newline, add one.
    if [ -s "$f" ] && [ -n "$(tail -c1 "$f")" ]; then
      echo >> "$f"
    fi
  done
fi

if [[ "$fail_on_diff" -eq 1 ]] && [[ "$has_diff" -eq 1 ]]; then
  echo "code format check failed, please run the following command before commit: ./code-format.sh"
  exit 1
fi