SketchTool

目錄

  1. 入門

    1. 插件基礎
    2. 您的第一個插件
    3. 開發(fā)環(huán)境
    4. 調試
    5. Action API
    6. 發(fā)布插件
  2. 高級

    1. 插件捆綁
    2. 插件叹坦,腳本和命令
    3. 插件位置
    4. 更多關于CocoaScript
    5. SketchTool

SketchTool是一個與Sketch捆綁在一起的命令行實用程序嗤详,它允許您使用Sketch文檔執(zhí)行一些操作继准,例如檢查它們或導出資產。它還允許您從命令行控制Sketch以執(zhí)行一些操作沟启。

安裝

SketchTool 與Sketch(和Sketch Beta)捆綁在一起配深。你可以找到它。

Sketch.app/Contents/Resources/sketchtool/bin/sketchtool

建議您在Sketch中使用它巩梢,而不是將其復制到其他位置,以便始終使用最新版本(更新Sketch時更新SketchTool艺玲,并且您需要使用更新后的版本進行閱讀使用最新版本的Sketch保存的文件)括蝠。

注意:SketchTool需要OSX 10.11或更高版本。

重要

SketchTool可以免費使用饭聚,但它絕對沒有保修忌警。這就是說,如果您發(fā)現(xiàn)任何錯誤或有任何功能請求秒梳,請發(fā)送電子郵件給我們法绵,我們將盡我們所能改善它。

如果所使用的所有字體已安裝在系統(tǒng)上酪碘,SketchTool只能導出文檔朋譬。

請注意,Sketch的未來版本將更改文件格式兴垦,因此請確保始終運行最新版本的工具徙赢。

用法

要了解可用的命令,請運行

$ sketchtool help

看到幫助探越。

以下是您可以使用SketchTool執(zhí)行的一些示例

轉儲文件

$ sketchtool dump path/to/document.sketch

以JSON格式獲取文檔結構的轉儲犀忱。

如果您需要查看文檔的元數據,但不想完整轉儲扶关,則可以使用

$ sketchtool metadata path/to/document.sketch

你會得到類似的東西:

{
  "commit" : "b8111e3393c4ca1f2399ecfdfc1e9488029ebe7b",
  "pagesAndArtboards" : {
    "E6890372-BE93-4E4C-ACD1-8F8B10862938" : {
      "name" : "Page 1",
      "artboards" : {
        "214B376A-C4A3-47A9-9B87-DFBC49A6EFE0" : {
          "name" : "Artboard 2"
        },
        "F8FE177A-5D6D-4A37-8BD1-B246A83A9C21" : {
          "name" : "Artboard 1"
        }
      }
    }
  },
  "version" : 97,
  "fonts" : [

  ],
  "compatibilityVersion" : 93,
  "app" : "com.bohemiancoding.sketch3",
  "autosaved" : 0,
  "variant" : "NONAPPSTORE",
  "created" : {
    "commit" : "b8111e3393c4ca1f2399ecfdfc1e9488029ebe7b",
    "appVersion" : "48.2",
    "build" : 47327,
    "app" : "com.bohemiancoding.sketch3",
    "compatibilityVersion" : 93,
    "version" : 97,
    "variant" : "NONAPPSTORE"
  },
  "saveHistory" : [
    "NONAPPSTORE.47327"
  ],
  "appVersion" : "48.2",
  "build" : 47327
}

導出資產

您可以使用SketchTool導出Sketch文檔中的資源阴汇。SketchTool可以導出預定義的資源(即:在Sketch UI中可導出的圖層和畫板)或任何你想要的圖層。

導出畫板

運行

$ sketchtool export artboards path/to/document.sketch

將導出文檔中的所有畫板节槐,無論其可導出狀態(tài)如何搀庶。如果畫板已設置為可導出,則SketchTool將導出所有尺寸和格式铜异。否則哥倔,默認情況下,它們將以PNG格式以1x導出揍庄,您可以使用命令行選項指定自定義格式或大信剌铩:

$ sketchtool export artboards path/to/document.sketch --formats=jpg

您可以一次導出多個格式:

