💽 Git

Personal Git config files

~/.gitconfig ~/.gitignore_global ~/.gitattributes ~/setup-code-review.sh

[user]
    name = Simon Marquis
    email = contact@simon-marquis.fr

[branch]
    autosetuprebase = always

[alias]
    # List aliases
    aliases = !git config --global -l | grep alias | sort;
    # List repository authors by number of contributions
    authors = !git log --pretty=format:%aN | sort | uniq -c | sort -rn
    # List all branches
    branches = branch --all
    # Switch branch with fzf
    cb = !git branch --all | grep -v '^[*+]' | awk '{print $1}' | fzf -0 --border --reverse --preview 'git show --color=always {-1}' | sed 's/remotes\\/origin\\///g' | xargs --no-run-if-empty git checkout
    # Print changelog between two references
    changelog = "!f() { git log --topo-order --pretty=format:\"%h ~ %s\" \"$1..${2:-HEAD}\" --no-merges; }; f"
    # Delete branches with fzf
    db = !git branch | grep -v '^[*+]' | awk '{print $1}' | fzf -0 --border --reverse --multi --header '🗑️ Select one or more branches to delete:' --preview 'git show --color=always {-1}' | xargs --no-run-if-empty git branch --delete --force
    # Print stats of last commit
    last = log -1 --stat
    # Pretty-print log
    lg = log --all --graph --pretty=format:"%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %Cblue<%an>%Creset" --abbrev-commit --date=relative
    # Utils to open references on GitHub, Gerrit, BitBucket, etc.
    open = "!f() {\n local type=\"${1:-branch}\"\n local target=\"${2:-HEAD}\"\n local current_upstream=\"$(git for-each-ref --format=\"%(upstream:remotename)\" \"$(git symbolic-ref -q \"$target\")\")\"\n local first_remote=\"$(git remote show | head -n 1)\"\n local remote=${current_upstream:-$first_remote}\n remote=${upstream:-origin}\n\n if [ \"$type\" = \"branch\" ] || [ \"$type\" = \"pr\" ]; then\n # get full name (i.e. refs/heads/*; refs/remotes/*/*); src: https://stackoverflow.com/a/9753364\n target=\"$(git rev-parse --symbolic-full-name \"$target\")\"\n\n if [ \"$target\" != \"${target#\"refs/remotes/\"}\" ]; then\n # extract from remote branch reference\n target=\"${target#\"refs/remotes/\"}\"\n else\n # extract from local branch reference; src: https://stackoverflow.com/a/9753364\n target=\"$(git for-each-ref --format=\"%(upstream:short)\" \"$target\")\"\n fi\n # split remote/branch\n remote=\"${target%%/*}\"\n target=\"${target#\"$remote/\"}\"\n\n if [ -z \"$remote\" ]; then\n echo \"Branch ($2) does not point to a remote repository.\" >&2\n return 2\n fi\n fi\n\n local repo_url=\"$(git remote get-url \"$remote\" | sed -E -e \"s/(\\.(com|org|io))\\:/\\1\\//\" -e \"s/git@/https:\\/\\//\" -e \"s/\\.git$//\")\"\n if [ -z \"$repo_url\" ]; then\n echo \"Cannot open: no remote repository configured under ($remote)\" >&2\n return 1\n fi\n\n case \"$(echo \"$repo_url\" | tr \"[:upper:]\" \"[:lower:]\")\" in\n *github*)\n case \"$type\" in\n \"repo\") ;;\n \"commit\") repo_url=\"$repo_url/commit/$(git rev-parse \"$target\")\" ;;\n \"pr\")  repo_url=\"$repo_url/compare/$target?quick_pull=1\" ;;\n \"tag\") repo_url=\"$repo_url/releases/tag/$target\" ;;\n \"branch\") repo_url=\"$repo_url/tree/$target\" ;;\n *) echo \"Unsupported action: $type\" >&2 ; return 1 ;;\n esac\n ;;\n *bitbucket*)\n case \"$type\" in\n \"repo\") ;;\n \"commit\") repo_url=\"$repo_url/commits/$(git rev-parse \"$target\")\" ;;\n \"pr\")  repo_url=\"$repo_url/pull-requests/new?source=$target\" ;;\n \"tag\") repo_url=\"$repo_url/src/$target\" ;;\n \"branch\") repo_url=\"$repo_url/src/$target\" ;;\n *) echo \"Unsupported action: $type\" >&2 ; return 1 ;;\n esac\n ;;\n *gitlab*)\n case \"$type\" in\n \"repo\") ;;\n \"commit\") repo_url=\"$repo_url/-/commit/$(git rev-parse \"$target\")\" ;;\n \"pr\")  repo_url=\"$repo_url/-/merge_requests/new?merge_request[source_branch]=$target\" ;;\n \"tag\") repo_url=\"$repo_url/-/tags/$target\" ;;\n \"branch\") repo_url=\"$repo_url/-/tree/$target\" ;;\n *) echo \"Unsupported action: $type\" >&2 ; return 1 ;;\n esac\n ;;\n *azure*)\n case \"$type\" in\n \"repo\") ;;\n \"commit\") repo_url=\"$repo_url/commit/$(git rev-parse \"$target\")\" ;;\n \"pr\")  repo_url=\"$repo_url/pullrequestcreate?sourceRef=$target\" ;;\n \"tag\") repo_url=\"$repo_url?version=GT$target\" ;;\n \"branch\") repo_url=\"$repo_url?version=GB$target\" ;;\n *) echo \"Unsupported action: $type\" >&2 ; return 1 ;;\n esac\n ;;\n *review*|*gerrit*)\n local gerrit_repo_url=$(git config gerrit.web-ui-url)\n if [ -z \"$gerrit_repo_url\" ]; then\n echo \"Unknown Gerrit URL: git config gerrit.web-ui-url <url>\" >&2\n return 1\n fi\n case \"$type\" in\n \"repo\") repo_url=\"$gerrit_repo_url\" ;;\n \"commit\") repo_url=\"$gerrit_repo_url/q/commit:$(git rev-parse \"$target\")\" ;;\n \"tag\") repo_url=\"$gerrit_repo_url/q/tag:$target\" ;;\n \"branch\") repo_url=\"$gerrit_repo_url/q/branch:$target\" ;;\n \"search\") repo_url=\"$gerrit_repo_url/q/$target\" ;;\n *) echo \"Unsupported action: $type\" >&2 ; return 1 ;;\n esac\n ;;\n *) echo \"Unsupported repository type: $repo_url\" >&2 ; return 1 ;;\n esac\n\n case \"$(uname -sr)\" in\n Darwin*) open \"$repo_url\" ;; # macOS\n Linux*Microsoft*) explorer.exe \"$repo_url\" ;; # WSL\n Linux*) xdg-open \"$repo_url\" ;; # Linux\n CYGWIN*|MINGW*|MINGW32*|MSYS*) powershell start $repo_url ;; # Windows\n *) echo \"Unsupported OS $(uname -sr)\" >&2 ; return 1 ;;\n esac\n\n}; f"
    # List all remotes
    remotes = remote -v
    # Bootstrap repository with an empty initial commit
    start = !git init && git commit --allow-empty -m 'Initial commit'
    # List all tags
    tags = tag -n
    # Bootstrap repository and add everything as initial commit
    this = !git init && git add --all && git commit -m 'Initial commit'
    # git rebase --onto <what-branch> <from-exclusive>@{1} <up-to-inclusive>
    rebase-onto = "!f() { git rebase --onto \"$1\" \"$1@{1}\" \"$2\"; }; f"
    # Undo last commit
    undo = reset --soft HEAD^
    # Unstage changes added to the index
    unstage = reset HEAD --
    # Prints current user
    whoami = !git config --global user.name && git config --global user.email

