記事の要約
.gitignore のテンプレートが欲しい時
- github/gitignore (GitHub) を参照する
- gitignore.io で生成する
この記事に書いてあること
-
.gitignoreのテンプレートをまとめているサイトの紹介
この記事に書いてないこと
-
Gitや.gitignoreとは何か -
.gitignoreの書き方、設定方法
きっかけ
先日、慣れない環境で開発する機会があり、
「一時ファイルがたくさんある。.gitignoreには何を書けばよいのだろう？」
と悩んだことがありました。
ここでは、その際に知った便利なサイトを紹介します。
github/gitignore
GitHubの公式リポジトリです。
主要な環境の.gitignoreが揃っているので、マイナーな環境でなければ目当てのものが見つかると思います。
GitHubの公式リポジトリで、Starの数や更新頻度も文句なし。
安心して参照できる印象でした。
使い方
必要なファイルを探して、規定の場所に配置していきます。
なお、ここでは配置先については解説しません。
gitignoreやgitignore globalなどで検索してみてください。
例1: macOSでNode.jsを使用した開発をする場合
- global用の.gitignore
- リポジトリ用の.gitignore
例2: Linux、VimでC言語の開発をする場合
- global用の.gitignore (2ファイルを手動でマージしてから配置する)
- リポジトリ用の.gitignore
gitignore.io
続いてgitignore.ioの紹介です。
gitignore.io
指定した環境に合わせた.gitignoreを自動生成してくれるサービスです。
複数のOS、エディタ、言語などの設定を一つのファイルに自動でまとめてくれます。
ドキュメント
使い方はドキュメント内のVideo tutorialを見てもらうのが一番早いと思います。
また、Webから生成する方法の他、コマンドやAPIによって生成する方法も用意されています。
提供されているテンプレート
仕組みの解説やテンプレート一覧は以下にあります。
toptal/gitignore (GitHub)
The source for some of the template files on dvcs/gitignore come from github/gitignore
とREADMEにあるので、いくつかのファイルは前述のGitHub公式のgitignoreを参照しているようです。
(恐らくREADMEの更新がされてなく、以前のリポジトリ名はdvcs/gitignoreで、その後toptal/gitignoreに変更された模様)
所感
頻繁には使用しませんが、時々必要になってくるサイトと思いました。
.gitignore に悩むことなくメインの開発に専念できるのが嬉しかったです。