前言

---

众所周知，程序员们的代码风格因人而异，好在有自动规范代码格式工具可以帮助解决代码风格迥异的问题。结合同事的推荐以及自己的搜索、实践，个人更推荐使用square/spacecommander。优点：

1. 使用方法极其简单。
2. 功能丰富。
3. 可默认及自定义忽略不需格式化的文件。

尽管spacecommander已经大大方便了代码的格式化，但并没有提供自动格式化及提交代码的功能。再加上自己在实践过程中遇到的问题，促使我对spacecommander进行了一番改造，具体而言，就是fork了一下原工程，修改了其中的脚本。参见：whoyoung/spacecommander。

square/spacecommander使用及功能简介

---

Installation Locally

（我也不知道为什么我写着写着，就开始用英文写了，只好用中文再翻译了一下了。。。）

1. clone or download this repository to your Mac's path, for example: /Users/young/Documents/iOS/spacecommander.
   (翻译：克隆或下载仓库到本地路径)
2. cd "your target project's path" in terminal. For example: cd /Users/young/Documents/iOS/testClangFormat. Then run the command (notice: the path should be replaced by your own spacecommander's path): "/Users/young/Documents/iOS/spacecommander"/setup-repo.sh
   (翻译：用终端定位到自己想格式化的工程根目录下，执行命令)

Usage

(翻译：执行完上面的命令后，就可以尝试修改工程文件，然后在sourcetree点击提交，接下来按弹出的提示，拷贝命令在终端执行，然后再次点击提交就OK了)
After Installation Locally, modifying your project's files, clicking sourcetree's button - "commit" to commit changes. then, you may see, like this:

committing.png

According the tips, you just copy the command, then in your target project's path, run :

"/Users/young/Documents/iOS/spacecommander"/format-objc-file.sh 'testClangFormat/AppDelegate.h' && git add 'testClangFormat/AppDelegate.h';
"/Users/young/Documents/iOS/spacecommander"/format-objc-file.sh 'testClangFormat/AppDelegate.m' && git add 'testClangFormat/AppDelegate.m'

or
"/Users/young/Documents/iOS/spacecommander"/format-objc-files.sh -s

Then, commit changes again, you will find these files had been formatted.
If you think it has meeting your demand ,and "/Users/young/Documents/iOS/spacecommander"/format-objc-files.sh -s is run correctly。You just ignore these following introduces is OK.
之所以在这里强调一下"/Users/young/Documents/iOS/spacecommander"/format-objc-files.sh -s这个命令是否成功将你的代码格式化了，是因为我在自己的Mac上执行这个命令，并不起作用。而在朋友的电脑上却能正确执行。分析了各种原因，也没能解决。这也直接促成了我修改了 spacecommander 的脚本，顺带着实现了自动格式化代码并提交。参见下面?的介绍：优化: 自动格式化提交，无需手动拷贝命令执行

.clang-format

执行过setup-repo命令后，在你的目标工程根目录下会生成一个符号链接文件：.clang-format (这是一个隐藏文件，可以用快捷键 shift+command+. 显示隐藏的文件)。这个文件就是格式化代码的依据，自己可以按自己的喜好来定: 所有可配置的格式 。我修改了其中两个配置：

• BreakBeforeBraces: Attach
• MaxEmptyLinesToKeep: 1

在.clang-format的配置属性中: DisableFormat (BOOL) 决定着当前的配置文件是否起作用。spacecommander 默认配置为DisableFormat: false。所以，如果不想暂时不想格式化代码，只要改成DisableFormat: true就行了。然鹅，我的电脑有毒，改了这个配置竟不起作用！！！只好再次祭出修改spacecommander 脚本大法了。参见下面?的介绍：Enable or Disable 格式化代码

Ignore single file (忽略格式化单个文件)

如果不想格式化某个文件，可以在文件的第一行加上: #pragma Formatter Exempt 或者 // MARK: Formatter Exempt

Ignore files within directories (忽略格式化指定目录下的所有文件)

如果想忽略某些目录下的所有文件,只需在工程根目录下新建一个文件.formatting-directory-ignore ,在文件中加入想忽略的文件路径，不同路径用换行符分隔，路径后面不要有空格。例如，我的工程中有两个目录dir1和dir2：

忽略目录.png

.formatting-directory-ignore文件内容如下：

ignore.png

files within directories (格式化指定目录下的所有文件)

如果仅仅想格式化指定目录下的文件，与Ignore files within directories操作方法一样，区别在于新建的文件名叫.formatting-directory

Functions

---

• format-objc-file.sh <file> 格式化单个文件
• format-objc-files.sh 格式化所有修改过的文件(实际上是遍历所有修改过的文件，逐个执行 format-objc-file.sh <file> && git add <file>命令)
• format-objc-files-in-repo.sh 格式化整个工程里的Objective-C文件(不包括用pod或Carthage管理的代码)
• format-objc-file-dry-run.sh <file> 将格式化的代码标准输出到一个新的文件，不改变原文件

优化: 自动格式化提交，无需手动拷贝命令执行

通过clone或下载 whoyoung/spacecommander到Mac上，路径：例如/Users/young/Documents/iOS/spacecommander-whoyoung，然后在目标工程根目录下执行"/Users/young/Documents/iOS/spacecommander-whoyoung"/setup-repo.sh命令即可。以后每次点击提交，都会自动格式化代码并提交，不会再弹出提示框，要求手动拷贝命令并执行了。
其他操作及命令与square/spacecommander 一致。
实现自动格式化并提交的原理挺简单，只是把spacecommander目录下的format-objc-hook脚本修改了一下：

1. 将代码块(记为：代码块A，这部分代码的作用是获取所有修改过的文件)：

objc_files=$(objc_files_to_format "$1")
[ -z "$objc_files" ] && exit 0

下面的代码全部注释掉

2. 在代码块A下面写入代码块B(这部分代码的作用是直接调用脚本format-objc-files.sh格式化所有修改过的文件)

$("$DIR"/format-objc-files.sh -s)
exit 0

之所以这么修改，是因为脚本 format-objc-files.sh 和format-objc-hook里的同一个命令： objc_files=$(objc_files_to_format "$1")，在我的Mac上执行的结果不一样。format-objc-hook脚本执行的结果是正确的。既然format-objc-hook这个脚本里获取到的objc_files是正确的，那就直接在format-objc-hook里执行format-objc-files.sh就行了。顺带着也就实现了点击提交按钮，自动格式化及提交代码的功能。

将 .clang-format 文件加入到 .ignore_file 脚本优化

在工程目录下执行 setup-repo.sh 命令后，我们会发现工程目录下的 .gitignore 文件发生了改变: ".clang-format" 被拼接到了 .gitignore 文件内文本的末尾。当原 .gitignore 文件内文本末尾没有空白行时，就会导致".clang-format" 与最后一个文本拼接在一起，从而使 .gitignore 规则发生变化。
为了避免这一潜在的影响，需要在.gitignore 文件插入一个换行符之后再拼接".clang-format"。
通过修改 setup-repo.sh 脚本的 ensure_git_ignores_clang_format_file() 方法, 使用echo -e "\n.clang-format" >> "$gitignore_file" 即可实现插入换行符。完整方法如下：

function ensure_git_ignores_clang_format_file() {
  gitignore_file='.gitignore';

  grep -q ".clang-format" "$gitignore_file"
  if [ $? -gt 0 ]; then
    echo -e "\n.clang-format" >> "$gitignore_file"
  fi
}

Enable or Disable 格式化代码

(最新代码已去掉这个功能，有此需求的，仍然可以按照下面的方法实现)
上面?提到了，配置DisableFormat: true在我的Mac上并没能禁止代码格式化功能。通过修改spacecommander目录下的format-objc-hook和setup-repo.sh 脚本：

1. format-objc-hook
   在代码块A的上面写入代码块C(这部分代码的作用是判断目标工程根目录下.git/hooks/pre-commit调用脚本 format-objc-hook传的第一个参数是否为“-false”,若为"-false"，直接退出命令，不再往下执行。否则，就继续往下执行格式化代码操作)

if [ "$1" == "-false" ]; then
    exit 0
fi

2. setup-repo.sh
   这个脚本执行的方法如下：

ensure_pre_commit_file_exists && 
ensure_pre_commit_file_is_executable && 
ensure_hook_is_installed && 
ensure_git_ignores_clang_format_file && 
symlink_clang_format

概括来讲就是在目标工程根目录下生成可执行脚本.git/hooks/pre-commit以及符号链接文件.clang-format 。我修改了setup-repo.sh的方法ensure_hook_is_installed()，生成的pre-commit脚本如下：

#!/usr/bin/env bash
current_repo_path=$(git rev-parse --show-toplevel)
repo_to_format="/Users/young/Documents/iOS/RefreshChilrenComponents"

  #enable auto-format
if [ "$current_repo_path" == "$repo_to_format" ] && 
[ -e "/Users/young/Documents/iOS/spacecommander-whoyoung"/format-objc-hook ]; 
then "/Users/young/Documents/iOS/spacecommander-whoyoung"/format-objc-hook || 
exit 1; fi

  #disable auto-format
# if [ "$current_repo_path" == "$repo_to_format" ] && 
[ -e "/Users/young/Documents/iOS/spacecommander-whoyoung"/format-objc-hook ]; 
then "/Users/young/Documents/iOS/spacecommander-whoyoung"/format-objc-hook -false || 
exit 1; fi

从脚本中可以看出Enable和Disable的差异是执行format-objc-hook脚本是否传“-false”。
通过注释#enable auto-format下面的代码或者#disable auto-format下面的代码便可禁止或者开启格式化代码功能