コメント
Sketchでプラグインを作成およびカスタマイズする方法
編集済み 2 数か月前 によって ExtremeHow 編集チーム
スケッチプラグインカスタマイズ開発拡張機能ツールワークフロー拡張スクリプティングサードパーティ
翻訳が更新されました 2 数か月前
Sketchは、美しいユーザーインターフェイスデザインを作成するためにデザイナーに人気のあるデザインツールです。Sketchの主な強みの1つは、プラグインを通じた拡張性です。プラグインはタスクの自動化、新機能の追加、デザインワークフローに合わせてSketchの機能を調整するのに役立ちます。この詳細ガイドでは、Sketchでのプラグインの作成とカスタマイズのプロセスを紹介します。
基本を理解する
プラグインの作成に取りかかる前に、プラグインとは何か、そしてそれがなぜ有用であるかを理解することが重要です。Sketchのプラグインは基本的に、SketchのAPIと対話して特定のタスクを実行するスクリプトです。これには、色の変更といった単純なタスクから、完全なUIコンポーネントの作成といった複雑なタスクまで、さまざまなものがあります。
Sketch APIを使用すると、開発者はドキュメント、ページ、レイヤーなどと対話でき、強力なツールを構築することが可能になります。これらのツールはデザインプロセスをスムーズにする助けとなり、時間と労力を節約します。
環境をセットアップする
プラグインを作成し始める前に、開発環境を設定する必要があります。以下は、始めるための手順です：
- Sketchをインストールする: コンピュータに最新のバージョンのSketchがインストールされていることを確認します。Sketchは現在、macOSで利用可能です。
- テキストエディタをセットアップする: コードを書くには良いテキストエディタが不可欠です。Visual Studio Code、Sublime Text、Atomなどが人気のオプションです。最も快適に使えるものを選びましょう。
- JavaScriptを学ぶ: SketchのプラグインはJavaScriptで書かれているため、JavaScriptの基本的な理解が必要です。JavaScriptの構文、変数、関数、オブジェクトの基本を学ぶことをお勧めします。
簡単なSketchプラグインを作成する
では、簡単なSketchプラグインを作成する方法を見てみましょう。この例では、Sketchドキュメントに赤い四角形を追加するプラグインを作成する方法を示します。
ステップ1: プラグインフォルダを作成する
プラグインに意味のある名前を付けて新しいフォルダを作成します（例：「RedRectanglePlugin」）。このフォルダには、プラグインに必要なすべてのファイルが含まれます。
ステップ2: マニフェストファイルを作成する
manifest.jsonファイルはSketchにプラグインについて知らせます。プラグインの名前、バージョン、実行するスクリプトなどの情報が含まれています。
{
"name": "Red Rectangle Plugin",
"identifier": "com.example.redrectangleplugin",
"version": "1.0",
"description": "A simple Sketch plugin to add a red rectangle.",
"author": "Your Name",
"commands": [
{
"name": "Add Red Rectangle",
"identifier": "addRedRectangle",
"script": "./addRedRectangle.js"
}
]
}
manifest.jsonファイルをプラグインフォルダ内に置きます。
ステップ3: プラグインスクリプトを書く
プラグインフォルダ内にaddRedRectangle.jsという名前の新しいJavaScriptファイルを作成します。このスクリプトは、Sketchの既存のページに赤い四角形を追加します。以下は簡単な例です：
function onAddRedRectangle(context) {
var sketch = require('sketch/dom');
var document = sketch.getSelectedDocument();
var page = document.selectedPage;
// Create a new rectangle
var rectangle = new sketch.Rectangle({
parent: page,
frame: { x: 0, y: 0, width: 100, height: 100 },
style: { fills: [{ color: '#FF0000', fillType: 'Color' }] }
});
page.layers.push(rectangle);
}
module.exports = onAddRedRectangle;
このスクリプトをプラグインフォルダに保存します。
ステップ4: プラグインをインストールしてテストする
プラグインをインストールするには、以下の手順に従ってください：
- Sketchを開きます。
- 「プラグイン > プラグインを管理...」に移動します。
- 歯車のアイコンをクリックし、「プラグインフォルダを表示」を選択します。
- 表示されたプラグインフォルダにプラグインフォルダをコピーします。
- Sketchを再起動するか、「プラグイン > スクリプトを実行 > プラグインを再読み込み」に移動します。
- プラグインが「プラグイン」メニューに表示されるはずです！
テスト: Sketchで任意のドキュメントを開き、「プラグイン > Red Rectangle Plugin > Add Red Rectangle」に移動します。キャンバス上に赤い四角形が表示されるはずです。
プラグインをカスタマイズする
簡単なプラグインを作成したので、それをさらにカスタマイズする方法を見てみましょう。
ユーザー設定を追加する
場合によっては、ユーザーにプラグインの動作を構成する機能を提供したいことがあります。これには、Sketchの内蔵ツールを使用してUIを作成します。
function onAddRectangleWithSettings(context) {
var sketch = require('sketch/dom');
var UI = require('sketch/ui');
UI.getInputFromUser(
"Rectangle Size",
{ type: UI.INPUT_TYPE.string, initialValue: "100" },
(err, value) => {
if (err) { return; }
var document = sketch.getSelectedDocument();
var page = document.selectedPage;
var size = parseInt(value, 10);
var rectangle = new sketch.Rectangle({
parent: page,
frame: { x: 0, y: 0, width: size, height: size },
style: { fills: [{ color: '#FF0000', fillType: 'Color' }] }
});
page.layers.push(rectangle);
}
);
}
module.exports = onAddRectangleWithSettings;
この例では、プラグインを実行すると、ユーザーに四角形の希望のサイズを尋ねます。
サードパーティのライブラリを使用する
デフォルトのSketch APIでは目標を達成できない場合があります。サードパーティのJavaScriptライブラリを使用して機能を拡張することを検討してください。
以下はサードパーティライブラリを使用する方法です：
- ライブラリを選択し、そのJavaScriptファイルをダウンロードします。
- プラグインのフォルダにファイルを含めます。
require()を使用してスクリプトにインクルードし、使用します。
var _ = require('./lodash.min.js');
function main(context) {
var numbers = [1, 2, 3, 4, 5];
var doubled = _.map(numbers, function(n) {
return n * 2;
});
console.log(doubled);
}
module.exports = main;
この例では、Lodashライブラリを使用して数値配列を2倍にしています。
テストとデバッグ
他のソフトウェア開発と同様に、プラグイン開発においてもテストとデバッグは非常に重要です。以下はいくつかのヒントです：
- コンソールログ:
console.log()を使用して変数や出力をコンソールに表示します。Sketchでは「プラグイン > スクリプトを実行 > ツールを表示 > コンソールを表示」で確認できます。 - スクリプトを分割する: スクリプトをより小さく、管理しやすいタスクに分割します。これにより、問題のある箇所を特定しやすくなります。
- モックデータ: モックデータを使用して、Sketch環境から独立してプラグインの機能をテストします。
プラグインを公開する
プラグインに満足したら、コミュニティと共有することを検討してください。以下はプラグインを公開する方法です：
- ドキュメントを準備する: プラグインのインストール方法と使用方法を説明した
README.mdファイルを作成します。特定の設定に関するコードと説明を提供します。 - コードのライセンスを選択する: コードに適したライセンスを選択します。多くの開発者はMITライセンスまたはApacheライセンスを使用しています。
- プラグインをホストする: GitHubなどのプラットフォームを使用してプラグインのソースコードをホストします。これにより他の人がアクセスでき、貢献の機会を得られます。
- Sketchプラグインディレクトリに送信する: プラグインをSketchのプラグインディレクトリに送信して、より多くの人に見てもらえるようにします。ディレクトリのガイドラインに従っていることを確認してください。
結論
Sketchでプラグインを作成およびカスタマイズすることで、機能が大幅に拡張され、特定のニーズに合わせられます。このガイドに従うことで、環境のセットアップ、基本的なプラグインの作成、カスタマイズ、サードパーティライブラリの使用、さらには作成したものの公開方法を学びました。練習と創造性をもって、Sketchプラグインのエコシステムに著しい貢献ができ、デザインプロセスをより効率的で革新的なものにすることができます。コーディングを楽しんでください！
記事の内容に誤りがある場合, あなたは