sketchtool導出畫板路徑/ to / document.sketch -formats = jpg,png,svg```

要查看SketchTool支持哪些格式沃测,請運行sketchtool list formats缭黔。

要定義大小,你可以這樣做:

$ sketchtool export artboards path/to/document.sketch --scales=1,2

這會給你1x和2x版本的畫板蒂破。

默認情況下馏谨,文件被導出到當前文檔,但您可以像這樣定義輸出路徑:

$ sketchtool export artboards path/to/document.sketch --output=output/path

如果不想導出所有畫板附迷,可以通過使用圖層ID 的item或items選項來告訴SketchTool要導出的畫板:

$ sketchtool export artboards path/to/document.sketch --item=214B376A-C4A3-47A9-9B87-DFBC49A6EFE0

(獲取美工板的ID惧互,使用sketchtool metadatasketchtool list artboards)。

有關導出畫板時可以執(zhí)行的其他操作的更多信息喇伯,請參閱sketchtool help export artboard喊儡。

導出圖層,切片或頁面

圖層稻据,切片和頁面就像畫板一樣工作艾猜,所以您可以閱讀前一節(jié)用'圖層','切片'或'頁面'替換'畫板'

獲取文檔預覽

sketchtool export preview path/to/document.sketch
將為您提供文檔中最后編輯頁面的PNG預覽攀甚,并將其另存為preview.png。SketchTool將嘗試渲染100%的預覽岗喉,但如果文檔太大秋度,則會縮小預覽,使其適合2048 x 2048像素的矩形钱床。

運行一個插件

SketchTool可以告訴Sketch啟動并運行一個插件荚斯。如果您正在持續(xù)集成系統(tǒng)上測試插件,或者您需要自動執(zhí)行無聊任務查牌,這非常有用事期。

想象一下,我們有這個代碼的插件:

context.document.showMessage("Remote plugin running!")

我們從Run Script ...面板中將它保存為'Remote Plugin' 纸颜,然后運行:

$ sketchtool run ~/Library/Application\ Support/com.bohemiancoding.sketch3/Plugins/Remote\ Plugin.sketchplugin com.bohemiancoding.sketch.runscriptidentifier

請注意兽泣,這com.bohemiancoding.sketch.runscriptidentifier是Sketch在保存插件時使用的默認命令標識符,但在您的情況下它可能會有所不同胁孙。如果您只想運行包中的第一個命令唠倦,則可以使用""而不是標識符。

SketchTool現(xiàn)在將啟動Sketch涮较,等待文檔打開稠鼻,然后運行我們的插件。Sketch將成為最前端的應用程序狂票,但如果您希望它保留在后臺(例如候齿,您正在運行代碼編輯器的測試,并且不希望Sketch捕獲焦點),則可以使用該--without-activating選項慌盯。

原文:https://developer.sketchapp.com/guides/sketchtool/

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末周霉,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子润匙,更是在濱河造成了極大的恐慌诗眨,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,723評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件孕讳,死亡現(xiàn)場離奇詭異匠楚,居然都是意外死亡,警方通過查閱死者的電腦和手機厂财,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,485評論 2 382
  • 文/潘曉璐 我一進店門芋簿,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人璃饱,你說我怎么就攤上這事与斤。” “怎么了荚恶?”我有些...
    開封第一講書人閱讀 152,998評論 0 344
  • 文/不壞的土叔 我叫張陵撩穿,是天一觀的道長。 經常有香客問我谒撼,道長食寡,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,323評論 1 279
  • 正文 為了忘掉前任廓潜,我火速辦了婚禮抵皱,結果婚禮上,老公的妹妹穿的比我還像新娘辩蛋。我一直安慰自己呻畸,他們只是感情好,可當我...
    茶點故事閱讀 64,355評論 5 374
  • 文/花漫 我一把揭開白布悼院。 她就那樣靜靜地躺著伤为,像睡著了一般。 火紅的嫁衣襯著肌膚如雪据途。 梳的紋絲不亂的頭發(fā)上钮呀,一...
    開封第一講書人閱讀 49,079評論 1 285
  • 那天,我揣著相機與錄音昨凡,去河邊找鬼爽醋。 笑死,一個胖子當著我的面吹牛便脊,可吹牛的內容都是我干的蚂四。 我是一名探鬼主播,決...
    沈念sama閱讀 38,389評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼遂赠!你這毒婦竟也來了久妆?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 37,019評論 0 259
  • 序言:老撾萬榮一對情侶失蹤跷睦,失蹤者是張志新(化名)和其女友劉穎筷弦,沒想到半個月后,有當地人在樹林里發(fā)現(xiàn)了一具尸體抑诸,經...
    沈念sama閱讀 43,519評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡烂琴,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,971評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了蜕乡。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片奸绷。...
    茶點故事閱讀 38,100評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖层玲,靈堂內的尸體忽然破棺而出号醉,到底是詐尸還是另有隱情,我是刑警寧澤辛块,帶...
    沈念sama閱讀 33,738評論 4 324
  • 正文 年R本政府宣布畔派,位于F島的核電站,受9級特大地震影響润绵,放射性物質發(fā)生泄漏线椰。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,293評論 3 307
  • 文/蒙蒙 一授药、第九天 我趴在偏房一處隱蔽的房頂上張望士嚎。 院中可真熱鬧呜魄,春花似錦悔叽、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,289評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至睹晒,卻和暖如春趟庄,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背伪很。 一陣腳步聲響...
    開封第一講書人閱讀 31,517評論 1 262
  • 我被黑心中介騙來泰國打工戚啥, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人锉试。 一個月前我還...
    沈念sama閱讀 45,547評論 2 354
  • 正文 我出身青樓猫十,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子拖云,可洞房花燭夜當晚...
    茶點故事閱讀 42,834評論 2 345