[commit]
    template = ~/.gitmessage

[core]
    attributesFile = ~/.gitattributes
    excludesfile = ~/.gitignore_global

[diff]
    algorithm = patience
    renameLimit = 999999

[diff "json.gz"]
    binary = true
    textconv = "!f(){ gzcat --suffix .gz \"$1\" | jq; }; f"

[filter "lfs"]
    required = true
    clean = git-lfs clean -- %f
    smudge = git-lfs smudge -- %f
    process = git-lfs filter-process

[fetch]
    prune = true

[gitreview]
    notopic = true

[init]
    defaultBranch = main

[merge]
    ff = false
    autoStash = true
    renameLimit = 999999

[pull]
    rebase = true

[push]
    default = current

[rebase]
    autoSquash = true
    autoStash = true
    updateRefs = true

[rerere]
    enabled = true

### Java / Kotlin ###
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# virtual machine crash logs
hs_err_pid*
replay_pid*

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### macOS Patch ###
# iCloud generated files
*.icloud

### Windows ###
# Windows thumbnail cache files
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
ehthumbs_vista.db

# Dump file
*.stackdump

# Folder config file
[Dd]esktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msix
*.msm
*.msp

# Windows shortcuts
*.lnk

* text=auto eol=lf

*.{bat,[bB][aA][tT]} text eol=crlf
*.{cmd,[cC][mM][dD]} text eol=crlf

