nasa9084
· 2 min read

git ignoreコマンドで.gitignoreを取得する

git ignoreコマンドで.gitignoreを取得する

割とみんな知ってるのかもしれないですが。

git-xxxという名称で実行可能ファイルをパスの通ったところに配置すると、git xxxというgitのサブコマンドの形で実行することができるようになります。これを利用したのが拙作git-licenseで、git license [option] license_name > LICENSEの形で実行するとLICENSEファイルを簡単に作成することができます。
その他、git configでエイリアスを指定して、サブコマンドとして登録することも可能です。

同様にして、git ignoreで`.gitignoreファイルを簡単に取得できるようにしてみましょう。

おそらく現代では多くの人が.gitignoreの生成やテンプレート化をして、あるいはテンプレート化されたものを利用しているのではないでしょうか。GitHubのWUI上でリポジトリを作成するときにも生成することができますし、そのさい使用される.gitignoreファイルとしてgithub/gitignoreが提供されています。

今回紹介するのはgitignore.ioというサービスです。

gitignore.io

gitignore.ioはその名の通り、.gitignoreファイルを生成するサービスです。
基本的な使い方は非常に簡単で、ブラウザでアクセスして、テキストボックスに必要な言語、OS、エディタやIDEなどを指定していくだけです。指定が終わったらCreateボタンを押すことで、選択した対象用の.gitignoreテンプレートを全て含んだ.gitignoreファイルが作成されます。これを保存すれば良いですね。

しかし、その他の作業をコマンドラインから行なっていると、いちいちブラウザでアクセスして、マウスで操作して・・・というのが非常に面倒に感じます。

大丈夫です!gitignore.ioではもちろんAPIを提供しています(というか、WUIで生成された.gitignoreのURLがそのままAPIのURL)。
次のように実行してみます。

$ curl https://www.gitignore.io/api/go,emacs,macos

https://www.gitignore.io/api/の後ろに、カンマ区切りで必要なものを列挙して行くだけで、簡単にコマンドラインから.gitignoreファイルを取得できます。

ここまでやったらもう少し簡単にしたいですね?いちいちURLを打つのは面倒ですし、忘れてしまうかもしれません。せっかくなのでgitのサブコマンドとしてgit ignoreとできるようにしてみましょう。次のコマンドを実行してみます。

$ git config --global alias.ignore '!gi() { curl -L -s https://www.gitignore.io/api/$@ ;}; gi'

もしくは、~/.gitconfigファイルの[alias]のセクションに次のように設定しても良いでしょう。

[alias]
ignore = !curl -L -s https://www.gitignore.io/api/$@

$@は引数をそのまま渡すという変数です。このように設定をすることで、git ignoreとしてgitignore.ioのAPIを利用することができるようになります。実際に使用する時は次のように使用します。

$ git ignore go,emacs,macos

言語や環境のリストは全てまとめて一つの引数のため、カンマの後にスペースを入れないことに注意です。指定できる環境の一覧はgit ignore listとすることで表示できます。

標準出力をそのままリダイレクトして、.gitignoreファイルに書き込めばプロジェクトの初期設定として使用できるでしょう。