基于SwiftSyntax写一个命令行工具检测Xcode项目中不用的图片资源

其实已经有一个不错的用Swift写的命令行工具检测不用的图片资源了,就是喵神的FengNiao,至于为什么要再写一个呢,主要是为了学习SwiftSyntax,前段时间我写了篇文章简单的介绍了SwiftSyntax,文章在这里SwiftSyntax详解,对SwiftSyntax不熟悉的可以先看看。

项目在这里UnusedResources,下面来简单介绍一下原理。

1. 找到项目中所有的图片资源

我这里找的图片资源有以下几种:

let imageExtensions: [String] = ["png", "jpg", "gif", "pdf"]

这里不得不提以下Homebrew的作者mxcl开源的库Path,这个库真的很好用。我们先定义一个方法来来查找所需扩展名的文件

func recursiveFiles(withExtensions exts: [String], at path: Path) throws -> [Path] {
    if path.isFile {
        if exts.contains(path.extension) {
            return [path]
        }
        return []
    } else if path.isDirectory {
        var files: [Path] = []
        for entry in try path.ls() {
            let list = try recursiveFiles(withExtensions: exts, at: entry.path)
            files.append(contentsOf: list)
        }
        return files
    }
    return []
}

找到所有的图片资源就只要下面简单的一段代码就可以了

var images: [Path] = try recursiveFiles(withExtensions: imageExtensions, at: path)

2. 查看项目中源代码文件

找到源代码文件

var files: [Path] = try recursiveFiles(withExtensions: ["swift", "h", "m", "mm"], at: path)

这里就需要用到SwiftSyntax,我们定义一个StringVisitor遍历语法树,提取字符串并判断是否和图片名称一样,一样就说明图片被使用了。

我们一个简单的swift代码的语法树,可以用xcrun swiftc -frontend -emit-syntax ./Cat.swift | python -m json.tool命令查看源代码语法树结构,但是还是比较复杂,包含import库的部分,所以我选择用Swift AST Explorer,这个是基于SwiftSyntax实现,语法树更简洁。

屏幕快照 2019-11-06 下午6.44.40.png

我们只要拿到StringSegmentSyntax的内容就好了,然后和图片进行对比,和图片一样,就表示图片被使用到了。

public struct StringVisitor: SyntaxVisitor {
    
    public var images: [Path] = []
        
    public init(_ images: [Path]) {
        self.images = images
    }
    
    // Ignore string interpolated literal because it's too complex to compare
    public mutating func visit(_ node: StringLiteralExprSyntax) -> SyntaxVisitorContinueKind {
        guard node.segments.count == 1 else {
            return .skipChildren
        }
        return .visitChildren
    }
    
    public mutating func visit(_ node: StringSegmentSyntax) -> SyntaxVisitorContinueKind {
        let text = node.content.text
            .trimmingCharacters(in: .whitespacesAndNewlines)
        guard !text.isEmpty else {
            return .skipChildren
        }

        images = images.filter { $0.basename(dropExtension: true) != text }

        return .skipChildren
    }
 }

OC和Swift的语法书稍微有点不一样,所以我们可以得到所有的TokenSyntax,然后找到类型是stringLiteral的,这里我处理比较简单,直接判断stringLiteral是否包含图片名称,如果包含就表示图片被使用了。

屏幕快照 2019-11-06 下午6.39.09.png

所以我们再给StringVisitor添加一个方法

// for Objective-C
    public mutating func visit(_ token: TokenSyntax) -> SyntaxVisitorContinueKind {
        switch token.tokenKind {
        case .stringLiteral(let text):
            images = images.filter { !text.contains($0.basename(dropExtension: true)) }
        default:
            break
        }
        
        return .visitChildren
    }

3. 查看XML文件

let xmlExtensions: [String] = ["xib", "storyboard"]
var xmlFiles: [Path] = try recursiveFiles(withExtensions: xmlExtensions, at: path)

这里需要用到XMLParser找到attributeDict中key为“image”的value,如果和图片名称一样就表示图片被使用了。

4. Makefile

使用Makefile来build项目,自动将生成的unused-resources拷贝到/usr/local/bin中。

5. 总结

水文一篇,最近在研究编译相关的知识,进展十分缓慢,心累。

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