こんにちは。いつもブログをご覧くださり、ありがとうございます。
本日の記事は私の備忘録の意味合いが大きくなったしまいますが、PhpStormを使っている時の小ネタです。

.ideaディレクトリをGitHubリポジトリで管理しない設定

普段の開発作業は、PHPを書く時は「PhpStorm」を使っていますが、JetBrainsのIDEを使っていると .idea/ ディレクトリがプロジェクトに作成されます。このディレクトリには IDE の設定が保存されています。

チーム開発でエンジニア全員がJetBrainsのIDEを使っている場合、プロジェクト設定を共有するために、.idea/ ディレクトリ内のユーザ固有の設定を含んでいる、workspace.xmlとusage.statistics.xml、tasks.xmlは除外し、それ以外をGitHubのプライベートリポジトリで管理するのが望ましいようです。

しかし、個人開発の場合、.idea/ ディレクトリはGitHub で管理しない（コミットしない）のが安全と思います。普段のPHP開発の場合、リポジトリの .gitignore に以下を追加します。

# IDE
.idea/
.vscode/

# macOS
.DS_Store

# logs
*.log

# node
node_modules/

Git管理から削除（ローカルには残す）

ローカルには残してGit 管理から外す場合には、以下のようにします。

❌ .idea 消える
✅ ローカルは残る

git rm -r --cached .idea

その後、コミット&プッシュします。

git commit -m "Remove .idea from repository"

git push

参考記事

• How to manage projects under Version Control Systems
• IntelliJでの .idea ディレクトリの管理と .gitignore のベストプラクティス
• PhpStormの.ideaをgitで共有する

お問い合わせはこちらから

南大阪を中心に活動しているシステムエンジニアです。これまでの経験から、ビジネス課題について一緒になって考え、課題解決のためにサポートさせていただきます。些細なご相談でも構いません。当方に期待することやご相談内容についてお聞かせください。

お問い合わせはこちらから