iOS项目自动代码风格规范化--团队协做的福音

本文迁移自本人简书帐号酱油葱, 后续不会再在简书更新文章, 具体缘由能够查看简书CEO盛赞程序员出轨率高“真实、新鲜、多元” ，对不起打扰了

代码风格

这是个永恒的话题, 每一个程序员都有本身的见解和习惯. 可是行业里总会有些公认的规则, 公司里也须要一个统一的标准. 因此这个话题直接略过, 重点谈如何用工具保证一个团队输出内容风格的一致性.

自动Format

简书上已有很多相关的内容, 例如叶孤城的这篇文章. 目前, 本人使用的也是Square公司开源的"Clang-Format"进行代码规范. 一直以来用的都挺好.

可是自从Swift出世后, 问题就来了. Square公司的spacecommander项目不支持Swift文件的处理. 并且Square公司暂时也没有开源关于Swift的Format工具. 因此只能另寻它法.

还好, 这边有一个牛人开发了相应的Swift格式化工具SwiftFormat. 并且一样流畅的命令行操做, 可让咱们的工做变得轻松.

详细用法

安装

支持Homebrew安装

brew update brew install swiftformat

也支持项目编译安装. 这个比较麻烦, 大伙须要的话就直接去github上看README文档吧

使用

因为工具开发者本人实现了XCode 8的Extension, 因此但愿使用菜单项或者Hot Key的朋友能够尝试一下. 文档已经描述的很详细了.

本人用的是直接Hooks到仓库git上, 步骤以下:

1. 进入本地项目目录, 建立或打开.git/hooks/pre-commit文件

cd *** //***为项目路径 vi .git/hooks/pre-commit

2. 若是项目文件以前已存在, 则在下方添加如下内容(与文档说明略有出入, 考虑到CocoaPods/Carthage问题)

git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do
  swiftformat ${line};
  git add $line;
done
复制代码

若是有童鞋没有将.gitignore文件对Pods或Carthage目录进行过滤*(虽然通常人都不会这么作ORZ)*, 那么能够考虑换成如下内容

git status --porcelain | grep -v 'Pods/' | grep -v 'Carthage/' | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do
  swiftformat ${line};
  git add $line;
done
复制代码

3. 若是项目文件以前不存在, 则添加如下内容

#!/bin/bash
git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do
  swiftformat ${line};
  git add $line;
done
复制代码

4. 保存退出, 修改该文件的执行权限. 今后万事大吉

chmod +x .git/hooks/pre-commit

示例

进一步的问题

ObjectiveC老项目, 添加新的Swift语言进行混编时, 如何进行代码自动规范化?

很简单, 首先先使用Square公司的spacecommander项目工具脚本setup-repo.sh对项目进行初始化. 这个脚本会自动帮你在项目的.git/hooks目录下建立pre-commit文件并填入脚本内容.

而后, 在第二行插入如下内容(就是上面说起的SwiftFormat脚本):

git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do
  swiftformat ${line};
  git add $line;
done
复制代码

考虑到咱们团队可能须要保留未使用的参数, 因此能够修改成以上内容为:

git status --porcelain | grep -e '^[AM]\(.*\).swift$' | cut -c 3- | while read line; do
  swiftformat --disable unusedArguments ${line};
  git add $line;
done
复制代码

保存退出. 今后你就能满地图的乱写OC/Swift代码了. 妈妈不再用担忧个人格式问题了!

代码格式化规范如何调整

目前还真没有比较好的办法. 正如spacecommander项目说起的: You may wish to fork [ Space Commander] to apply your team's particular set of formatting rules (more details below), or clone to enjoy Square's flavor of Objective-C formatting.

若是大家团队但愿使用本身的规范, 基本只能考虑fork项目, 而后在本地进行修改生成新的pods, 再作导出.

而SwiftFormat项目则提供了命令行参数的方式进行部分风格设置项:

目前SwiftFormat的版本为0.24.6, 但愿能在将来的版本中看到更多的改进内容.

末

以上内容, 若有问题或错误, 能够随时与本人联系. 感谢阅读!