はじめに
プロジェクトを作成した際によく見る.gitignore
という名前のファイル。
今までは見たことあるなあぐらいの感覚で、こいつが何者なのかはしっかり把握してませんでした。
たまたま触れる機会があったのでこの機会に役割と使い方をまとめておきます👍
.gitignoreとは?
.gitignore
とは、Gitで管理しないファイルやディレクトリを指定するためのファイルです。
プロジェクトのルートディレクトリに配置され、無視したいファイルやディレクトリのパスをリスト形式で記述します。
ワイルドカードや否定記号を使って、より柔軟に指定することも可能です。
(perplexityに聞いてみた内容を引用してます)
メリット
.gitignore
を使用するメリットは以下の通りです。
-
不要なデータの排除
不要なファイルがリポジトリに含まれないため、コードレビューや共同開発が容易 -
セキュリティの向上
公開したくない情報をGit管理から除外することによるセキュリティの強化 -
容量の節約
大容量ファイルを除外できるため、リポジトリの容量を節約し、エラーを防げる
使用例
- 一般的なファイルやディレクトリの除外
# ログファイルを除外
*.log
# tmpディレクトリ全体を除外
/tmp/
# .DS_Store(macOS固有のファイル)を除外
.DS_Store
- 言語・フレームワーク固有の除外
# Pythonの場合
__pycache__/
*.pyc
# Node.jsの場合
node_modules/
# Rubyの場合
vendor/bundle
- IDEやエディタ固有のファイルの除外
# Visual Studio Codeの設定
.vscode/
# JetBrains IDEの設定
.idea/
- ビルド成果物の除外
# Javaのクラスファイル
*.class
# C++のオブジェクトファイル
*.o
- 特定のファイルを除外しない例
# すべての.txtファイルを除外
*.txt
# ただし、important.txtは除外しない
!important.txt