.gitignore の書き方

.gitignore とは？

• Git の管理に含めないファイルを指定するためのファイル。

設定方法

• 無視設定を行いたいフォルダに .gitignore という名前でテキストファイルを作成する。
  • Windows 標準のメモ帳など一部のエディタでは、拡張子のみのファイルは生成できないので、どちらかの手順で作成する
    • 拡張子のみのファイルを作れるエディタを利用する
    • 既にあるファイルをコピーしてくる
  • MAC は標準の設定では、拡張子のみのファイルは Finder 上に表示されません。
• 無視したいファイルを下のパターンをもとに .gitignore 内で指定する。
• 設定の有効範囲は .gitignore ファイルの有るフォルダ内全部。
• リポジトリのルートにある必要はなく、リポジトリ内に複数あってもよい。

パターン

コメント

# "#" で始まる行はコメント

特定の拡張子を無視する

# exe ファイルは要らない
*.exe

特定のフォルダの中身全てを無視する

# bin フォルダは要らない
bin/

特定のパターンを無視しない

# nuget.exe は必用なファイル
!/.nuget/nuget.exe

フォルダ内の特定拡張子を無視

# パッケージフォルダ内の .ts ファイルは要らない
package/**/*.ts

フォルダそのものを残したい場合

• Git はファイルを管理しているだけなので、空のディレクトリのディレクトリ構造を保存できない。
• 残しておきたいフォルダの中に .gitkeep というファイル名で空のファイルを作成すしてディレクトリを残す方法がある。
  • このファイル名は何でもいい

参考資料

• github / gitignore