もくじ
.gitignoreファイルのパス指定方法について解説します。
特定のファイルやフォルダをGitの管理対象から除外する際に、正しい記述方法を知っておくことは重要です。
本記事では、基本的な記述ルールからワイルドカードを使った応用までをわかりやすくまとめました。
.gitignore の基本
.gitignoreは、Gitに管理させたくないファイルやフォルダを指定するための設定ファイルです。
プロジェクトのルートディレクトリに配置するのが一般的です。
.gitignore の記述方法
.gitignoreファイルは基本的に1行に1つのパターンを記述します。
# これはコメントですexample.txt
この場合、それぞれの意味は次のとおりです。
1行目の#で始まる行は、コメントとして扱われGitの動作には影響を与えません。
.gitignoreの中で設定の意図や説明を記載するのに使用します。
2行目のexample.txtは、パスを限定せずにGitに管理させたくないファイルを指定しています。
ファイル・フォルダの指定方法
特定のファイルを無視する
リポジトリ内にある全ての「example.txt」ファイルが無視の対象になります。
example.txt
特定のフォルダ内のファイルを無視する
リポジトリ内の「example」フォルダにある「example.txt」ファイルが無視の対象になります。
/example/example.txt
フォルダを指定してフォルダ内の全てのファイルを無視する
「example」フォルダ内の全てのファイルが無視の対象になります。
/example/
ワイルドカードを活用した指定方法
特定の拡張子のファイルを無視する
*は任意の文字列という意味で、以下の記述の場合.log拡張子のファイルが全て無視の対象になります。
*.log
ネストされたフォルダの特定のパターンを無視する
**は任意のフォルダまたはファイルという意味で、以下の場合リポジトリ内のどのディレクトリ階層にあっても「example」フォルダの内の全てのファイルが無視の対象になります。
**/example/
例外の指定方法
.gitignoreでは、通常の無視ルールとは逆に、特定のファイルやフォルダを例外としてGitに含めることができます。
その場合、!を先頭に付けます。
*.txt!important.txt
上記の場合、*.txtにより、すべての.txtファイルが無視されます。
しかし!important.txtによって、important.txtは例外としてGitに追加されます。
エスケープが必要なケース
.gitignoreでは、パス名や特殊文字を正しく処理するためにエスケープが必要な場合があります。
エスケープは円マーク¥またはバックスラッシュ\で行うことができます。
以下に2つ例をあげます。
スペースを含むフォルダやファイル名を指定する
/My Folder/フォルダを無視したい場合、/My\ Folder/と指定します。
# をファイル名に含める場合
#をファイル名に含める場合、コメントと誤認識されるためエスケープが必要です。
#sample.txtファイルを無視したい場合、\#sample.txtと指定します。
.gitignoreに記述しても無視されない場合の対処法
コマンドで無視されているか確認
git check-ignore -v fileName
.gitignoreに例外を追加しても、すでに追跡されているファイルは無視されません。
そのため、以下コマンドで追跡を解除する必要があります。
git rm --cached fileName
書籍でGitを学ぶ
udemyでGitGitを学ぶ
もみじ
Gitの仕組みを理解しながら学習したいという方におすすめの講座です。
私もこの講座でGitの操作方法について学びましたが、 コマンドがどのような仕組みで実行されているのか図解で説明がありとても理解しやすかったです。
今までGitを何となく使用しているだけで、Gitが何をしているのか理解できていない部分がありましたが、それらを理解することができました。
実際にコマンドラインで手を動かしながら学習できるため、初心者でもスムーズに学ぶことができます。
もみじ
これからGitを学びたい方、プロジェクトで使えるようになりたい方には、ぜひ手に取ってほしい一冊です。
私もこの本でGitの操作方法について学びましたが、GitやGitHubの基本的な操作から、実際にコードを管理する方法まで、初心者にも分かりやすく解説されてました。
特に良かったのは、手を動かしながら覚えていける点とコマンドラインだけではなく、SourceTree（クライアントソフト）を使用したGitの操作方法の説明があったところです。
もしGitに苦手意識があるなら、ぜひこの本を読んでみてください。
初心者でもスムーズに学べる内容が詰まっています。