*.jar binary
*.png binary
*.gif binary
*.jpg binary
*.jpeg binary

*.json.gz diff=json.gz

#!/usr/bin/env bash

git config --global alias.open '!f() {
    local type="${1:-branch}"
    local target="${2:-HEAD}"
    local current_upstream="$(git for-each-ref --format="%(upstream:remotename)" "$(git symbolic-ref -q "$target")")"
    local first_remote="$(git remote show | head -n 1)"
    local remote=${current_upstream:-$first_remote}
    remote=${upstream:-origin}

    if [ "$type" = "branch" ] || [ "$type" = "pr" ]; then
        # get full name (i.e. refs/heads/*; refs/remotes/*/*); src: https://stackoverflow.com/a/9753364
        target="$(git rev-parse --symbolic-full-name "$target")"

        if [ "$target" != "${target#"refs/remotes/"}" ]; then
            # extract from remote branch reference
            target="${target#"refs/remotes/"}"
        else
            # extract from local branch reference; src: https://stackoverflow.com/a/9753364
            target="$(git for-each-ref --format="%(upstream:short)" "$target")"
        fi
        # split remote/branch
        remote="${target%%/*}"
        target="${target#"$remote/"}"

        if [ -z "$remote" ]; then
            echo "Branch ($2) does not point to a remote repository." >&2
            return 2
        fi
    fi

    local repo_url="$(git remote get-url "$remote" | sed -E -e "s/(\.(com|org|io))\:/\1\//" -e "s/git@/https:\/\//" -e "s/\.git$//")"
    if [ -z "$repo_url" ]; then
        echo "Cannot open: no remote repository configured under ($remote)" >&2
        return 1
    fi

    case "$(echo "$repo_url" | tr "[:upper:]" "[:lower:]")" in
        *github*)
            case "$type" in
                "repo") ;;
                "commit") repo_url="$repo_url/commit/$(git rev-parse "$target")" ;;
                "pr")     repo_url="$repo_url/compare/$target?quick_pull=1" ;;
                "tag")    repo_url="$repo_url/releases/tag/$target" ;;
                "branch") repo_url="$repo_url/tree/$target" ;;
                *) echo "Unsupported action: $type" >&2 ; return 1 ;;
            esac
            ;;
        *bitbucket*)
            case "$type" in
                "repo") ;;
                "commit") repo_url="$repo_url/commits/$(git rev-parse "$target")" ;;
                "pr")     repo_url="$repo_url/pull-requests/new?source=$target" ;;
                "tag")    repo_url="$repo_url/src/$target" ;;
                "branch") repo_url="$repo_url/src/$target" ;;
                *) echo "Unsupported action: $type" >&2 ; return 1 ;;
            esac
            ;;
        *gitlab*)
            case "$type" in
                "repo") ;;
                "commit") repo_url="$repo_url/-/commit/$(git rev-parse "$target")" ;;
                "pr")     repo_url="$repo_url/-/merge_requests/new?merge_request[source_branch]=$target" ;;
                "tag")    repo_url="$repo_url/-/tags/$target" ;;
                "branch") repo_url="$repo_url/-/tree/$target" ;;
                *) echo "Unsupported action: $type" >&2 ; return 1 ;;
            esac
            ;;
        *azure*)
            case "$type" in
                "repo") ;;
                "commit") repo_url="$repo_url/commit/$(git rev-parse "$target")" ;;
                "pr")     repo_url="$repo_url/pullrequestcreate?sourceRef=$target" ;;
                "tag")    repo_url="$repo_url?version=GT$target" ;;
                "branch") repo_url="$repo_url?version=GB$target" ;;
                *) echo "Unsupported action: $type" >&2 ; return 1 ;;
            esac
            ;;
        *review*|*gerrit*)
            local gerrit_repo_url=$(git config gerrit.web-ui-url)
            if [ -z "$gerrit_repo_url" ]; then
                echo "Unknown Gerrit URL: git config gerrit.web-ui-url <url>" >&2
                return 1
            fi
            case "$type" in
                "repo")   repo_url="$gerrit_repo_url" ;;
                "commit") repo_url="$gerrit_repo_url/q/commit:$(git rev-parse "$target")" ;;
                "tag")    repo_url="$gerrit_repo_url/q/tag:$target" ;;
                "branch") repo_url="$gerrit_repo_url/q/branch:$target" ;;
                "search") repo_url="$gerrit_repo_url/q/$target" ;;
                *) echo "Unsupported action: $type" >&2 ; return 1 ;;
            esac
            ;;
        *) echo "Unsupported repository type: $repo_url" >&2 ; return 1 ;;
    esac

    case "$(uname -sr)" in
        Darwin*)                       open "$repo_url" ;;           # macOS
        Linux*Microsoft*)              explorer.exe "$repo_url" ;;   # WSL
        Linux*)                        xdg-open "$repo_url" ;;       # Linux
        CYGWIN*|MINGW*|MINGW32*|MSYS*) powershell start $repo_url ;; # Windows
        *) echo "Unsupported OS $(uname -sr)" >&2 ; return 1 ;;
    esac

}; f'

