.gitignoreに含めた方がいいファイル・フォルダが一覧でまとまっている「gitignore.io」
Gitを使っていると、ファイル変更の管理には含めたくないファイルが出てきます。
よくある例でいくと、下記のようなファイル・フォルダです。
- Node.jsの
node_modules
フォルダ- 中のフォルダ数が大量で、数千ファイルをGit上で管理することになってしまう
package.json
を共有して、npm install
をすれば全員同じnode_modules
が生成されるので管理する必要がない
- ビルド後の
dist
フォルダ- 管理してしまうと、余計なコンフリクトの原因になってしまう
- ビルドすれば同じ結果になるので、管理する必要がない
こうしたファイル変更の管理に含めたくないファイル・フォルダは.gitignore
というファイルに入力しておくと、無視するようになってくれます。
サイトから利用する
gitignore.ioにアクセスすると、ページ中央に検索ボックスがあるので、ここに言語やフレームワークなどのキーワードを入力して「作成する(Generate)」ボタンを押せば、そのプロジェクトで.gitignore
に入れておいた方がいいファイルがリストアップされます。
あとはコピペで.gitignore
に追加すればOKです。
ターミナルから利用する
コマンドラインツールが用意されているので、インストールすればターミナルでコマンドを入力してそのまま.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
は生成されない)。
ちなみに、入力できるキーワードの一覧を見たい場合はlist
を使用します。
gi list
これですべてのキーワードが表示されます。
gitignore.ioは「とりあえずこれを設定しておけばOK」という設定をすぐ生成できるので、はじめてのプロジェクトにはもってこいです。
また、なんの言語・フレームワークを使うときにどんな設定をしていたか、わざわざ覚えておく必要や抜け漏れの心配もなくなります。
逆に毎回同じ設定しか使わない人は、ずっと流用で済むので出番は少なそうですが……