エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


.gitignoreで無視フォルダの中の特定のファイルを除外「!(否定文)」を使う場合の注意点

      2019/02/24

.gitignoreの設定で除外「!(否定文)」を使う場合の注意点

 

.gitignoreの基本的な設定方法

 
Gitでファイルを管理する場合、管理対象にするファイルと管理対象にしないファイルの設定を「.gitignore」ファイルにします。
 
 
「.gitignore」ファイルの記述の方法の基本形は以下の通りとなっています。
 
「.gitignore」ファイルは、複数のフォルダに設置することが可能。
下層に行くほど優先される(記述内容が上書きされる)。
 
 

コメント

 
"#"で始まる行はコメントとなります。
 

 
 

ファイルを指定する

 
.gitignoreファイルにファイルを指定すると、そのファイルは git管理の対象外となります。
 

 
 

フォルダを指定する

 
.gitignoreファイルにフォルダを指定すると、そのフォルダは Git管理の対象外となります。
 

 
管理対象外としてフォルダを指定すると、フォルダ内にあるフォルダも管理対象外となるため、そのフォルダ内のパスを指定してもそもそも管理対象外であるため正常に反映されません。
今回の記事のポイントは、このフォルダの指定の仕方になります。
 
 

正規表現を使って指定する

 
.gitignoreファイルに指定するファイルやフォルダは、正規表現を使用して複数のファイル、フォルダを指定することもできます。
 

 
 

「!」を使って無視対象の否定設定をする

 
無視対象のフォルダの中の特定のファイルを無視対象から外す場合は「!(否定文)」を使います。
 

 
上記は、「test」フォルダは無視対象にしますが、その中の「test1.php」は無視対象から外す(監視対象にする)という設定になります。
 


 

.gitignoreの具体的な設定方法・対象外のフォルダ内のフォルダの指定方法

 

 
 

無視対象のフォルダの中のファイルを「!」を使って指定する

 
上記のような構成の中で、
/vendor/test1/test11.php
上記のファイルを無視対象(除外対象)から外したい場合は、下記のような記述になります。
 

 
 
