atomパッケージ開発メモ(php向けキーワードヘルプ)

サクラエディタにあるキーワードヘルプ機能。


※上記ソースは公式から適当にコピペしたもの

定義ファイルさえあれば地味に便利なのでatomにもほしい。探すと似た機能を持つパッケージが過去にあったようだが、リポジトリはもぬけの殻となっていてインストールできない。なんやそれえええええええええええ!それならば作ろうということでやってみた。

まずは有志の方がサクラエディタ用に作成した定義ファイルをjsonに変換しておく。こんな感じ。

パッケージの雛形はatomが自動生成してくれる。自分の場合はjavascript形式だった。昔はcoffeescript形式だったらしいが、なんやその言語。とは言えjavascriptも不慣れなので作業はおぼつかない。

自動生成してくれたソースに追記していく。5行目でjsonをパッケージに読み込ませている。

display()という名のメソッドを追加して、編集中のファイルの選択テキストを取得。そしてjsonから一致する関数の説明を取得。取得できたら表示する。これで完成。

実際に試した図。ショートカットキーを押すと選択した関数の説明が出力される。

改良すべき点がいくつか。

  • ショートカットキーを契機とするのではなく、選択した瞬間にしたい
  • notifications.addInfo()は数秒で自動的に消えるので、選択をやめるまで表示させたい
  • notifications.addInfo()は出力位置が右上にしか出せないので、視認しやすい位置に変更したい
  • “word +”いらなかった

世界中の開発者が作ったどのパッケージもソースが見れるせいなのか、atomパッケージ作成に関する情報が想像してたより少ない。じゃあ「ソースを見よ」ということで見てみると大抵coffeescriptで書かれているので、出だしに苦労した。どのプラグイン開発も最初は本当によくわからないが仕方ない。

次回

コメントをどうぞ

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

数式を埋めてください *