SketchTool

目次

入門

プラグインベース

最初のプラグイン

開発環境

デバッグ

Action API

公開プラグイン

プレミアム

プラグインバンドル

プラグイン、スクリプトおよびコマンド

カード位置

CocoaScript

について

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は無料で利用できますが、絶対に保証はありません.つまり、エラーや機能要求が見つかった場合は、Eメールを送信してください.できるだけ改善します.
使用するすべてのフォントがシステムにインストールされている場合、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形式で1 xでエクスポートされ、コマンドラインオプションを使用してカスタム形式またはサイズを指定できます.

$ 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

これはあなたに1 xと2 xバージョンの画板をあげます.
デフォルトでは、ファイルは現在のドキュメントにエクスポートされますが、出力パスはこのように定義できます.

$ 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

(sketchtool metadataまたはsketchtool list artboardsを使用して、ワークボードのIDを取得します).
パネルをエクスポートするときに実行できるその他の操作の詳細については、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/