iOS 格式化代码

SpaceCommander + ClangFormat

介绍:

• SpaceCommander为iOS开发团队提供了一个，无需任何手动修改，以统一格式将Object-C代码commit到git仓库的工具。它以git hooks的方式来工作.

• clang-format是一个命令行的工具,你可以通过源码编译来得到这个工具,也可以用brew来安装(brew install clang-format),安装完了就可以使用了,clang-format的基础用法在ClangFormat基本用法,其内置了四种风格-LLVM, Google, Chromium, Mozilla, WebKit,当然,其也提供了常见的风格配置来支持你的自定义风格

使用方法:

1. git clone https://github.com/lanpeng125/spacecommander.git
2. 在你的工程目录下执行 /Users/lanpeng/spacecommander/setup-repo.sh (对应自己的spacecommander目录)
3. 当你commit时就会给你检查格式,不符合要求会有提示

屏幕快照 2018-07-16 下午2.26.43.png

4. 按照提示格式相应的文件

"/Users/lanpeng/spacecommander"/format-objc-file.sh 'SaunFaTest/ViewController.m'格式单一文件
"/Users/lanpeng/spacecommander"/format-objc-files.sh -s 格式所有文件

5. 批量修改整个工程的文件(他会忽略pods文件),在工程目录下执行
6. 路径比较长,也可以在.bash_profile中使用alias如下:

#SPACECOMMANDER环境变量

export SPACECOMMANDER="/Users/lanpeng/spacecommander"

# 使用fmto xxx.m格式化这个文件

alias fmtone="$SPACECOMMANDER/format-objc-file.sh"

# 格式化工程中所有的文件的(包含新建文件)

alias fmtall="$SPACECOMMANDER/format-objc-files.sh -s"

7. 也可以忽略这次提交的格式化检查git commit --no-verify

需要注意的点

1. 只会格式化被暂存的文件
2. 默认.clang-format会在ignore里面,需要吧ignore里面的.clang-format去掉，否则下次commit就不会对代码进行格式检查
3. 所有的格式都在.clang-format里面，大部分已经加了中文注释，可以clone下来自定义。

参考

1. https://yohunl.com/ocdai-ma-gui-fan-de-spacecommandershi-yong/

2. https://blog.csdn.net/softimite_zifeng/article/details/78357898

3. https://www.jianshu.com/p/346f439d230c