この記事は、ESM アドベントカレンダー2022 の 2 日目の記事です。
はじめに
こんにちは、wai-doiです。 日頃 Rails の開発をしていて、メソッドを調べたりするときなどで API ドキュメントを参照することがよくあると思います。
ご存じの方も多いかもしれませんが、今回は自分が便利に使っているドキュメント検索ツールの Dash というアプリを紹介します。Dash はローカルにダウンロードしたドキュメントを検索するので、インターネット検索するよりも素早く検索することができます。
使い方
Macアプリのダウンロード
Dash の公式サイトからダウンロードできます。
お試し期間は無料で使うこともできるそうです。値段 は 2022 年 12 月時点で確認したところ 29.99 ドルでした。 買い切りなので、これからずっと使いづつけるなら元は取れる値段かなと思います。
ドキュメントのダウンロード
自分が検索したいドキュメント（DocSets）をローカルにダウンロードします。 自分が今ダウンロードして入れているのは、Rails の API ドキュメント、Ruby の API ドキュメント、るりま（Ruby リファレンスマニュアル）です。 他にもいろんな種類のドキュメントがありますが、入れすぎると検索のノイズになるので、今はよく参照するこの3つだけにしています。
Ruby と Rails の API ドキュメントは公式にサポートされているので、 Settings -> Downloads からダウンロードできます。必要なバージョンのドキュメントを指定してダウンロードできます。
るりまは公式にサポートされてないなので、標準で Setting -> Downlods からはダウンロードできません。こちらのページから必要なバージョンを指定してダウンロードできます。
http://labocho.github.io/rubydoc-ja-docsets/
便利なところ
横断的に検索できる
知りたいメソッドが Active Support で利用できるメソッドなのか、Ruby 標準で利用できるメソッドなのかがわからない場合がたまにあります。そんなときも Ruby と Rails の API ドキュメントを横断的に一度に検索できるので便利です。
ショートカットを設定できる
Settings -> General からショートカットの設定ができます。自分は「Show Dash and focus Search field」 に Option + Space キーを設定しています。
Option + Space キーを押すと、検索バーにフォーカスした状態で画面を出すことができるので、すぐに検索できて便利です。
Web 上の URL がコピーできる
画面右上の一番左のアイコンから、Web 上でのドキュメントをブラウザで開いたり、その URL をコピーすることができます。プルリクエストのレビューなどで、参考としてメソッドの URL を貼ったりするのにすごく便利です。
その他
自分は使っていませんが、その他には以下のことができるようです。
- スニペットを登録する
- VSCode と連携してコード上のメソッドをすぐに調べることができる
- お気に入りのページをブックマークできる
- ドキュメントに Annotation を書いて共有できる
おわりに
まだ Dash すべての機能を使いこなせていないのでもっと便利に使いこなしてみたいと思います。みなさんもこの記事で Dash が気になったらダウンロードしてみてください。
永和システムマネジメントでは、Ruby とアジャイルソフトウェア開発を通じてコミュニティと成長したいエンジニアを絶賛募集しています。
