Atomエディタでプロジェクト内の関数やクラスが検索出来るプラグイン「goto-definition」



Atomエディタで プロジェクト内のクラスや関数の定義元にジャンプできるプラグイン「goto-definition」の紹介です。

開発を行っていると、フレームワークやライブラリ固有の関数やクラス、その他にプロジェクト用に作った関数のソースコードを直接参照することはよくあります。

eclipseやNetBeans、JetBrain系のIDEにはダイレクトに定義元へジャンプする機能が搭載されていますが、Atomエディタにはデフォルトで搭載されていません。

そんな関数ジャンプをAtomエディタ上で実現出来るプラグインが「goto-definition」です。

* goto-definition


goto-definitionのインストール

goto-definitionの導入はSettingメニュー -> installから' goto-definition 'と入力して検索してインストールするか、コマンドライン上からapmコマンドを使ってインストールできます。

# コマンドライン上からインストールする場合
apm install goto-definition


* goto-definitionでサポートされてるプログラミング言語

- JavaScript ( ES6 && JSX ) , TypeScript, CoffeeScript
- Python, Ruby
- PHP, Hack ( HHVMで動く言語 ) , Perl, KRL


使い方

goto-definitionの使い方は簡単で、検索したい関数 or Class を選択して" 右クリック -> Goto Definiction "をクリック。検索結果をクリックすればソースの定義場所にジャンプします。
(キーボードから使う場合は " Alt + Cmd + Enter " 又は " Ctrl + Alt + Enter "で呼び出すことが出来ます)

自身の環境で Class名 "InformationRepository" を検索してみました

Class名 "InformationRepository"の検索結果 (*アノテーション内のコードもヒットしているようです)

注意点としては、goto-definitionはプロジェクト内の同じ拡張子の検索する文字列を検索しているので、クラスの呼び出し時にエイリアスを使ったり、Webフレームワーク等のテンプレートエンジン内で使われている関数の検索にはヒットしません。
( * 例: LaravelのBladeテンプレート内からの関数検索 )

* デフォルトでVCS(GitやSVN)内のコードは検索結果に含まれないようになっていますが" Setting -> Core -> Exclude VCS Ignored Paths "のチェックボックスを外せば有効化されます。


Summary

以上がgoto-definitionの紹介でした。

その他、Atomエディタ用の関数検索のプラグインに"atom-ctags"も挙げられますが、goto-definitionは他のプラグイン依存がないので、設定なしに使うことができます。

調べたいクラスや関数がどこで使われているか検索できるので、プロジェクトのメンテナンス時にも役立ちそうです。

ATOM Packages: goto-definition

 

この記事のカテゴリ
プログラミング

この記事に付けられているタグ