Alias to function

~/.gitconfig

[alias]
    hello = "!f() { echo \"Hello, ${1:-World}!\" ; }; f"

Authors with commit count

~/.gitconfig

[alias]
    authors = !git log --pretty=format:%aN | sort | uniq -c | sort -rn

Change author without changing dates

git -c rebase.instructionFormat='%s%nexec GIT_COMMITTER_DATE="%cD" git commit --amend --author=<author> --no-edit' rebase -i <refspec>

Check if something can be pushed

git log <sha1>..HEAD [--oneline] --exit-code # 1:yes, 0:no

Check if something has changed

git diff [--cached] [--stat] [--quiet] --exit-code -- [<pathspec>…] # 1:yes, 0:no

or

git diff-index [--cached] [--stat] [--quiet] --exit-code HEAD # 1:yes, 0:no

Commit ranges

A─┬─B──C (main)
  ╰─D──E (dev)

• git log
  • main dev: A B C D E
    Reachable from main or dev.
  • main..dev or ^main dev or dev --not main: D E
    Reachable from dev but not from main.
  • main...dev: B C D E
    Reachable from either main or dev, but not both.
• git diff
  • main..dev or main dev: -B -C +D +E
  • main...dev: +D +E

Commit with message from standard input

( \
  echo -e "Hello, World!" ; \
  any-command-that-will-produce-text-output ; \
) | git commit --file -

Default commit message

git config --global commit.template ~/.gitmessage

Delete branches with fzf

git branch |
  grep -v '^[*+]' `: # ignore current branch` |
  awk '{print $1}' `: # trim` |
  fzf -0 --border --reverse --multi \
    --header '🗑️ Select one or more branches to delete:' \
    --preview 'git show --color=always {-1}' |
  xargs --no-run-if-empty git branch --delete --force