下記の記述方法では正常に動作しません。
 

 
先の基本的な「.gitignoreの基本的な設定方法」の「フォルダを指定する」で少し触れましたが、最初に「/vendor/*」を記述していますので、「vendor」フォルダ内のすべてのファイル、フォルダが管理対象外(無視対象)となっています。
 
そのため、続けて「/vendor/test1/test11.php」を指定しても「/vendor/test1/」も無視の対象となっているため、無視の対象から除外することができません。
 
そのため、「!/vendor/test1/」を追加することで、無視対象の「vendor」フォルダの中の「test1」だけは無視対象から除外(否定)する設定を行います。
さらに「/vendor/test1/*」を追加して、改めて「/vendor/test1/」フォルダ内のファイル、フォルダを無視対象にする設定を行います。
 
 
同様に
/vendor/test2/test21/test211/test2111.php
上記のファイルを無視対象(除外対象)から外したい場合は、下記のような記述になります。
 

 
無視対象にしたフォルダの中の特定のファイル、フォルダを無視対象から外す(無視設定を否定)する場合は、その途中のパスも無視対象から外す(無視設定を否定)する設定をしていく必要が出てきます。
無視対象から外す設定は、階層が深くなるとそれだけ記述が長くなり面倒になります。
 
 

無視対象のフォルダの中のフォルダが 1つしかない場合の対応方法

 
さらに厄介なのが、「test31」のように、経由するフォルダの中にフォルダが 1つしかない場合です。
下記のように記述してもうまく動作しません。
 

 
 
下記は分かりやすいように 3行目、4行目をコメントにしていますが、下記のように「test31」の指定部分を削除する必要があります。
 

 
 

.gitignoreの設定方法のあと

 
.gitignoreを設定すると、その内容を反映し、無視対象から外したファイル(gitの管理対象に加えたファイル)を、改めて「git add .」で追加して、コミットする必要があります。
 
ですが、Gitはコミットした情報をキャッシュとして管理していますので、.gitignoreを更新しただけではうまく管理対象に加えたファイルを処理してくれない場合があります。
 
そんな場合は、Gitのキャッシュを削除する対応が必要になりますが、それについては下記に記事を書いていますので、併せて参考にしてください。
.gitignoreを更新しても反映されないときは「git rm -r --cached .」でキャッシュを削除
 
 

Git関連の記事

Gitはフォルダ自体を管理対象にはできない。空のフォルダを設定する手順
.gitignoreを更新しても反映されないときは「git rm -r --cached .」でキャッシュを削除
.gitignoreで無視フォルダの中の特定のファイルを除外「!(否定文)」を使う場合の注意点
Gitで「fatal: Authentication failed for 'https://example.com/git_repositories/example.git/'」のエラーが出た場合の対処方法の一つ
Gitで基本的なデプロイ(push、pullで本番公開)環境を作る手順解説
 
その他の「git」に関する記事一覧
 
 

 - プログラミング・Web関連技術

GoogleAdwords

GoogleAdwords

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

※入力いただいたコメントは管理者の承認後に掲載されます。

  関連記事

Gitはフォルダ自体を管理対象にはできない。空のフォルダを設定する手順
Gitはフォルダ自体を管理対象にはできない。空のフォルダを設定する手順

Gitはフォルダだけを管理対象にすることはできない。そのため空の.gitkeepファイルを作成し管理対象にすることで、それが入っているフォルダも管理対象にする、と言う手順で管理を行う。

CentOS環境に ntpdをインストールして自動的に時刻を取得する設定にする
CentOS環境に ntpdをインストールして自動的に時刻を取得して合わせる設定にする

VirtualBoxに構築した CentOSの環境の時計がずれているとき、ntpdをインストールし、時計を合わせる方法を解説。NTPサーバを指定する方法や ntpdを自動起動する設定も解説。

PythonでMySQLへの接続ライブラリMySQL-pythonの簡単インストール方法

PythonはMySQLに接続するライブラリは別途インストールが必要。なのでMySQL-pythonライブラリのインストール方法とサンプルスクリプトで動作検証までを解説。

Webサイト公開時に重複コンテンツを排除する.htaccessのリダイレクトの設定のまとめ

サイトを公開する際にはURLの正規化は必須です。正規化とは何かを解説し、.htaccessに設定すべきリダイレクトの設定を具体的に説明します。

PythonでUTF-8など日本語(全角文字)を使う方法。コメントにも必要。

Pythonの標準では日本語(全角文字)を利用できないので、利用する際は文字コードを宣言する必要がある。「# coding: utf-8」の様に記述すればOK。

本当に?GMO系ロリポップ・ヘテムルを無料で運用する方法があった!

ロリポップ、ヘテムルを株主優待を利用して実質無料で運営しよう!という解説記事です。株主優待で提供されるサービスの内容を解説し、無料になる仕組みを解説します。

エックスサーバーで独自SSLは永久無料で取り放題。利用方法と理由を解説!

エックスサーバーでは独自SSLが無料でいくつでも設置できるように!しかも、国、都道府県などの数項目の入力と数クリックだけという超簡単!SSL化しない理由がない!

FTPでダウンロード時にファイルが重複するため上書きしますか?と表示される問題

FTPでファイルをダウンロードする際に「ファイルが重複しています。上書きしますか?」というメッセージが出る場合がありますが、これの原因と対策、解決策の記事です。

直リンク禁止の.htaccessを超分かりやすく解説。日本語じゃなくてPHPで説明

直リンクを禁止する.htaccessの記述内容を日本語ではなくPHPで解説!私自身もこの方法ですっかり理解できました。.htaccessって簡単!って思えますよ。

.htaccessのmod_expiresでブラウザキャッシュで高速化でSEO対策!

Page Speed Insightsの指摘事項のファイルのブラウザキャッシュの設定方法。解説もしてるけど、.htaccessにコピペするだけの簡単設置で効果抜群!SEOにも威力を発揮!