ぺい

大阪の専門学生の落書き。主にエンジニア寄りの話。

exampleがないOSSでexampleを探す方法

OSS使うとよく起きるアレ

f:id:tikasan0804:20170704205846p:plain

流行っている言語やフレームワークを使っていれば、そこまで深刻な問題ではありませんが、僕とかは普段Goをメインに書いているので、利用者が少ないOSSを使うことがよくあります。
そんな時に起きる問題が、
「良いOSS見つかったけど、使い方わからん」

せっかく良いの見つけたのに、正直よくわかんねーーーーってなって、使うのを諦めるのは勿体ないですよね。(ドキュメントとかテスト読めば分かりますが)そんな時にほしいのがexampleです。一切無いものは珍しいですが、あったとしても非常に端的なものしかないことが多いので、そこからはドキュメントなどを読んで、自分のケースに当てはめたりするフローは必須ですが、少しでも多くの利用例があるに越したことはありませんよね?

そこで、他のexampleを探す方法を紹介します。

コードを探すならGithub

github.com

今回はGoのOSSでexampleを探してみましょう。まだ、スター数は300前後で、少なくはありませんが採用例をググって探すのは難しいぐらいの微妙なラインのものです。

f:id:tikasan0804:20170704211049p:plain

使うのは、Githubの検索窓です。検索には先程のOSSを実行する時に必ず使うソースの一部を貼り付けます。

dockertest.NewPool(

以下が検索結果です。 github.com

f:id:tikasan0804:20170704210354p:plain 51コードがヒットしました。これで、用意されたexample以外のパターンを見ることが出来ます!!!これでまあまあ幸せになれるかもしれません。 他にも、importしているパッケージ名とかでも検索が出来たりするので、探してみてください。