Skip to content

Commit

Permalink
new file: git/git-colored-move-diffs.md
Browse files Browse the repository at this point in the history
  • Loading branch information
byt3h3ad committed Jan 7, 2024
1 parent a5a6e62 commit c093ecc
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions git/git-colored-move-diffs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Easier Code reviews with Git Colored Move Diffs

Code reviews can be very time-consuming. Especially if you are reviewing a lot of code changes. Often, code changes are simple refactorings, such as extracting code into methods/functions or moving code around. These changes are more or less irrelevant for the review, since they usually don’t change the behavior of the code. As a reviewer, one still wants to make sure that code hasn’t been changed during the code move.

This is where git colored move diffs come into play. They make it easier to detect and display code moves in a different color than other code changes.

### How to use git colored move diffs on demand

Colored Move Diffs work with all git commends that display diffs, such as `git diff`, `git show`, `git log -p`, etc.

```bash
git diff --color-moved
git show --color-moved HEAD
git log --color-moved -p
```

You can also set different color schemes for moved code, I prefer the `dimmed-zebra` color profile since it greys out moved code:

```bash
git diff --color-moved=dimmed-zebra
```

There is also an option to ignore whitespace changes in moved code:

```bash
git diff --color-moved=dimmed-zebra --color-moved-ws=ignore-all-space
```

### How to enable git colored move diffs

To globally configure git to use colored moves in git diffs, run the following commands:

```
git config --global diff.colorMoved dimmed-zebra # enables colored moved diffs with the dimmed-zebra color profile
git config --global diff.color-moved-ws ignore-all-space # ignores whitespace changes in moved code
```

0 comments on commit c093ecc

Please sign in to comment.