git addで出るLFとCRLFの警告を消す方法

​​Git​コマンドライン,トラブルシュート

git add で warning: in the working copy of 'app.js', LF will be replaced by CRLF the next time Git touches it と出るのは、改行コードを変換する設定 core.autocrlf が true になっているためです。git add そのものは成功していて、リポジトリには LF のまま入ります。改行コードを LF にそろえたいなら、core.autocrlf を input か false にするか、リポジトリに .gitattributes を置いて * text=auto eol=lf と書けば、警告は出なくなります。

Windows と Linux・macOS の両方で同じリポジトリを扱うときに出やすい警告です。私は検証環境でこの警告を実際に出し、メッセージをそのまま載せました。設定を変えると同じファイルで警告が消えることも確かめています。

補足

検証環境は Ubuntu 24.04、Git 2.43.0 です。Linux では core.autocrlf を自分で true に設定して、警告を出しました。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定し、ブランチ名の初期値を main に、コミットの日時を環境変数で固定しています。コミットのハッシュなどは、読者の環境では違う値になります。Windows・macOS や、Git for Windows のインストーラーで選ぶ改行コードの設定は試していません。

警告を出してみる

core.autocrlf を true にして、改行コードが LF の app.js と README.md を git add します。cat -A は、行末を $、CR を ^M として表示するコマンドです。行末が $ だけなら LF です。

console
$ git config --global core.autocrlf true

$ git init -q

$ printf "console.log(\"hello\");\n" > app.js

$ printf "# Demo\n" > README.md

$ cat -A app.js
console.log("hello");$

$ git add .; echo "exit=$?"
warning: in the working copy of 'README.md', LF will be replaced by CRLF the next time Git touches it
warning: in the working copy of 'app.js', LF will be replaced by CRLF the next time Git touches it
exit=0

ファイルごとに1行ずつ警告が出ました。ただし終了コードは 0 で、git status を見ると、2つのファイルはどちらもステージに入っています。

console
$ git status
On branch main

No commits yet

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)
	new file:   README.md
	new file:   app.js

警告が言っているのは「次に取り出すと CRLF になる」こと

git ls-files --eol を使うと、ファイルの改行コードを、インデックス(i/)と作業中のファイル(w/)に分けて表示できます(git ls-files の公式リファレンス)。add した直後は、どちらも LF です。

console
$ git ls-files --eol
i/lf    w/lf    attr/                 	README.md
i/lf    w/lf    attr/                 	app.js

コミットしてから、app.js を消して git checkout で取り出し直すと、作業中のファイルは CRLF になりました(行末が ^M$)。コミットの中身は LF のままです。

console
$ git commit -q -m "最初のコミット" && git log --oneline
414e77b 最初のコミット

$ rm app.js && git checkout -- app.js

$ cat -A app.js
console.log("hello");^M$

$ git ls-files --eol
i/lf    w/lf    attr/                 	README.md
i/lf    w/crlf  attr/                 	app.js

$ git show HEAD:app.js | cat -A
console.log("hello");$
core.autocrlf が true のとき、LF のファイルは git add で LF のままリポジトリに入り、次に取り出したときに CRLF になる流れの図
core.autocrlf が true のときの改行コードの流れ

core.autocrlf の公式リファレンスには、true は「作業中のファイルは CRLF、リポジトリは LF」にしたいときの設定だと書かれています。いま LF のファイルは、次に Git が書き出すと CRLF に変わります。警告の「the next time Git touches it」は、このことを前もって知らせています。

反対に、もともと CRLF で保存したファイルを add しても、警告は出ませんでした。リポジトリには LF で入り、作業中のファイルは CRLF のままなので、変わるものがないためです。

console
$ printf "a\r\nb\r\n" > crlf.txt && git add crlf.txt; echo "exit=$?"
exit=0

$ git ls-files --eol crlf.txt
i/lf    w/crlf  attr/                 	crlf.txt

core.autocrlf がどこで設定されているかを調べる

消し方を選ぶ前に、core.autocrlf をどこで設定しているかを確かめます。git config に --show-scope を付けると、値と一緒に、どの範囲の設定か(system、global、local など)が表示されます(git config の公式リファレンス)。

console
$ git config --show-scope --get-all core.autocrlf
global	true

この例では、ユーザーごとの設定(--global)で true になっていました。--global で書いた設定は、そのユーザーのすべてのリポジトリに効きます。--global を付けずに git config で書くと、そのリポジトリの .git/config だけに入ります。

自分の環境だけ変える:core.autocrlf を input か false にする

改行コードを LF のまま扱いたいなら、core.autocrlf を input にします。新しく作った util.js で、設定を変える前と後を比べました。前は警告が出て、input にしたあとは何も出ません。