Diffing Gzip-ed JSON files

~/.gitattributes

*.json.gz diff=json.gz

~/.gitconfig

[core]
    attributesFile = ~/.gitattributes
[diff "json.gz"]
    binary = true
    textconv = "f() { uncompress -c \"$1\" | jq ; }; f"
    # OR # textconv = sh -c 'uncompress -c "$0" | jq'
    # OR with: zcat, gzcat, etc.

• Before

  diff --git a/example.json.gz b/example.json.gz
  index 4ecec5e..ae04c42 100644
  Binary files a/example.json.gz and b/example.json.gz differ
  

• After

  diff --git a/example.json.gz b/example.json.gz
  index 4ecec5e..ae04c42 100644
  --- a/example.json.gz
  +++ b/example.json.gz
  @@ -1,3 +1,3 @@
   {
  -  "key": true
  +  "key": false
   }
  

🔗

Diffing with patience

~/.gitconfig

[diff]
    # git config --global diff.algorithm patience
    algorithm = patience

Enable diffing of untracked files

git add --intent-to-add [--] [<pathspec>…]

Executable file permission on Windows

git add --chmod=+x -- <file>

or

git update-index --chmod=+x <file>

Ignoring commits in the blame view

.git-blame-ignore-revs

# Reformat code
44e8ca9a329dbb7a673b55cd25fbe982f10572fa
# Add newline at end of files
2f5f618ff431f87687e7446f0980849a88d01d9a

• Manually

  git blame --ignore-revs-file .git-blame-ignore-revs <file>
  

• Automatically

  # Ignore revisions listed in the file, one unabbreviated object name per line.
  git config --global blame.ignoreRevsFile .git-blame-ignore-revs
  # Mark any lines that have had a commit skipped using --ignore-rev with a `?`
  git config --global blame.markIgnoredLines true
  # Mark any lines that were added in a skipped commit and can not be attributed with a `*`
  git config --global blame.markUnblamableLines true
  

🔗

Install git hooks

install --verbose --mode=755 --target-directory='.git/hooks' .githooks/*

'.githooks/pre-commit' -> '.git/hooks/pre-commit'
'.githooks/pre-push' -> '.git/hooks/pre-push'
'.githooks/pre-rebase' -> '.git/hooks/pre-rebase'

LFS total size

Linux macOS

git lfs ls-files --debug \
  | awk -F: '$1~/size/ {t+=$2} END {print t}' \
  | numfmt --to=iec-i --suffix B

git lfs ls-files --debug \
  | awk -F: '$1~/size/ {t+=$2} END {print t}' \
  | gnumfmt --to=iec-i --suffix B

-d --debug:
  Show as much information as possible about a LFS file. This is intended
  for manual inspection; the exact format may change at any time.

List LFS files by size

git lfs ls-files --long --size \
  | tr -d '()' \
  | awk '{print $4 $5 " " $3 " " $1}' \
  | sort --key 1 --human-numeric-sort --reverse

List objects by size

git rev-list --objects --all |
  git cat-file --batch-check='%(objecttype) %(objectname) %(objectsize) %(rest)' |
  sed -n 's/^blob //p' |
  sort --numeric-sort --key=2 |
  cut -c 1-12,41- |
  $(command -v gnumfmt || echo numfmt) --field=2 --to=iec-i --suffix=B --padding=7 --round=nearest

🔗

Most changed files

• Paths

  git rev-list --objects --all | awk '$2' | sort -k2 | uniq -cf1 | sort -rn | head
  

• Blobs

  git rev-list --objects --all | awk '$2' | sort -k2 | uniq -cf1 | sort -rn |
      while read frequency sample file
      do 
         [[ "blob" == "$(git cat-file -t $sample)" ]] && echo -e "$frequency\t$file";
      done | head
  

🔗

Most insertions and deletions

git log --format=format:"%h %s" --shortstat \
  | perl -00 -ne '
      my ($hash, $subject, $files, $insertions, $deletions) = $_ =~ /(?:[0-9a-f]+\n)*([0-9a-f]+)(?: ?(.*))\n(?: (\d+) files? changed,)?(?: (\d+) insertions?...,?)?(?: (\d+) deletions?...)?/g;
      printf "%s\t%d\t+%d\t-%d\t%s\n", $hash, $insertions + $deletions, $insertions, $deletions, $subject;
    ' \
  | sort -k 2 -nr \
  | head

Override URLs or protocols

git config --global url."https://github".insteadOf "git://github"

🔗

Pathspec magic signatures

• :(top) (magic signature: /) makes the pattern match from the root of the working tree, even when you are running the command from inside a subdirectory.

  git ls-files ':(top)*.kt'
  git ls-files ':/*.kt' # magic
  

• :(literal) Wildcards in the pattern such as * or ? are treated as literal characters.

  git log ':(literal)*.kt' # log for the file '*.kt'
  

• :(icase) Case insensitive match.

  git ls-files ':(icase)*.kt'
  

• :(glob) Git treats the pattern as a shell glob suitable for consumption by fnmatch(3).

  git ls-files ':(glob)src/main/*/*.kt' # 'top level' .kt files
  git ls-files ':(glob)src/**/*.kt'     # 'all' .kt files
  

