.gitignoreとは

.gitignoreは、Gitでバージョン管理を行う際に、追跡対象から除外するファイルやディレクトリを指定するための設定ファイルです。このファイルを使うことで、不要なファイルがリポジトリに追加されるのを防ぎ、プロジェクトをクリーンに保つことができます。

.gitignoreファイルはプロジェクトのルートディレクトリに配置され、Gitはこのファイルを参照して無視すべきファイルを判定します。

.gitignoreの基本的な書き方

.gitignoreファイルの記述は非常にシンプルで、各行に無視したいファイルやディレクトリのパスを指定します。以下に基本的な書き方を説明します。

1. ファイルを無視する:

特定のファイルを無視したい場合、ファイル名をそのまま記述します。

例: .gitignoreに以下を記載
config.json

2. ディレクトリを無視する:

ディレクトリ全体を無視したい場合は、ディレクトリ名の後ろにスラッシュ（/）を追加します。

例:
/tmp/

3. パターンで指定する:

ワイルドカード（*）を使って複数のファイルやディレクトリを指定できます。

例:
*.log （すべての.logファイルを無視）
*.tmp （すべての.tmpファイルを無視）

.gitignoreの応用例

.gitignoreファイルでは、複雑な条件を指定することも可能です。以下はよく使われる例です。

1. 特定のサブディレクトリのみ無視する:

特定のディレクトリ内のファイルを無視したい場合、パスを明示的に指定します。

例:
logs/*.log （logsディレクトリ内の.logファイルのみ無視）

2. 特定のファイルを例外として追跡する:

無視ルールの中でも追跡したいファイルを指定する場合は、エクスクラメーション（!）を使います。

例:
*.log
!important.log （important.logは無視せず追跡）

.gitignoreの作成と配置

.gitignoreファイルは、プロジェクトのルートディレクトリに作成します。ルートディレクトリ以外にも、サブディレクトリに個別の.gitignoreを作成することも可能です。

作成方法は以下の通りです。

1. コマンドラインで作成:
touch .gitignore

2. テキストエディタで作成:
任意のテキストエディタで.gitignoreという名前のファイルを作成します。

.gitignoreに記載するべき項目の例

以下は、一般的に.gitignoreに記載される項目の例です。

1. OS固有のファイル:

.DS_Store （macOS）
Thumbs.db （Windows）

2. IDEやエディタ固有のファイル:

/.vscode/
/.idea/
*.suo

3. ビルド成果物やキャッシュ:

/dist/
/node_modules/
*.class

.gitignoreが無視されない場合の対処法

すでにGitが追跡しているファイルは、.gitignoreに記載しても無視されません。その場合は、以下の手順でキャッシュを削除します。

1. キャッシュを削除:
git rm --cached [ファイル名]

2. 変更をコミット:
git commit -m "Remove cached file"

まとめ

.gitignoreは、プロジェクト管理を効率化する重要なツールです。無視するファイルやディレクトリを適切に指定することで、リポジトリをクリーンな状態に保つことができます。プロジェクトごとのルールに従って、.gitignoreを効果的に活用しましょう。