iOS Clang-Format Xcode 代码格式化

在Xcode中配置clang-format

1. 通过brew安装 `clang-format`

brew install clang-format

查看是否安装成功
clang-format --version
clang-format version 14.0.6
说明安装成功了

2. 添加自动化服务

打开自动操作如下图
打开"Automator" 选择 "Quick Action"/"快捷操作"
按照下图添加 shell 脚本

# 脚本具体内容
export PATH=/usr/local/bin:$PATH
clang-format

3. 保存命名为 xcode_format (后边会用到)

4. 配置文件在当前用户的根目录 ~ 放置一个 .clang-format 文件

cd ~/
touch ~/.clang-format

.clnag-format 文件的示例 (更多的选项可以查看clang-format可选项)
我的 .clnag-format 文件配置如下

# 工具 https://github.com/mapbox/XcodeClangFormat(需要添加签名使用)
# 函数名详细地址 英文 http://clang.llvm.org/docs/ClangFormatStyleOptions.html
# 函数名详细地址 中文 https://www.cnblogs.com/PaulpauL/p/5929753.html

# OC语言
Language: ObjC

# 基于LLVM格式
# BasedOnStyle: LLVM

# 对齐注释
AlignTrailingComments: true

# 指针和引用的对齐方式
PointerAlignment: Right

# 用于缩进的列数
IndentWidth: 4

# 针对OC的block的缩进宽度
ObjCBlockIndentWidth: 4

# OC的block嵌套参数不换行
ObjCBreakBeforeNestedBlockParam: false

# switch的case缩进
IndentCaseLabels: true

# OC里面，在@property后加空格
ObjCSpaceAfterProperty: true

# 括号中的(),{},[]代码对齐方式
AlignAfterOpenBracket: Align

#ContinuationIndentWidth: 0

# 赋值=对齐
AlignConsecutiveAssignments: true

# 声明参数对齐
AlignConsecutiveDeclarations: false

# 运算符位置
BreakBeforeBinaryOperators: None

# 如果为真（true）, 三元运算符将被放置在换行后
BreakBeforeTernaryOperators: false

# 总是在逗号和对齐逗号跟冒号前把构造函数初始化式换行
BreakConstructorInitializersBeforeComma: false

# 允许短的函数放在同一行
#AllowShortFunctionsOnASingleLine: None

# 允许case在同一行
AllowShortCaseLabelsOnASingleLine: false

# OC里面，在Protocol前后加空格
ObjCSpaceBeforeProtocolList: true

# 单行注释前的空格数
SpacesBeforeTrailingComments: 1

# 连续的空行保留几行
MaxEmptyLinesToKeep: 1

# 保留block里面的空行
KeepEmptyLinesAtTheStartOfBlocks: false

# 每行字符的限制，0表示没有限制
ColumnLimit: 0

# []中添加空格
SpacesInSquareBrackets: false

# ()中添加空格
SpacesInParentheses : false

# @[]里面两边空格，默认true
SpacesInContainerLiterals: false

# 赋值运算符前加空格
SpaceBeforeAssignmentOperators: true

# 在空括号中加空格
SpaceInEmptyParentheses: false

# 在<>中间插入空格
SpacesInAngles: false

# 换行的时候对齐操作符
AlignOperands: true

# 允许if在同一行
AllowShortIfStatementsOnASingleLine: true

# 允许while在同一行
AllowShortLoopsOnASingleLine: false

# 允许将简单的语句块放到同一行
AllowShortBlocksOnASingleLine: true

#缩进函数名
IndentWrappedFunctionNames: false

# 形参 如果为false要么都在同一行，要么各有一行
BinPackParameters: false

# 实参 如果为false要么都在同一行，要么各有一行
BinPackArguments: false

# 大括号换行
BreakBeforeBraces: Custom
BraceWrapping:
  # class定义后面
  AfterClass: true
  # 控制语句后面
  AfterControlStatement: false
  # enum定义后面
  AfterEnum: false
  # 函数定义后面
  AfterFunction: false
  # 命名空间定义后面
  AfterNamespace: false
  # struct定义后面
  AfterStruct: false
  # union定义后面
  AfterUnion: false
  # catch之前
  BeforeCatch: false

5. 在Xcode中使用

command + A  全选 ==> 右键(双指按压触摸板) 如下图选择 Services ==> xcode_format(刚刚创建的脚本)

查看脚本文件保存的路径

open ~/Library/Services

6. 设置快捷键

系统偏好->键盘->快捷键->app快捷键->选择Xcode->设置快捷键按钮

7. 如果报如下错误

查看 /usr/local/bin 文件夹下是否存在 clang-format 可执行文件

cd  /usr/local/bin

如果不存在,
1 . 访问LLVM下载页
2 .选择需要的LLVM版本进行下载,我这里选择了最新的版本 15.0.2

3 . 选择mac对应的架构我的电脑是M1 选择了arm64架构

4 . 把解压文件夹中bin目录下的clang-format文件复制到usr/local/bin文件夹里,sudo mv (解压之后的路径)/bin/clang-format /usr/local/bin/clang-format

这样 clang-format, bash 命令未找到。的问题就解决了