RSpecの.rspecファイルは # を使ってもコメントアウトされない（のでプルリクを送ってマージされた！）

はじめに

RSpecでは.rspecというファイル¹にデフォルトのオプションを書き込むことができます。

.rspec

--format documentation
--warnings

.gitignoreや.zshrcなど、.で始まる設定ファイルは#を使って行コメントを書くことができます²。きっと、.rspecでも同じようにコメント化できるのではないでしょうか？やってみましょう。

.rspec

# --format documentation
--warnings

.rspecを書き替えたのでRSpecを実行してみます。

$ bundle exec rspec
HomeController
  returns a 200 response
  #index
    responds successfully

NotesController
  #index
    searches notes by the provided keyword

（以下略）

あれっ、--format documentationが無効化されてない！！😭

ちなみに期待していた結果はこうです。

$ bundle exec rspec
......................................................................

Finished in 2.19 seconds (files took 1.67 seconds to load)
70 examples, 0 failures

いったいなんでなのー！？

RSpec Core 3.12までは#は無視される

いろいろ調べたところ、.rspecは#を使ったコメントアウトに対応しておらず、ただ単に#は無視されます。
そのため、# --format documentationと書いても--format documentationが有効化されたままになったのです。

もう少し詳しく

どうも設計思想として、.rspecに書かれた内容はコマンドラインで渡すオプションと同じ扱いになっているようです。

つまり、以下のような.rspecがあった場合は、

.rspec

--format documentation
--warnings

以下のように実行したのと同じ扱いになるわけです。

$ bundle exec rspec --format documentation --warnings

とはいえ、#のようなオプションとして無効な文字列が.rspecに含まれていると、

.rspec

# --format documentation
--warnings

RSpec本体の内部ロジックで#は無視されて、結局以下のコマンドを実行したのと同じ扱いになっていました。

$ bundle exec rspec --format documentation --warnings

RSpec Core 3.13以降なら#でコメントアウトできる（はず）

うーん、これはちょっと挙動として不自然でわかりづらくないですか？と思ったのでRSpecにissueを投げてみました。

そして、.rspecファイルで#を使ったコメントアウトが使えるようにするためのプルリクエストを出してみました。

その結果・・・なんとか無事にマージされました！🎉

この記事を書いている時点ではまだリリースされていないですが、順調にいけばRSpec Coreの次のリリース（おそらく3.13？）でこのコメントアウト機能が使えるようになるはずです！

2024.2.5追記
RSpec Core 3.13がリリースされ、ようやくこの変更が日の目を見ることになりました！

おまけ

ちなみにRSpec関連の記事をたくさん書いてる僕ですが、RSpecのコードにコントリビュートするのはこれが初めてです😅

1. 厳密には.rspec以外のファイル名でもオプションは指定可能です（参考） ↩

2. コメント化する文字が # でない設定ファイルもありますが、割合的には # が多いように思います。 ↩