Xcode 自动生成代码插件开发

Xcode8 开放了新的一个Extension:Xcode Source Editor Extension,可以让我们自己开发Xcode 插件,但是目前开发的API 还比较少,但是也不妨碍我们了解和使用。本文主要介绍如何使用Xcode Source Editor Extension 实现一个简单的自动生成代码的插件。

地址GitHub

效果

Untitled.gif

实现

新建一个MacOS 宿主项目,再新建一个Target,类型为Xcode Source Editor Extension,并且设置target的签名和宿主App的签名一致。

屏幕快照 2018-01-24 下午7.53.25.png
屏幕快照 2018-01-24 下午7.53.50.png

目录结构

屏幕快照 2018-01-24 下午7.54.37.png

系统默认为我们生成SourceEditorCommand 文件,其中这个方法就当做主入口,当调用插件时会执行这个方法。但是只能获取到当前编辑文件的内容,不能获取整个工程。

    func perform(with invocation: XCSourceEditorCommandInvocation, completionHandler: @escaping (Error?) -> Void ) -> Void {
        // Implement your command here, invoking the completion handler when done. Pass it nil on success, and an NSError on failure.
        
        if invocation.commandIdentifier == InsetCodeKey {
            handleInsertCode(invocation: invocation)
        }else{
            NSWorkspace.shared.open(URL.init(fileURLWithPath: "/Applications/GenerateCode.app"))
        }
        completionHandler(nil)
    }

核心代码如下,大致逻辑是获取当前输入的key,根据提前录入的Map,查找对应Value,并且替换当前行内容。

func handleInsertCode(invocation: XCSourceEditorCommandInvocation){
        let selection = invocation.buffer.selections.firstObject as! XCSourceTextRange
        let totalLines = invocation.buffer.lines
        let curIndex = selection.start.line
        var curLineContent = totalLines[curIndex] as! String
        
        let mapKey = curLineContent.trimmingCharacters(in: .whitespacesAndNewlines)
        
        let map = SharedUserDefault.shared.mapping
        if let value = map[mapKey] {
            let arr = convertToLines(string: value)
            var numberOfSpaceIndent = curLineContent.range(of: mapKey)!.lowerBound.encodedOffset
            var indentStr = ""
            
            while numberOfSpaceIndent > 0 {
                indentStr = indentStr.appending(" ")
                numberOfSpaceIndent -= 1
            }
            if arr.isEmpty{
                return
            }
            if let range = curLineContent.range(of: mapKey){
                curLineContent.replaceSubrange(range, with: arr[0])
                totalLines[curIndex] = curLineContent
            }
            for i in 1..<arr.count{
                let insetStr = indentStr + arr[i]
                totalLines.insert(insetStr, at: curIndex + i)
            }
        }
    }

录入界面

屏幕快照 2018-01-24 下午7.59.38.png

在主工程中,创建录入界面,整体是个NSTableView,展示保存好的Map,双击某一行或者点击添加按钮,进入编辑页面,主要用NSTextField 实现

屏幕快照 2018-01-24 下午8.02.28.png

全局保存的Map 存储在UserDefaults 里,但是宿主和扩展共享数据的话,需要suiteName 相同才行,需要在App Group 里设置相同的key。

测试

  1. 先运行主App,测试添加数据是否正常

  2. 运行插件,选择Xcode,会出来一个灰色的Xcode,随便打开一个项目

屏幕快照 2018-01-24 下午8.07.17.png

输入key,运行插件,正确生成代码。

屏幕快照 2018-01-24 下午8.07.58.png

也可以绑定快键键

屏幕快照 2018-01-24 下午8.10.08.png

使用

屏幕快照 2018-01-24 下午8.10.56.png

将app 拷入应用程序里,并且将设置里Xcode 扩展选上,重启Xcode,就能在Editor 里使用啦

屏幕快照 2018-01-24 下午8.12.07.png

总结

插件主要参考了EasyCode,站在了巨人的肩膀上。但是目前EasyCode 好像Swift 不能用,因为媳妇开发用的纯Swift,所以主要写给她用的,目前插件的功能还很简单,但是基本可以使用了,后续可以继续优化!

参考

WWDC2016
Xcode Source Editor Extension

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

推荐阅读更多精彩内容