SketchTool

目录

  1. 入门

    1. 插件基础
    2. 您的第一个插件
    3. 开发环境
    4. 调试
    5. Action API
    6. 发布插件
  2. 高级

    1. 插件捆绑
    2. 插件,脚本和命令
    3. 插件位置
    4. 更多关于CocoaScript
    5. SketchTool

SketchTool是一个与Sketch捆绑在一起的命令行实用程序,它允许您使用Sketch文档执行一些操作,例如检查它们或导出资产。它还允许您从命令行控制Sketch以执行一些操作。

安装

SketchTool 与Sketch(和Sketch Beta)捆绑在一起。你可以找到它。

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

建议您在Sketch中使用它,而不是将其复制到其他位置,以便始终使用最新版本(更新Sketch时更新SketchTool,并且您需要使用更新后的版本进行阅读使用最新版本的Sketch保存的文件)。

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

重要

SketchTool可以免费使用,但它绝对没有保修。这就是说,如果您发现任何错误或有任何功能请求,请发送电子邮件给我们,我们将尽我们所能改善它。

如果所使用的所有字体已安装在系统上,SketchTool只能导出文档。

请注意,Sketch的未来版本将更改文件格式,因此请确保始终运行最新版本的工具。

用法

要了解可用的命令,请运行

$ sketchtool help

看到帮助。

以下是您可以使用SketchTool执行的一些示例

转储文件

$ 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

将导出文档中的所有画板,无论其可导出状态如何。如果画板已设置为可导出,则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)。

有关导出画板时可以执行的其他操作的更多信息,请参阅sketchtool help export artboard

导出图层,切片或页面

图层,切片和页面就像画板一样工作,所以您可以阅读前一节用'图层','切片'或'页面'替换'画板'

获取文档预览

sketchtool export preview path/to/document.sketch
将为您提供文档中最后编辑页面的PNG预览,并将其另存为preview.png。SketchTool将尝试渲染100%的预览,但如果文档太大,则会缩小预览,使其适合2048 x 2048像素的矩形。

运行一个插件

SketchTool可以告诉Sketch启动并运行一个插件。如果您正在持续集成系统上测试插件,或者您需要自动执行无聊任务,这非常有用。

想象一下,我们有这个代码的插件:

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现在将启动Sketch,等待文档打开,然后运行我们的插件。Sketch将成为最前端的应用程序,但如果您希望它保留在后台(例如,您正在运行代码编辑器的测试,并且不希望Sketch捕获焦点),则可以使用该--without-activating选项。

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

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