[Sublime Text 3]プラグインを作る時のTips

   2018/05/31

プラグインを作り始める時のチュートリアル的なブログはいくつもあるんだけど、使えるメソッドの説明だったり、特に.sublime-keymap/mousemapファイルに使える値についての解説が少ない。

インストールされたプラグインの中身と実際の動作を照らし合わせてある程度機能を推測することはできるんだけど、手間がかかる。

この記事では、機能が判明するまでに時間がかかったコマンドとか、手探りで色々試してわかったことを書いていく。

press_commandとcommandの違い

マウスのクリック時に何かコマンドを実行するためには、.sublime-mousemapファイルを編集する必要がある。

この時、”press_command”と”command”があるが、これらの違いは、マウスのボタンを押した時に動作させるか離した時に動作させるかの違いである。

commandの引数

keymapとかmousemapで”args”や”press_args”に引数をいろいろ渡しているけど、どうやって指定するのか?

答えは簡単で、呼び出す関数の方で任意の引数を定義しておけば、その名前の引数を渡せる。

例えば、呼び出すメソッドの方で以下のように引数を設定しておくと、

keymap/mousemapの方では以下のように引数を渡せる。

操作に応じてどのコマンドが動作したかを確認したい

自分の作った関数などがきちんと呼び出されているか知りたいというときに便利。
いちいちprint文とかを入れておく必要がない。

コンソールを開いて([View] > [Show Console])、以下のように打つ。

キーストロークも見たい場合は、以下のように打つ。

非表示にしたかったら、引数をFalseにして同じようなコマンドを打てば良い。

contextのkeyを自作する

preceding_textとかなんとか色々あるけど、どうも使いづらいと思った時は、keyを自作することもできる。
詳しくは以下のQiitaを参照のこと。

 

この記事へのコメントはこちら

メールアドレスは公開されませんのでご安心ください。
また、* が付いている欄は必須項目となりますので、必ずご記入をお願いします。

内容に問題なければ、下記の「コメント送信」ボタンを押してください。

sixteen + 16 =

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください