codeformat 脚本优化建议

[0x1306a94]

1. 将 pip3 改为 pipx 解决高版本 pip 安装需要 --break-system-packages 等配置, 这也是 pip 在安装时建议使用 pipx
2. 优化后的脚本可以确保多人协作以及CI检查，使用的 clang-format 版本一致。因为相同的配置 但不同版本的 clang-format 结果有差异
3. ${HOME}/.local/bin 为 pipx 默认的路径， 因为每个人的 PATH 配置可能是不一致的。也许也通过其他方式安装了 clang-format 所以在脚本中重新设置 PATH 这样可以保证使用的是要求的指定版本

codeformat.sh

#!/usr/bin/env bash
if [[ $(uname) == 'Darwin' ]]; then
  MAC_REQUIRED_TOOLS="python3 pipx"
  for TOOL in ${MAC_REQUIRED_TOOLS[@]}; do
    if [ ! $(which $TOOL) ]; then
      if [ ! $(which brew) ]; then
        echo "Homebrew not found. Trying to install..."
        /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" ||
          exit 1
      fi
      echo "$TOOL not found. Trying to install..."
      brew install $TOOL || exit 1
    fi
  done

  export PATH=${HOME}/.local/bin:/opt/homebrew/bin:$PATH
  CLANG_FORMAT_VERSION=`clang-format --version`
  if [[ "${CLANG_FORMAT_VERSION}" =~ "14." ]]
  then
      echo "----${CLANG_FORMAT_VERSION}----"
  else
      echo "----install clang-format----"
      pipx install clang-format==14
  fi
fi

echo "----begin to scan code format----"
find include/ -iname '*.h' -print0 | xargs clang-format -i
# shellcheck disable=SC2038
find src -name "*.cpp" -print  -o -name "*.h" -print  -o -name "*.mm" -print  -o -name "*.m" -print | xargs clang-format -i
# shellcheck disable=SC2038
find test \( -path test/framework/lzma \) -prune -o -name "*.cpp" -print  -o -name "*.h" -print | xargs clang-format -i
find viewer/src  -name "*.cpp" -print  -o -name "*.h" -print  -o -name "*.mm" -print -o -name "*.m" -print -o -name "*.hpp" -print | xargs clang-format -i
find exporter/src  -name "*.cpp" -print  -o -name "*.h" -print  -o -name "*.mm" -print -o -name "*.m" -print -o -name "*.hpp" -print | xargs clang-format -i

git diff
result=`git diff`
if [[ $result =~ "diff" ]]
then
    echo "----Failed to pass coding specification----"
    exit 1
else
    echo "----Pass coding specification----"
fi

echo "----Complete the scan code format-----"

也可以通过 git hooks 在提交时自动格式化
pre-commit.sh

#!/bin/bash

export PATH=${HOME}/.local/bin:/opt/homebrew/bin:$PATH

CPP_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep -E '\.(h|hpp|c|cpp|m|mm)$')

if [ -z "$CPP_FILES" ]; then
  exit 0
fi

if [ -n "$CPP_FILES" ]; then
  clang-format -i $CPP_FILES
  git add $CPP_FILES
fi

exit 0

将上面的文件保存到项目目录中如

├── git_hooks
│   └── pre-commit.sh

配置 git

chmod +x git_hooks/pre-commit.sh
cd .git/hooks
ln -s ../../git_hooks/pre-commit.sh pre-commit

[Hparty]

感谢建议，目前已经更新codeformat脚本 #3299

[0x1306a94]

tgfx 也可同步下

[0x1306a94]

😯 看到tgfx已经同步了