英語が苦手なかたにとって、プログラミングで使用するための適切なクラス名やメソッド名を見つけるのは大変な作業かもしれません。
英語の辞書を片手に作業するのは時間がかかりますし、単語の候補が複数みつかった場合は、プログラミング言語で使用するのに適した単語かどれかまではわかりません。
今回紹介する「ghkw」は、そのような場合に役立つ、GitHubでよく使用されているキーワードを検索し、ランク付けして表示することができるコマンドラインツールです。
Katsuhiko Yoshida氏によって作成されたGo製のオープンソースソフトで、MITライセンスによって配布されています。以下使用方法を説明します。
ghkwのインストール
macOSでHomebrewを使用している場合、brewコマンドを使用してインストールするのが簡単です。
$ brew tap kyoshidajp/ghkw $ brew install ghkw
それ以外の環境ではgo getコマンドを使用します。
$ go get -u github.com/kyoshidajp/ghkw
ghkwの使用方法
ghkwの最も簡単な使用方法は「ghkw キーワード1 キーワード2 …」のように検索したいキーワードを並べて指定するというものです。
例えば「exclusion_condition」「exclude_condition」「excluded_condition」の中でどれが一番使われているかを調査したい場合以下のように実行します。
$ ghkw exclusion_condition exclude_condition excluded_condition | RANK | KEYWORD | TOTAL | |------|---------------------|-------| | 1 | exclude_condition | 412 | | 2 | exclusion_condition | 267 | | 3 | excluded_condition | 4 |
この場合「exclude_condition」が412件と一番多く使われていることがわかります。なお初回に実行する場合、GitHubのユーザー名とパスワードを入力する必要があります。
検索範囲を制限することもできます。例えば検索範囲をファイルコンテンツ、JavaScript言語、1,000バイト以上のファイルサイズのものに限定したい場合以下のように実行します。
$ ghkw --in=file --language=javascript --size=">1000" exclude_condition exclusion_condition
指定可能なオプションは「ghkw --help」で確認可能で、GitHub APIのパラメータに対応しています。以下のようなものが存在します。
--in Add in to search term.
--language Add language to search term.
--fork Add fork to search term.
--size Add size to search term.
--path Add path to search term.
--filename Add filename to search term.
--extension Add extension to search term.
--user Add user to search term.
--repo Add repo to search term.
-d, --debug Enable debug mode.
Print debug log.
-h, --help Show this help message and exit.
-v, --version Print current version.
まとめ
ghkwを利用すればGitHubのリポジトリに格納されたソースコードでどのようなキーワードが利用されているのか簡単に検索することができます。ghkwが「GitHub KeyWord」の略称ということを覚えておくとコマンド名も覚えやすいと思います。
