.gitignoreファイルとは?

.gitignoreファイルは、バージョン管理の対象から除外するファイルをGitに伝えるものです。再インストールできる依存関係(node_modulesなど)、ビルド出力、ログ、キャッシュ、エディターの設定、macOSの.DS_StoreやWindowsのThumbs.dbのような、オペレーティングシステムが作成するファイルなどを除外できます。リポジトリのルートフォルダーに配置してください。指定したパターンは、そのフォルダーとその下のすべてのフォルダーに適用されます。

テンプレートの提供元

テンプレートは、GitHub公式のコレクションであるgithub/gitignoreリポジトリから取得しています。リポジトリの作成時にGitHubが提供するものと同じです。このツールは、毎日更新されるコピーを読み込みます。テンプレートは次の3つのグループに分かれています。

  • メインテンプレート:Node、Python、Java、Go、Rust、Unity、WordPressなど、言語、フレームワーク、ツール向けのテンプレートです。
  • グローバルテンプレート:macOS、Windows、Linux、VisualStudioCode、JetBrains、Vimなど、エディター、オペレーティングシステム、その他のツール向けのテンプレートです。プロジェクトの.gitignoreだけでなく、Gitがすべてのリポジトリに適用できるグローバルな.gitignoreにも使用できます。
  • コミュニティテンプレート:JavaScript/VueやPython/JupyterNotebooksなど、より専門的なフレームワークやツール向けのテンプレートです。コミュニティによって管理されています。

使い方

  1. 人気のプロジェクトタイプ向けのクイック選択から始めます。選択したスタックのテンプレートに加えて、macOS、Windows、および通常使用されるエディターのテンプレートが選ばれます。
  2. または、「テンプレート」フィールドで検索し、プロジェクトで使用する言語、フレームワーク、エディター、オペレーティングシステムをすべて選択します。テンプレートのチェックを外すか、フィールド内でBackspaceキーを押すと、選択を解除できます。
  3. 選択するたびに.gitignoreが作成されます。各テンプレートは、それぞれ見出しコメントの下に、選択した順番で追加されます。
  4. コピーするか、ダウンロードしてリポジトリのルートフォルダーに.gitignoreとして保存します。ブラウザーは名前がドットで始まるファイルを保存しないため、ダウンロードしたファイル名はgitignore.txtまたはgitignoreになります。.gitignoreに変更してください。

ヒント

  • NodeとNextjsのように、複数のテンプレートで同じパターン(例:node_modules/)が使われることがあります。パターンが重複しても問題ありません。
  • パターンを指定しても、Gitがすでに追跡しているファイルの追跡は解除されません。ファイルをディスク上に残したまま追跡をやめるには、git rm --cachedに続けてファイルのパスを指定して実行し、その後コミットしてください。
  • !で始まる行は、先行するパターンで無視されたファイルを再び対象にします。VisualStudioCodeテンプレートでは、.vscode/settings.jsonのような共有設定をリポジトリに含めるために、この指定を使用しています。

機能

  • GitHub公式の.gitignoreテンプレートを毎日更新
  • 言語、フレームワーク、エディター、オペレーティングシステムをまとめて検索できるリスト
  • 人気のプロジェクトタイプ向けのクイック選択
  • 各テンプレートを個別の見出しの下に表示
  • ファイルのコピーまたはダウンロード