Xcode 自動生成代碼插件開發(fā)

Xcode8 開放了新的一個Extension:Xcode Source Editor Extension,可以讓我們自己開發(fā)Xcode 插件陷寝,但是目前開發(fā)的API 還比較少潜圃,但是也不妨礙我們了解和使用蜡豹。本文主要介紹如何使用Xcode Source Editor Extension 實現(xiàn)一個簡單的自動生成代碼的插件捂齐。

地址GitHub

效果

Untitled.gif

實現(xiàn)

新建一個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

系統(tǒng)默認為我們生成SourceEditorCommand 文件,其中這個方法就當做主入口啡彬,當調用插件時會執(zhí)行這個方法羹与。但是只能獲取到當前編輯文件的內容,不能獲取整個工程庶灿。

    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,根據(jù)提前錄入的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

在主工程中峻呕,創(chuàng)建錄入界面利职,整體是個NSTableView,展示保存好的Map瘦癌,雙擊某一行或者點擊添加按鈕猪贪,進入編輯頁面,主要用NSTextField 實現(xiàn)

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

全局保存的Map 存儲在UserDefaults 里讯私,但是宿主和擴展共享數(shù)據(jù)的話热押,需要suiteName 相同才行,需要在App Group 里設置相同的key斤寇。

測試

  1. 先運行主App桶癣,測試添加數(shù)據(jù)是否正常

  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 不能用,因為媳婦開發(fā)用的純Swift责蝠,所以主要寫給她用的党巾,目前插件的功能還很簡單萎庭,但是基本可以使用了,后續(xù)可以繼續(xù)優(yōu)化齿拂!

參考

WWDC2016
Xcode Source Editor Extension

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末驳规,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子署海,更是在濱河造成了極大的恐慌吗购,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件砸狞,死亡現(xiàn)場離奇詭異捻勉,居然都是意外死亡,警方通過查閱死者的電腦和手機刀森,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進店門踱启,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人撒强,你說我怎么就攤上這事禽捆。” “怎么了飘哨?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵胚想,是天一觀的道長。 經(jīng)常有香客問我芽隆,道長浊服,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任胚吁,我火速辦了婚禮牙躺,結果婚禮上,老公的妹妹穿的比我還像新娘腕扶。我一直安慰自己孽拷,他們只是感情好,可當我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布半抱。 她就那樣靜靜地躺著脓恕,像睡著了一般。 火紅的嫁衣襯著肌膚如雪窿侈。 梳的紋絲不亂的頭發(fā)上炼幔,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天,我揣著相機與錄音史简,去河邊找鬼乃秀。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的跺讯。 我是一名探鬼主播枢贿,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼刀脏!你這毒婦竟也來了萨咕?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤火本,失蹤者是張志新(化名)和其女友劉穎危队,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體钙畔,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡茫陆,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了擎析。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片簿盅。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖揍魂,靈堂內的尸體忽然破棺而出桨醋,到底是詐尸還是另有隱情,我是刑警寧澤现斋,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布喜最,位于F島的核電站,受9級特大地震影響庄蹋,放射性物質發(fā)生泄漏瞬内。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一限书、第九天 我趴在偏房一處隱蔽的房頂上張望虫蝶。 院中可真熱鬧,春花似錦倦西、人聲如沸能真。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽粉铐。三九已至,卻和暖如春耻矮,著一層夾襖步出監(jiān)牢的瞬間秦躯,已是汗流浹背忆谓。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工裆装, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓哨免,卻偏偏與公主長得像茎活,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子琢唾,可洞房花燭夜當晚...
    茶點故事閱讀 44,979評論 2 355

推薦閱讀更多精彩內容