10+ things I always setup in git when I prepare a new environment

Shinji NAKAMATSU - Jul 29 '22 - - Dev Community

When you buy a car or a bicycle, you first adjust the seat position and saddle height to suit your body size. It is the same with git configuration.

In this article, I will share the git setup I use all the time.

User name & Mail address

git config --global user.name "<name>" && \
git config --global user.email "<email>"
Enter fullscreen mode Exit fullscreen mode
  • Replace <name> with my name and <email> with my mail address.

Alias for existing command

git config --global alias.co checkout
git config --global alias.st status
git config --global alias.br branch
Enter fullscreen mode Exit fullscreen mode

Global ignore setting

git config --global core.excludesfile ~/.gitignore_global
Enter fullscreen mode Exit fullscreen mode
  • This allows you to put your own specific ignore settings in ~/.gitignore_global in addition to the .gitignore for each project, which will be applied to all git operations across all projects.

Push only the branch you are now working on

git config --global push.default simple
Enter fullscreen mode Exit fullscreen mode

Make --rebase the default behavior during git pull

git config --global pull.rebase true
Enter fullscreen mode Exit fullscreen mode
  • This prevents unintentional creation of a merge commit if the branch being pulled has been modified locally.

Make --prune the default behavior during git fetch

git config --global fetch.prune true
Enter fullscreen mode Exit fullscreen mode
  • This will remove local branches that were deleted remotely when git fetch or git pull was performed.

Set the width of indentation for tab characters

git config --global core.pager 'less -x4'
Enter fullscreen mode Exit fullscreen mode
  • In this example, the pager (less command) option specifies tab indent width as 4

Use nvim as the editor to be used when committing

git config --global core.editor 'nvim'
Enter fullscreen mode Exit fullscreen mode
  • I use several different text editors for different purposes, but I prefer to use nvim with git commit.

Do not fast-forward when merging

git config --global --add merge.ff false
git config --global --add pull.ff only
Enter fullscreen mode Exit fullscreen mode
  • Fast-forward merging makes it difficult to follow the history of work on a branch. Therefore, avoid unintentional fast-forwards when merging.
  • However, fast-forwarding is not a problem for git pull cases in most cases 1, so we enforce fast-forwarding in the case of pulls.
  • See also: gitのmerge --no-ff のススメ - Qiita

Output line numbers in the result of git grep

git config --global grep.lineNumber true
Enter fullscreen mode Exit fullscreen mode

Visualize differences in whitespace (including newline codes)

git config diff.wsErrorHighlight all
Enter fullscreen mode Exit fullscreen mode

EDIT: 2022-07-31

dotfile

As mentioned in the comments, these are stored in .gitconfig. And I have added these settings to the dotfiles repository.

https://github.com/snaka/my-dotfiles/blob/master/.gitconfig

Thanks to all who commented.


See also


  1. In my experience, this happens when you are temporarily changing code while reviewing a PullRequest created by someone else in your local environment. In that case, fast-forward is better because local changes are gathered at the top of the history, making it easier to work with when you finally undo the changes. 

. . . . . . . . . . .
Terabox Video Player