• :(attr) After attr comes a space separated list of "attribute requirements" (defined in .gitattributes), all of which must be met in order for the path to be considered a match:

  • ATTR requires that the attribute ATTR be set.
  • -ATTR requires that the attribute ATTR be unset.
  • ATTR=VALUE requires that the attribute ATTR be set to the string VALUE.
  • !ATTR requires that the attribute ATTR be unspecified.

  git ls-files ':(attr:!draft)*.kt' # searches for non-draft .kt files
  git ls-files ':(attr:draft)*.kt'  # searches for draft .kt files
  

• :(exclude) After a path matches any non-exclude pathspec, it will be run through all exclude pathspecs (magic signature: ! or its synonym ^). If it matches, the path is ignored. When there is no non-exclude pathspec, the exclusion is applied to the result set as if invoked without any pathspec.

  git ls-files '*.kts' ':(exclude)*.main.kts' # search .kts files excluding .main.kts
  git ls-files '*.kts' ':!*.main.kts' .       # magic
  

🔗

Print changes between two refs

git log --topo-order --pretty=format:"%h ~ %s" "$1..${2:-HEAD}" --no-merges

Rebase dependent branch

# git rebase --onto <what-branch> <from-exclusive>@{1} <up-to-inclusive>
git rebase --onto featureA featureA@{1} featureB

Rebase stacked branches

Abstract

Automatically force-update any branches that point to commits that are being rebased. Any branches that are checked out in a worktree are not updated in this way.

~/.gitconfig

[rebase]
    updateRefs = true

A─┬┄          (main)
  ╰─B─┬─X     (feature-1)
      ╰─C─╮   (feature-2)
          ╰─D (feature-3)

git checkout feature-3
git rebase feature-1 --update-refs

A─┬┄              (main)
  ╰─B───X─╮       (feature-1)
          ╰─Y─╮   (feature-2)
              ╰─Z (feature-3)

Recursive gc

find . -name '*.git' -execdir sh -c 'cd {} && git gc' \;

Renormalize line endings

git add --renormalize .

🔗

Show file at specific version

git show HEAD:path/to/file.txt
git show main~10:path/to/file.txt

Signing commits with GPG

🔗 🔗

Sort tags by SemVer

git -c versionsort.suffix=- tag --list --sort=version:refname

0.0.1
0.0.2
0.0.3
0.1.0-alpha
0.1.0-beta
0.1.0-rc
0.1.0
1.0.0

🔗

Switch branch with fzf

git branch --all |
  grep -v '^[*+]' `: # ignore current branch` |
  awk '{print $1}' `: # trim` |
  fzf -0 --border --reverse \
    --preview 'git show --color=always {-1}' |
  sed 's/remotes/origin///g' |
  xargs --no-run-if-empty git checkout