.gitignoreについてメモ

.gitignoreとは

ここに書いとくとgit addしたときに反映されなくなります
以下のようなファイルを指定してるのを見かけます

・色んなライブラリが作り散らかすキャッシュファイル
・開発環境で動かしたときに保存されてしまったあれこれ
・ID、パスワード、トークンなど公開したらあかんファイル

使い方

1. フレームワークが勝手に作ってくれたのを使う

ウェブアプリ開発のフレームワーク (Next.js, Remix, React Routerなど) の場合、プロジェクトフォルダを自動生成した際に.gitignoreにだいたいこの辺だよね、というのを.gitignoreに書いておいてくれたりします。書き足したり消したりしても良いですが、開発側としてはこの辺だと思ってるよ、というのが分かってありがたいです

フレームワークによってはアップロードしないでほしいものはここに置け、みたいなフォルダが用意されていたりしますので、それに従う事で他の開発者にも読みやすくなります

2. 自分で書く

ファイル, フォルダ単位

.gitignoreからの相対PATHで指定するだけです
たくさんある時はたくさん並べて書きます

.gitignore

api/mysite/db.sqlite3

.gitignore

node_modules

/.cache
# /build
/public/build
.env

ワイルドカード

まとめて指定するのも簡単です

.gitignore

**/__pycache__/

例えば、Pythonを動かすと大量にファイルが生成される__pycache__フォルダですが、Djangoアプリを作るとあちこちのフォルダにこれが生成されてしまいます。そういう時はワイルドカードで指定してしまえばOKです

3. pushしちゃったファイルを.gitignoreしたい

一度commitしてしまうとgitがファイル情報をキャッシュに持って、登録対象ファイルとして記憶してしまっている状態になります。.gitignoreは新たに登録されるファイルのみが対象になりますので、既にキャッシュされている場合は消してやり直してやる必要があります

git rm -r --cached . でカレントディレクト以下のファイルをキャッシュから削除
git add . でカレントディレクト以下のファイルを登録対象に追加
最後にgit commitして上記変更を反映します

terminal

git rm -r --cached .
git add .
git commit -m "Ignore __pycache__ directories"
git push

.gitignoreを分けて書く

gitはリポジトリのルートディレクトリにキャッシュやconfigを保存する.gitディレクトリを置いて動きますが、.gitignoreについてはどこに置いてあっても反映してくれます

.gitignoreのあるディレクトリ以下に対して相対PATHで指定されたものが対象となります。ワイルドカードも置いてあるディレクトリより下にしか効かないので管理が楽だと思います

まとめ

簡単です
レッツトライ