Zenn
Open1

.gitignoreの使い方

ひでひで

.gitignoreとは

  • Gitで管理しないファイルやディレクトリを指定するための設定ファイル
  • プロジェクトのルートディレクトリに配置
  • セキュリティや効率性の観点から重要

1. .gitignoreを作成する

# プロジェクトのルートディレクトリで
touch .gitignore

2. よく除外するファイル・ディレクトリ

# IDE・エディタの設定ファイル
.vscode/
.idea/
*.swp

# 依存関係のディレクトリ
node_modules/
vendor/

# ビルドファイル
dist/
build/

# 環境設定ファイル
.env
.env.local
config.json

# ログファイル
*.log
npm-debug.log*

# キャッシュ
.cache/
.npm/

# システムファイル
.DS_Store
Thumbs.db

3. .gitignoreの記法

# コメント行
# 末尾のスラッシュ / はディレクトリを表す
logs/        # logsディレクトリを除外

# ワイルドカード * は任意の文字列
*.pdf        # 全てのPDFファイルを除外
test*.json   # testで始まるJSONファイルを除外

# 否定 ! で除外から除外（追跡対象に含める）
*.pdf        # 全てのPDFファイルを除外
!docs/*.pdf  # docsディレクトリのPDFは除外しない

# ** は任意のディレクトリ階層
**/temp      # どの階層のtempディレクトリも除外

4. よくある使用例

  1. Webアプリケーションの場合
# 依存関係
node_modules/
package-lock.json

# 環境設定
.env
.env.local
.env.development

# ビルドファイル
dist/
build/
*.min.js

# デバッグファイル
npm-debug.log*
yarn-debug.log*
yarn-error.log*
  1. Pythonプロジェクトの場合
# Python
__pycache__/
*.py[cod]
*$py.class
*.so
.Python
env/
venv/
.env

# 配布用ファイル
*.egg
*.egg-info/

5. 既存の.gitignoreテンプレート

GitHubは様々な言語やフレームワーク用の.gitignoreテンプレートを提供しています：
https://github.com/github/gitignore

6. 注意点

  1. すでにGitで管理されているファイルは、.gitignoreに追加しても無視されません
# その場合は、以下のコマンドで管理から除外
git rm --cached [ファイル名]

  1. .gitignoreは新しく追加されるファイルにのみ適用されます

  2. チーム開発では.gitignoreも共有することが重要