公式ドキュメントを見る癖をつけておこう

記事を書くに至った経緯

チームメンバーのPR(React)をレビューしていたら、見慣れないcloneElementというAPIが使われていました。

const cloneElement = React.cloneElement(element, { className: 'new-class' });

「こんなAPIあったんだ」と思いつつ、仕様チェックのためにReactの公式ドキュメントを確認してみると、、、

なんとcloneElementは、コードを壊す危険性のあるレガシーAPIでした。

このことを実装者に伝え、
結果的にレガシーAPIを使わない形に修正していただくことができました。

もし公式ドキュメントを見なかったら

もし公式ドキュメントを確認せずに、二次情報を参考にしていたら、
「公式が非推奨としている」という情報までは拾えず、Approveしていた可能性があります。

• 動作確認が出来ているから
• CIでエラーが出ていないから
• 公式が提供するAPIだから
• AIがお墨付きをくれたから
• 技術記事でも使われていたから

といった雑な理由でコードを評価すると、不要な技術的負債やバグの温床を産むということを、心底実感しました。

まとめ

もともと公式ドキュメントを読むことは癖づけていましたが、
今回の経験で、公式ドキュメントを読むことの大切さを骨身に沁みて理解しました。

特に今回のように、PRレビュー時に知らないコードを見かけたら、一度公式ドキュメントを確認してみることをおすすめします。
(AIにコードを生成させるときも意識したいところです。)

参考

• React公式ドキュメント - cloneElement