console
$ printf "export const x = 1;\n" > util.js

$ git add util.js; echo "exit=$?"
warning: in the working copy of 'util.js', LF will be replaced by CRLF the next time Git touches it
exit=0

$ git reset -q util.js

$ git config --global core.autocrlf input

$ git add util.js; echo "exit=$?"
exit=0

$ git ls-files --eol util.js
i/lf    w/lf    attr/                 	util.js

input は、add するときに CRLF を LF に直しますが、取り出すときには変換しない設定です。そのため、input のまま CRLF のファイルを add すると、今度は逆向きの警告が出ました。

console
$ printf "a\r\nb\r\n" > crlf.txt && git add crlf.txt; echo "exit=$?"
warning: in the working copy of 'crlf.txt', CRLF will be replaced by LF the next time Git touches it
exit=0

false にすると変換そのものをしないので、util.js を add しても警告は出ませんでした。Git の公式の解説書『Pro Git』のcore.autocrlf の節では、Windows では true、Linux や macOS では input、Windows だけのプロジェクトで CR もそのまま記録したいなら false を勧めています。

リポジトリで改行コードを決める:.gitattributes に eol=lf を書く

前の節のとおり、core.autocrlf はユーザーごと(またはリポジトリの .git/config)に書く設定で、コミットには入りません。リポジトリの直下に .gitattributes を置くと、改行コードの扱いをリポジトリの中で決められます。gitattributes の公式リファレンスには、ほかの人とも共有したい設定は .gitattributes に書くとあります。

core.autocrlf を true に戻したうえで、.gitattributes の前と後を比べました。

console
$ git config --global core.autocrlf true

$ git add util.js; echo "exit=$?"
warning: in the working copy of 'util.js', LF will be replaced by CRLF the next time Git touches it
exit=0

$ git reset -q util.js

$ printf "* text=auto eol=lf\n" > .gitattributes

$ cat .gitattributes
* text=auto eol=lf

$ git add .gitattributes util.js; echo "exit=$?"
exit=0

text=auto は、テキストかバイナリかを Git に判定させ、テキストのときだけ改行コードを変換する指定です。eol=lf は、取り出すときもインデックスと同じ LF にする指定です。どちらも公式リファレンスに説明があります。core.autocrlf が true のままでも、.gitattributes を置いたあとは、util.js を add しても警告が出なくなりました。

前に CRLF で取り出したファイルは、そのまま残る

.gitattributes を置いても、すでに作業中のファイルの改行コードは書き換わりません。git ls-files --eol を見ると、警告の意味を確かめたときに CRLF で取り出した app.js だけが w/crlf のままです。

console
$ git ls-files --eol
i/lf    w/lf    attr/text=auto eol=lf 	.gitattributes
i/lf    w/lf    attr/text=auto eol=lf 	README.md
i/lf    w/crlf  attr/text=auto eol=lf 	app.js
i/lf    w/lf    attr/text=auto eol=lf 	util.js

app.js を消して取り出し直すと、LF になりました。

console
$ rm app.js && git checkout -- app.js

$ cat -A app.js
console.log("hello");$

$ git ls-files --eol app.js
i/lf    w/lf    attr/text=auto eol=lf 	app.js
注意

rm でファイルを消して取り出し直すと、まだコミットしていない変更は消えます。検証環境でも、app.js を書き換えたまま rm と git checkout -- を実行すると、書き換える前の中身に戻りました。変更のあるファイルでは、先にコミットしてから取り出し直してください。

core.safecrlf を false にしても、変換は止まらない

この警告を出すかどうかは、core.safecrlf という設定でも変わります。別のリポジトリ(core.autocrlf は true)に、改行コードが LF の a.txt と b.txt を作って試しました。git -c 設定=値 は、そのコマンドを実行するときだけ設定を変える書き方です。false では警告は出ませんでした。しかし、取り出し直すと CRLF になります。警告が見えなくなるだけで、変換は止まりません。

console
$ git -c core.safecrlf=false add b.txt; echo "exit=$?"
exit=0

$ git commit -q -m "b" && rm b.txt && git checkout -- b.txt && cat -A b.txt
b^M$

逆に true にすると、警告ではなくエラーになり、ファイルはステージに入りませんでした。

console
$ git -c core.safecrlf=true add a.txt; echo "exit=$?"
fatal: LF would be replaced by CRLF in a.txt
exit=128

core.safecrlf の公式リファレンスには、true は元に戻らない変換を拒み、warn は警告だけ出して続ける、と書かれています。警告を消したいときは、core.autocrlf か .gitattributes で、作業中のファイルの改行コードを LF にするのか CRLF にするのかを決めてください。

​Posted by 86