Gitの.gitignoreのテンプレートを自動生成する方法

Gitでバージョン管理する際に管理対象外を指定する.gitignoreを自動生成する方法について紹介します。

Contents

.gitignoreとは

バージョン管理ソフトウェアであるGitでは、バージョン管理対象外とするファイルを指定することができます。この対象外のファイルを指定する特殊なファイルが「.gitignore」ファイルです。

.gitignoreは自分で書いてもよいのですが、プログラミング言語ごとに含めたくないファイルというのはおおむね決まっていてテンプレートも存在しています。GitHubのこちらにも様々な.gitignoreが公開されています。

上記リンク先のファイルをコピペして作ってもいいのですが、自動で生成してくれる方が便利です。本記事では.gitignoreのテンプレートを自動で生成する方法について紹介します。

.gitignoreのテンプレートを自動で生成する方法として以下の２種類を紹介したいと思います。

GitHubでプロジェクトを生成する際には以下のような「Add .gitignore」という項目が存在し、プルダウンから各言語を選択することができます。以下の例ではPythonを選択した例になります。

上記の設定で「Create repository」によりリポジトリを作成すると以下のように.gitignoreファイルが自動で生成されます。

GitHubでプロジェクトを作った後は、ローカルにクローンして開発を進めることができます。

VSCodeをプログラム開発で使用している人であれば、「gitignore」という拡張機能を使用することで.gitignoreを生成することが可能です。

gitignore拡張機能は以下の手順でインストールしてください。似たような拡張が出てきますが本記事では「CodeZombie」の拡張機能に関して紹介します。

gitignoreをインストールすると「Add gitignore」というコマンドが使用できるようになります。

「Ctrl + Shift + P」またはF1でコマンドパレットを表示して、以下のように「Add gitignore」と入力してEnterを押してください。すると色々な.gitignoreの一覧が表示されますので、対象とする言語を選んでください。以下の例ではPythonを選択した場合です。

「Add gitignore」を実行すると、自動的に以下のように.gitignoreファイルを作成してくれます。

Gitでバージョン管理する際に管理対象外を指定する.gitignoreを自動生成する方法について紹介しました。方法としては以下の２種類を紹介しています。

.gitignoreは自分でゼロから作るのは大変ですので、自動生成を使って作成した後、カスタマイズしていくとよいかなと思います。