【2022年版】.gitignoreの書き方を6パターン紹介

.gitignoreを使ってgitに含めないファイルを設定する

gitで管理しているプロジェクトでログファイルやキャッシュに関するフォルダなど、Gitのリポジトリに含めたくないリソースがあると思います。 それらは.gitignoreを設定することでgitで管理する対象から外すことができます。

.gitignoreの書き方

基本的な書き方

.gitignoreで管理したいディレクトリの直下に.gitignoreという名前のファイルを作ります。

例えばプロジェクト全体で設定したい場合は、ルートディレクトリ内に配置します。 .gitignoreは複数の場所に作れます。深い階層の.gitignoreが優先されます。

作成した.gitignoreファイル内に、除外したいファイル名を書いていきます。

例えばこんな感じです。

*.log
.cache
.DS_Store
src/.temp
node_modules
dist
.env
.env.*

ディレクトリ名や正規表現なんかも使えます。 以下、詳しい書き方を解説します。

コメント

コメントは#で表現されます。 コメントとして書きたい文章の前に# を書くことでコメントとして認識されます。

# ここにかかれた文章はコメントです。

ファイル

特定のファイルを除外したい場合はファイル名を書きます。 例えばtest.mdというファイルをgitの管理から外したい場合は、以下のようにファイル名を書きます。

test.md

ディレクトリ

特定のディレクトリを除外したい場合はディレクトリのパスを書きます。 例えばaaaの配下にあるディレクトリを含む全てのファイルとディレクトリをgitの管理から外したい場合はaaa/と書きます。

aaa/bbb/と書くとaaaの中のbbbに入っているファイルとディレクトリを除外します。

aaa/

aaa/bbb/

特定の拡張子

特定の拡張子のファイル全てを除外したい場合は*.[拡張子]の形式で書きます。

例えばマークダウンファイルを表す.mdファイル全てをgitで管理したくない場合は下のように書きます。

*.md

特定のパターンを除外しない

特定のバターンを除外したくない場合は![パターン]の形式で書きます。

以下は、.md拡張子のファイルば除外するけど、test.mdだけは除外しない.gitignoreです。

*.md
!test.md

注意事項

既にgitに含めてしまったファイルは後から.gitignoreで指定して除外しようとしてもきできません。

テンプレート

GitHub公式に各言語やIDEごとのテンプレートがあるので便利です。

github/gitignore | GitHub