Insert Final Newlineの設定をしようという話

TL;DR

ほとんどのエディタに存在するInsert Final Newlineの設定を、基本的にはしておきましょうという話です。

Why?

POSIXでLineの定義が 0個以上のNewLineでない文字と末尾のNewLineの集合 となっており、TextFileがLineの集合だからです。

ref: https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206

ファイルの末尾が改行で終わっていないとCLIで diff を実行した際に \ No newline at end of file という表示が出たり cat を実行した際に以下のようにファイルの内容の右にpromptが表示されてしまったりします。

Terminal:~ user% cat foo.txt
barTerminal:~ user%

GitHubではPull RequestのFiles changed上で赤いアイコンが表示されますね。

What?

おそらく皆さんが使っているエディタには "ファイルを保存した際に末尾に改行がなければ追加する" という設定があると思います。これを設定しましょう。

How?

VSCode, Emacs, Vim, IntelliJ-based IDEsの設定を記載しておきます。この4つを選んだのは私がよく使うエディタだからという理由です。

VSCode

Emacs

(setq require-final-newline t)

Vim

デフォルトがそうなっていると思います。

IntelliJ-based IDEs

ref

• https://stackoverflow.com/questions/729692/why-should-text-files-end-with-a-newline
• https://thoughtbot.com/blog/no-newline-at-end-of-file
• http://www.gnu.org/software/emacs/manual/html_node/emacs/Customize-Save.html