Gitを使い始めると、よく出てくる「.gitignore」ファイル。 「node_modulesってGitに入れちゃダメ?」「.envって無視しとくべき?」みたいな疑問、最初はけっこう出てきますよね。 この記事では、Node.jsプロジェクトを例に、.gitignoreって何なのか、どう使えばいいのかを、ざっくりやさしく紹介します!
.gitignoreってなに?
簡単に言うと、Gitで管理したくないファイルやフォルダを「これ無視してね!」って指定するためのファイルです。
名前の通り、「Gitで無視(ignore)するリスト」を作る感じですね。
なんで必要なの?
たとえば、次のようなファイルはGitに入れると困ることが多いです:
node_modules/
:とにかくデカい。再インストールできるから入れる必要ナシ.env
:APIキーやパスワードなど、うっかり公開したらヤバいやつdist/
やbuild/
:ビルドで自動生成されるファイル。変更履歴いらない- 一時ファイル:Macやエディタが勝手に作るゴミファイル(例:
.DS_Store
)
基本の書き方
書き方はめちゃシンプル。1行ずつ書いていくだけです。
# node_modulesは除外
node_modules/
# .envファイルも除外
.env
# Macのゴミファイル
.DS_Store
# ビルド関連
/dist
/build
✅ 書き方のコツ:
- スラッシュ付きでフォルダを指定(例:
/build
) - ドット始まりのファイルもそのままでOK(例:
.env
,.DS_Store
) - コメントは
#
を使う
Node.jsプロジェクトでよくある.gitignoreの例
node_modules/
.env
package-lock.json
.DS_Store
*.log
/dist
プロジェクトの規模や使ってるツールによって、ちょっとずつ調整すればOKです!
.gitignoreが効かない!?そんなときは
「書いたのに無視されない!」ってときは、 Gitがすでにファイルをキャッシュしちゃってることが原因かも。
そんなときはこれで解決:
git rm -r --cached ファイル名(またはフォルダ名)
git add .
git commit -m ".gitignore再適用"
よくある疑問Q&A
Q. .gitignoreファイルって絶対必要?
A. 絶対じゃないけど、チーム開発やGitHubに公開するならマナーみたいなもんです!
Q. 空のフォルダってどうやって管理するの?
A. 普通はGitに入らないけど、.gitkeep
っていう空ファイルを置く手もあります。
Q. .gitignoreはどこに置けばいいの?
A. 基本はプロジェクトのルート(package.json
がある場所)に置きましょう!
まとめ
.gitignore
は「これはGitで無視して〜」と伝えるためのファイル- node_modulesや.envみたいなデカいor機密なファイルは除外必須
- 効かないときはキャッシュを疑ってみて
- Gitをちゃんと使いたいなら、最初に整えておくと後が楽!
一見地味だけど、実はとっても大事な.gitignore。 最初にちゃんと知っておくと、あとあと後悔しないで済みますよ!
コメント