ATOMにTodo機能を追加するプラグイン「Todo-show」



ATOMにTo-Do機能を追加するプラグイン「Todo-show」の紹介です。

プロジェクトを進めているとコード内に次にすることや、注意書き、変更点、その他いろいろなことをコメントとして残すことはよくあります。

Android Studioを始め、JetBrain系のIDEには便利な" TODO "機能が実装されていますが、それをAtomエディタに実装出来るプラグインが「Todo-show」です。

* 右に特定ワードが含まれている箇所をリスト化してくれます ( TODO, NOTE 等)

このプラグインは、特定のキーワードが含まれている箇所をルックアップしてリスト化してくれます。
( リスト化された箇所をクリックするとそのワードがあるファイルにジャンプしてくれます [* 行まで] )


Atom Todo-showのインストール 〜 使い方 
 

インストールはSettingのinstallから'  todo-show 'と入力して検索するか、コマンドラインからインストールする場合は下記のコマンドでインストールが開始されます。

apm install todo-show


インストールが完了すると、TODO機能が使えるようになり、キーボードの " ctrl + shift + T " でTodo-showのリストが開けるようになります。

デフォルトで用意されている予約後は FIXME, TODO, CHANGED, XXX, IDEA, HACK, NOTE, REVIEW の8種類。Todo-showのコンフィグページからキーワードを追加することも可能。
( Setting -> Packages からセッティング項目に移動できます )

しかしながら、パッケージマネージャー等を使って外部ライブラリを導入していると、インストールしたライブラリに "TODO, XXX"等のキーワードが既に使われており、Todo-showリストにヒットして自分の為につけた注釈が見づらくなる時があります。

elixirやerlangのプロジェクトの場合、"deps"内のキーワードが多数ヒットしています ( 画像はphoenixフレームワークのプロジェクト )

そのような時はTodo-show -> Settingの” Ignore These Paths”内に除外するパスを記述することで、除外するフォルダを指定できます。
( 予め PHPの" vendor ", bowerの" bower_components ", node.jsの" node_modules "ディレクトリはデフォルトで除外するように設定されています )

今回は "deps" フォルダを除外するように設定しました

bowerを使っていて、.bowerrcファイルでインストールする場所を変更している人は、除外するフォルダを設定したほうがよさそうですね。


Summary

以上でTodo-showの紹介は終わりです。

メインにATOMエディタを使ってプロジェクトを進めている人には役に立つプラグインだと思うで、気になった人はゼヒ×2チェックしてみてください!

mrodalgaard/atom-todo-show

 

 

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

この記事のタグ