★はじめに★
GitHubでプルリクエストのコードレビューをしたとき、初めての頃は高頻度で出ていたエラーがあります。
それはコードの末尾に改行をいれてというエラー
初期のころは何度もこのエラーに遭遇しました😢
その度、該当ファイルのコードの末尾にひたすらEnter
疲れますね
- なぜ末尾に改行を入れるのか
- 何かいい方法はないのか
これら情報をアウトプットしようと思います。
★なぜ末尾に改行を入れるのか★
前提として、多くのプログラミング言語やツールは、ファイルの終わりに改行がないとエラーや警告を出すことがあるそうです。
歴史的にテキストファイルが行単位で処理されることが多く、行の終わりを改行で示すことが一般的だったから。
具体的には、以下のような理由があります
1:互換性
多くのツールやエディタがファイルの終わりに改行があることを前提に作られているため、改行がないと正しく動作しないことがある。
2:バージョン管理システム
Gitなどのバージョン管理システムも、ファイル末尾に改行がないと変更として認識することがある。
3:可読性
ファイルの末尾に改行があることで、他の行と一貫性が保たれ、可読性が向上する。
★何かいい方法はないのか★
私自身何かいい方法はないかと模索していたところ、VsCodeになりますが、次の設定を行うのが有効だそうです。
1：歯車の設定ボタンを押す
2：検索窓にInsert Final Newlineを入力
3：Insert Final Newlineのチェックをオンにする
さいごに
だんだん慣れてくれば自分で末尾に改行を入れる癖はつきましたが、たまーにやってしまう改行忘れ
私と同じようなエラーを繰り返してしま人はぜひこちらの設定をしてみることをお勧めします