mv ./sample ./Sample の後にgit add すると...???

みなさんタイトル通りファイル名の変更操作をした後に，Git操作をすると．どうなるかわかりますか？？
例えばディレクトリ名の変更をするために以下のようにコマンドを打ってみる．．

mv ./sample/ ./Sample/

git add ./sample

ちゃんと変更を認識しているかgit statusしてみると...

❯ git status
On branch develop
Your branch is up to date with 'origin/develop'.

nothing to commit, working tree clean

ファイル名を大文字にしたのになんも変わってないじゃん！！！！以下のようにrenamedとなって欲しいのに...

❯ git status
On branch develop
Your branch is up to date with 'origin/develop'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        renamed:    sample/README.md -> Sample/README.md

と，いうことで大文字小文字の変更は認識されないみたいです．

WindowsとMacでのみこのような事象が確認されるみたいですよ．LinuxやUNIXでは確認されない事象です．

本記事ではGitでディレクトリ名の大文字小文字を変更する際に遭遇する問題について, その詳細な理由と解決方法を説明します.

(今更ですが...)本記事ではコマンドでgitとファイル操作を記載しています．操作方法が怪しい方は以下の記事を先にご覧ください．

git/ghコマンドチートシート

ファイル操作コマンドチートシート

なぜこの問題が発生するのか

なぜこのような認識がされないという問題が発生するのか...それはOSやGitのメカニズムに理由があるみたいです...
とりあえず考えうる理由，原因を列挙してみました．

1. オペレーティングシステムの違い

Unix/Linux系システム

• デフォルトで大文字小文字を区別する（case-sensitive）.
• 「sample」と「Sample」は異なるディレクトリとして扱われる.
• ファイルシステムレベルで完全に別物として認識される.

MacOS

• デフォルトで大文字小文字を区別しない（case-insensitive）.
• 「sample」と「Sample」は同じディレクトリとして扱われる.
• 表示上は大文字小文字が保持されるが, システム内部では同一として扱われる.

Windows

• MacOSと同様に大文字小文字を区別しない.
• ファイルエクスプローラーでは大文字小文字の違いを表示するが, システムとしては同一パスとして扱う.

2. ファイルシステムの動作例

project/
├── sample/
│   ├── test1.tsx
│   └── test2.tsx
└── .git/

このディレクトリ構造で以下の操作を行った場合の動作を考える．

mv ./sample/ ./Sample/

Unix/Linux系での動作

1. 新しい「Sample」ディレクトリが作成される.
2. 古い「sample」ディレクトリの内容が移動される.
3. 古い「sample」ディレクトリが削除される.

MacOS/Windowsでの動作

1. ファイルシステム上では実質的な変更として認識されない.
2. 表示名のみが変更される.
3. パスとしては同一のものとして扱われる.

3. Gitの動作メカニズム

Gitの内部構造
1. インデックス（Staging Area）

• ファイルパスと内容のスナップショットを保持する.
• 大文字小文字の区別はcore.ignorecaseの設定に依存する.

2. オブジェクトストア

• ファイルの実際の内容を保存する.
• ハッシュ値で管理される.

3. リファレンス

• ファイルパスとオブジェクトの対応を管理する.
• ファイルシステムの特性に影響される.

問題が発生する具体的な流れ

1. 初期状態

• インデックスに「sample/test1.tsx」として登録されている.
• オブジェクトストアにファイル内容が保存されている.

2. ディレクトリ名変更後

• case-insensitiveシステムではファイルシステムレベルで変更が検知されない.
• Gitは新しいパス「Sample/test1.tsx」を新規ファイルとして認識する.
• 古いパス「sample/test1.tsx」の参照が残ったままとなる.

3. 結果

• 同じファイルが異なるパスで2重に登録される状態となる.
• リネーム操作として認識されない.

4. プラットフォーム間での問題

クロスプラットフォーム開発での影響
1. Unix系開発者がリネーム

• 正しく変更が検知される.
• コミットされる.

2. Mac/Windows開発者がプル

• ローカルファイルシステムの制限により正しく反映されない可能性.
• 手動での対応が必要.

解決方法

このような問題がある中でどのように解決すべきかを調べてみた結果，以下のような解決法があるみたいです．

方法1: git rmを使用した手動での変更追跡 (非推奨)

1. Gitの大文字小文字の区別設定を変更する.
gitのconfigをいじって大文字小文字の識別を無視する設定をfalseにする．

git config core.ignorecase false

2. ディレクトリ名を変更する
mvコマンドを使ってファイル名を切り替えます

mv ./sample/ ./Sample/

1. 変更をステージングする

git add .

この状態でgit statusをしてみると

❯ git status
On branch develop
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        new file:   Sample/file1.txt

となる．

この方法だと... renamedにならず，new fileとなる．さらにうまく動作しない場合があるので非推奨とさせていただきました．

方法2: 一時的な中間名を使用する方法 (推奨)

方法2は2段階のaddにより，Gitが変更を確実に追跡できるようにする．

1. まず, 一時的な名前に変更してaddする
大文字小文字を直接変更すると認識しないので何か他のディレクトリ名に変更し，addする．

mv ./sample/ ./_sample/
git add .

2. 目的の名前に変更する
本来変更したい名前にここで変える．

mv ./_sample/ ./Sample/
git add .

これでgit statusをしてみると...

❯ git status
On branch develop
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        renamed:    sample/file1.txt -> Sample/file1.txt

このようにちゃんとrenamedになる．これで差分もrenamedで問題ないですね．

このようにディレクトリの大文字小文字変更を扱う際は以下の点に注意しよう．

1. core.ignorecaseの設定確認
2. 変更がrenameとして認識されているか確認

これらの手順と注意点を守ることで, ディレクトリ名の大文字小文字変更を正しく管理できます. また, この問題はGitの仕様とファイルシステムの特性に起因するものであり, 完全な回避は難しいが, 上記の方法で適切に対処することが可能であるので落ち着いて対処しましょう．

それではQiitaアドカレ.24企画の今日のクリスマスツリーです．

詳しくはこちらの記事から