Gitでソースコードを管理しながら開発を行うときに「このファイルだけは無視してほしい!」何てことありますよね。
そういう時にgitignoreというファイルを作成してあげることによってGitに無視してもらえるようになります。
それではgitignoreの記述方法についてみていきましょう。
gitignoreファイルの配置場所は、ソースコードのトップディレクトリに「gitignore」という名前のファイルを作成するだけでOKです。
(もっと細かく説明すると「.git」フォルダと同階層に「gitignore」を作成します)
拡張子は何もいりませんので、「gitignore.txt」などにしないように気を付けてください。
gitignoreの基本的な書き方はすごく簡単で、無視してほしいファイルのトップディレクトリからのパスを記述するだけです。
「ignore.html」というファイルを無視してほしい場合
ignore.html
と記述するだけです。
「html/ignore.html」というファイルを無視してほしい場合
html/ignore.html
というようにファイルのパスを記述すれば、そのファイルは無視してGitで管理することができます。
gitignoreはすでにGitで管理しているファイルを無視する変更は反映されませんのでご注意ください。
すでにGitで管理しているファイルを無視したい場合はキャッシュを削除する必要がありますので、以下のコマンドでキャッシュを削除します。
git rm --cached ファイルパス
gitignoreの簡略化した書き方
無視したいファイルが何個かしかない場合は上記の方法で問題ありませんが、このフォルダ全部無視してほしいんだけどというときに使える書き方を紹介します。
フォルダ配下のすべてのファイルを無視したい場合
フォルダパス/
フォルダ内の「.html」という拡張子のファイルを無視してほしい場合
フォルダパス/*.html
「image」というフォルダが複数個所に存在していてそのすべてを無視してほしい場合
**/image/**
他にも記法はあるのですが、基本的に今回ご紹介した記法を知っておけば大体どうにかなります!
このファイル以外無視してというときに使える書き方
「html」フォルダ内の「index.html」以外は無視してほしいということが少なくありません。
そういう時は、
html/
!html/index.html
というようにhtmlフォルダ配下をまず無視して、そのあとに!からはじめて無視してほしくないファイルのパスを記述することで、「html」フォルダ内の「index.html」以外は無視してほしいという設定が可能です。
gitignoreの記法まとめ
gitignoreは開発の初めに主に設定するもので頻繁に使うものではないので、基本的な記法以外はわざわざ覚えなくて大丈夫です。
ただ、こういう書き方あったよな程度に覚えておけばすぐにググって記法を検索できますので、何ができるかは覚えておきましょう。
ググるのがめんどくさい時はこのページをブックマークしていただければすぐに参照できるかと思います。
分かりずらい部分やこういう時はどうしたらいいかなどのご質問があればコメントでもTwitterでもお問い合わせでも大丈夫ですのでお気軽にお問い合わせください。
コメント