SwiftFormat简介

SwiftFormat可以帮助开发者自动的纠正一些代码规范问题,并且可以一定程度的帮助我们优化代码、统一代码风格。比如,帮助我们调整空格、缩紧,移除隐式的self调用等等。更加详细的规则可以参考这里

一、可以通过以下几种方式进行安装

1.1、命令行工具
可以通过HomeBrew来安装

brew install swiftformat

也可以通过Mint来安装运行

mint install nicklockwood/SwiftFormat
mint run swiftformat

当然,也可以通过clone代码,然后手动编译

git clone https://github.com/nicklockwood/SwiftFormat
cd SwiftFormat
swift build -c release

通过上述方法安装完成后,进入项目文件夹根目录,执行命令行:

swiftformat .

那么会重新编排该目录下的所有文件。当然,更为稳妥的方式是进入需要编排的文件目录并执行命令。

1.2、扩展Xcode的source editor
通过HomeBrew执行命令:

brew install --cask swiftformat-for-xcode

通过这种方式可以讲swiftformat扩展为Xcode的一项功能,可以在Xcode Editor menu中找到并运行。

1.3、通过为Xcode添加运行脚本
通过homebrew安装了swiftformat后,在Xcode的 Run Script build phase添加以下脚本

if which swiftformat >/dev/null; then
swiftformat .
else
echo "warning: SwiftFormat not installed, download from https://github.com/nicklockwood/SwiftFormat"
fi

或者也可通过Cocoapods进行安装并添加依赖脚本

“${PODS_ROOT}/SwiftFormat/CommandLineTool/swiftformat” "$SRCROOT"
二、规则添加

同样的,我们也可以对规则进行添加和修改,通过 --disable--enable 标识。
例如:

--disable redundantSelf,trailingClosures
--enable isEmpty

或者针对多条规则:

--disable indent
--disable linebreaks
--disable redundantSelf

可以这样表示:

--disable          \
    indent,        \
    linebreaks,    \
    redundantSelf

或者有时我们只需要支持某些rules时:

--rules indent,linebreaks

除此之外,如果在代码中需要某些规则不对某段代码生效的话,可以做如下注释:

// swiftformat:disable <rule1> [<rule2> [rule<3> ...]]
三、规则自定义配置文件

通过上面介绍的规则,我们可以实现自定义的需求,但是更为方便的办法是通过一个配置文件来统一管理我们的自定义规则。
通过创建一个隐式文件 .swiftformat ,可以在里面根据需求自定义规则。
注意:该文件的位置,一般建议放到项目文件夹的根目录。因为.swiftformat文件有相应的作用区间,如果未特别指明path时,则默认作用在当前父目录下的所有swift文件

# format options
--allman true
--indent tab # tabs FTW!

# file options
--exclude Pods

# rules
--disable elseOnSameLine,semicolons
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,172评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,346评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,788评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,299评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,409评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,467评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,476评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,262评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,699评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,994评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,167评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,827评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,499评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,149评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,387评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,028评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,055评论 2 352

推荐阅读更多精彩内容