# .gitignoreに含めた方がいいファイル・フォルダが一覧でまとまっている「gitignore.io」

URL: https://webrandum.net/gitignore-io/
公開日: 2022-02-12
更新日: 2022-02-12
カテゴリー: コーディング
タグ: Git
出典: Webrandum（著者: サイトウ マサカズ）

Gitを使っていると、ファイル変更の管理には含めたくないファイルが出てきます。

よくある例でいくと、下記のようなファイル・フォルダです。

- Node.jsの`node_modules`フォルダ 中のフォルダ数が大量で、数千ファイルをGit上で管理することになってしまう

- `package.json`を共有して、`npm install`をすれば全員同じ`node_modules`が生成されるので管理する必要がない

- ビルド後の`dist`フォルダ 管理してしまうと、余計なコンフリクトの原因になってしまう

- ビルドすれば同じ結果になるので、管理する必要がない

こうしたファイル変更の管理に含めたくないファイル・フォルダは`.gitignore`というファイルに入力しておくと、無視するようになってくれます。

## サイトから利用する

![gitignore.io](https://webrandum.net/mskz/wp-content/uploads/2019/08/image_1-28.png)

[![](https://www.google.com/s2/favicons?domain=www.toptal.com)www.toptal.com![](//webrandum.net/mskz/wp-content/uploads/pz-linkcard/cache/4b4a6807b5f9d9f57997f03d6c91a104bf00cf5486c8823effcacc4654ece2ac.webp)gitignore.iohttps://www.toptal.com/developers/gitignoreCreate useful .gitignore files for your project](https://www.toptal.com/developers/gitignore)

[gitignore.io](https://www.toptal.com/developers/gitignore)にアクセスすると、ページ中央に検索ボックスがあるので、ここに言語やフレームワークなどのキーワードを入力して「作成する（Generate）」ボタンを押せば、そのプロジェクトで`.gitignore`に入れておいた方がいいファイルがリストアップされます。

![.gitignoreの結果](https://webrandum.net/mskz/wp-content/uploads/2019/08/image_2-23.png)

あとはコピペで`.gitignore`に追加すればOKです。

## ターミナルから利用する

[![](https://www.google.com/s2/favicons?domain=docs.gitignore.io)docs.gitignore.io![](//webrandum.net/mskz/wp-content/uploads/pz-linkcard/cache/6027f103f0b0d37e80b7a5382331f6c1ae7ba4c2f0c2acf3dbaee999232e1018.webp)Command Linehttps://docs.gitignore.io/install/command-lineTo run gitignore.io from your command line you need an active internet connection and an environment function. You need to add a function to your environment that lets you access the gitignore.io API.](https://docs.gitignore.io/install/command-line)

コマンドラインツールが用意されているので、インストールすればターミナルでコマンドを入力してそのまま`.gitignore`を生成してくれたりもします。

ドキュメントページを見てコマンドを実行すればインストールできます。

例えば、macOSのZshの場合は下記コマンドを実行するだけです。

```
echo "function gi() { curl -sLw "\n" https://www.toptal.com/developers/gitignore/api/\$@ ;}" >> \
~/.zshrc && source ~/.zshrc
```

これで、ターミナル上で「`gi`」コマンドが使えるようになります。

使い方は追加したいディレクトリに移動して、`gi`の後にキーワードを入力して、最後に「`>> .gitignore`」を入力するだけです。

（複数キーワードの場合は,（カンマ）で区切る）

```
gi Vue,Nuxtjs >> .gitignore
```

ちなみにgi Vue,Nuxtjsだけだと、ターミナル上に`.gitignore`に追加した方がいいファイルがリストアップされるだけです（ブラウザでの表示と同じで、`.gitignore`は生成されない）。

![「>> .gitignore」を入力しなかった場合の結果](https://webrandum.net/mskz/wp-content/uploads/2019/08/image_3-20.png)

ちなみに、入力できるキーワードの一覧を見たい場合は`list`を使用します。

```
gi list
```

![gi listの結果](https://webrandum.net/mskz/wp-content/uploads/2019/08/image_4-10.png)

これですべてのキーワードが表示されます。

gitignore.ioは「とりあえずこれを設定しておけばOK」という設定をすぐ生成できるので、はじめてのプロジェクトにはもってこいです。

また、なんの言語・フレームワークを使うときにどんな設定をしていたか、わざわざ覚えておく必要や抜け漏れの心配もなくなります。

逆に毎回同じ設定しか使わない人は、ずっと流用で済むので出番は少なそうですが……