gitignore の生成は gitignore.io と zshrc で効率化する

はじめに

どのプロジェクトでも gitignore を追加して Git 管理しない方法はみなさんご存知だと思います。ですが、この gitignore を毎回作るのも面倒になってきました。

この際に gitignore.io を活用して自動でテンプレートを作成してもらいましょう。

gitignore.io とは

gitignore.io とは gitignore を自動生成してくれる便利なWebサービスです。

www.gitignore.io

作成する際には、検索バーのところにOS、IDE、言語などを入力します。
Android開発の場合は、Android や AndroidStudio や Kotlin などが該当します。

これを入力して Create ボタンを押すと、以下のような gitignore が生成されます。
これをプロジェクトの gitignore にコピペして使いましょう。

コピペすらしたくない

わがまななみなさん安心してください。
curl コマンドで gitignoreテンプレートを取得てきて gitignore を生成できます。

$ curl https://www.gitignore.io/api/android,kotlin > .gitignore

curlすらしたくない

どんなけ楽したいんですか。
では .zshrc に以下のスクリプトを作りましょう。

# Git .gitignore create script
gitignore() {
    # arguments
    if [ -z $1 ]; then
        echo 'Usage: git_ignore arg1 arg2 arg3 ...'
        return
    fi

    # overwrite
    flag='y'
    if [ -e '.gitignore' ]; then
        printf 'Do you overwrite .gitignore ? [y/N]: '
        read flag;
    fi

    # download
    if [ $flag = 'y' ]; then
        s=$(echo $@ | tr ' ' ',')
        curl -f https://gitignore.io/api/$s -o .gitignore
        echo "gitignore file is created for: ${s}"
    fi
    echo 'finish'
}

.zshrc を再読み込みしておきます。

$ source ~/.zshrc

作成したスクリプトを使って生成できるようになります。

$ gitignore android kotlin