はじめに

Gitをインストールした際に、毎回設定している事をまとめました。
すべて必要というわけではないので、各自お好みで設定してみてください。

設定一覧

ユーザー名とメールアドレスの設定

まずはお馴染みの設定から。
コミットログとして表示されるユーザー名とメールアドレスを設定します。

git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

適当な名前やメールアドレスでも登録できますが、基本的にはgithubなどに登録している情報と合わせるようにしましょう。

デフォルトのエディタの設定

コミットする際などに表示されるエディタを変更します。

git config --global core.editor vim
git config --global sequence.editor vim

このvimの部分には他に、emacs, nano, 'code --wait', hx, microなどが指定できます。
※'code --wait'はVSCodeの事です。末尾の--waitオプションを指定するとファイルを閉じるまで待機させることが出来ます。

デフォルトのブランチ名の変更

デフォルトで作成されるブランチmainに変更します。

git config --global init.defaultBranch main

git initを実行した際に自動的にmasterブランチが作成されてますが、現在はmainを使うことが多く、毎回ブランチを削除するのは面倒ですよね。

※Gitのバージョンが 2.28.0より前の場合、この機能は利用できません。

改行コードの設定

改行コードを自動的に変換するようにします。

# Mac及びLinuxの場合 (LF)
git config --global core.autocrlf input

# Windowsの場合 (CRLF)
git config --global core.autocrlf true

チームで開発している場合、OSがmacの人もいればWindowsの人もいます。
そうした場合に改行コードの問題はつきものですが、自動変換をオンにすることで、意識することなく進められます。
チーム全員がWindowsの場合はfalseと指定しても問題ありません。

コミットメッセージにテンプレートを設定

毎回お決まりで入力しているメッセージがある場合、テンプレートを利用することで、git commitを実行した際にテンプレートを呼び出すことが出来ます。

git config --global commit.template ~/.config/git/.gitmessage
echo 'テンプレート化したいメッセージ' > ~/.config/git/.gitmessage

# プロジェクト毎に指定したい場合
git config --local commit.template .gitmessage
echo 'テンプレート化したいメッセージ' > .gitmessage

チーム開発などで、コミットメッセージのフォーマットを徹底したい場合に便利です。

グローバルな.gitignoreの設定

.gitignoreをグローバルに設定します。
デフォルトでは~/.config/git/ignoreの内容が反映されます。

~/.config/git/ignore

*~
.DS_Store

*~はExcelなどのロックファイル、.DS_StoreはMacお馴染みのファイルです。

任意のファイルを指定したい場合は以下のように指定出来ます。

git config --global core.excludesfile ~/.gitignore

基本的にはプロジェクト毎に管理することが多い為、利用している人は少ない印象です。

コマンドのタイプミス時にいい感じに実行してくれるように設定

コマンドの綴りミスがあった際にGitは正しいコマンドを提案してくれますが、実行までしてくれるようになります。
ミスタイプから実行までの感覚を0.1秒単位で指定します。

git config --global help.autocorrect 1

私はよくcheckoutをミスタイプすることが多いです。

参考