読者です 読者をやめる 読者になる 読者になる

YARD に --fail-on-warning オプションを追加する PR を送った

久しぶりに public リポジトリに対して PR を送ったので記録として日記を書く。

github.com

YARD は YARD 記法と呼ばれるルールでコメントを書いて付属のコマンドを実行すると綺麗なドキュメントを生成してくれる Ruby 界隈では割りとよく使われるツール。便利なので僕もよく利用するのだけど、 YARD 記法に誤りがあるともちろん出力結果がおかしくなる。正しく書けているか CI でチェックして、もし間違った書き方をしていたらテストが落ちてほしい。

しかし、 YARD はなぜかパース中に変な文字列を発見しても [warn] と stderr に出力するだけで status code は 0 で終了する。多くの CI サービスは status code を見るので、これではテストが通ってしまう。しかもヘルプメッセージを調べもそれっぽいオプションがない。マジか。

と思ったら 機能要望の issue だけが作られた状態だった。しかも “Easy” ラベルがつけられている。

面倒だなと思いつつも、いろいろなところで使っているツールでもあるし、間違いなくあった方がいい機能だと思うので一念発起して書くことにした。まぁ数年前に YARD のコードリーディングをしたことがあって、だいたいどこで何が起こっている分かっていたことも大きい。

結果としては途中 yujinakayama にテストの書き方を相談したりしつつ 1 時間くらいで書き上がって送信。マージされるといいな。