26.1.2022 |

Git: Stelle den Kommentiercharakter auf "auto"

Wenn man in Git eine Commit Message schreibt, mag einem vielleicht schon aufgefallen sein, dass Kommentare standardmäßig mit einer Raute (#) auskommentiert sind.

Dieses Verhalten kann sehr störend sein, wenn man eine Git Commit Message mit einer Raute starten lassen möchte. Z.B.:

git commit -m '#feat: Add new controller'

Git erkennt diese Mitteilung nicht und behandelt den Text wie eine Leerzeile.

Seit Git 2.0 kann man selbst bestimmen, welches der Kommentiercharakter sein soll. Das kann man mit einem Kommando im Terminal eingeben oder in der Konfigurationsdatei (~/.gitconfig). Hier das Beispiel des Kommandozeilenbefehls, wenn man lieber ; benutzen will:

git config core.commentChar ";"

Alternativ kann man aber auch die Option auto wählen:

When core.commentChar is "auto", the comment char starts with '#' as in default but if it's already in the prepared message, find another char in a small subset. This should stop surprises because git strips some lines unexpectedly.

Note that git is not smart enough to recognize '#' as the comment char in custom templates and convert it if the final comment char is different. It thinks '#' lines in custom templates as part of the commit message. So don't use this with custom templates.

The list of candidate characters for "auto" are: §# ; @ ! $ % ^ & | :

That means a command like git commit -m '#1 (closed) fixed issue' will automatically switch the commentChar to ';', because '#' was used in the commit message.

Kommandozeilenbefehl:

git config core.commentChar auto

Quelle: StackOverflow

Sophia Brandt
Zur Übersicht

Mehr vom DevSquad...

Jan Sauer

Global Git Ignore files

Sophia Brandt

Budibase: Open-Source Low Code Plattform