git-gui: strip comments and consecutive empty lines from commit messages
This is also known as "washing". This is consistent with the behavior of interactive git commit, which we should emulate as closely as possible to avoid usability problems. This way commit message templates and prepare hooks can be used properly, and comments from conflicted rebases and merges are cleaned up without having to introduce special handling for them. Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de> Signed-off-by: Johannes Sixt <j6t@kdbg.org>
Oswald Buddenhagen committed
Aug 13, 2024 at 11:06 UTC
1ae85ff6d418238b8d987c9e019bd785e3ae7192
1 file changed
+4
lib/commit.tcl
+4
@@ -209,6 +209,10 @@ You must stage at least 1 file before you can commit.
209
#
210
set msg [string trim [$ui_comm get 1.0 end]]
211
regsub -all -line {[ \t\r]+$} $msg {} msg
212
+ # Strip comment lines
213
+ regsub -all {(^|\n)#[^\n]*} $msg {\1} msg
214
+ # Compress consecutive empty lines
215
+ regsub -all {\n{3,}} $msg "\n\n" msg
216
if {$msg eq {}} {
217
error_popup [mc "Please supply a commit message.
218