From 3fdd3d2dcb9c1db13aac74dbe8694e149f4f8673 Mon Sep 17 00:00:00 2001
From: Jim Huang <jserv@ccns.ncku.edu.tw>
Date: Mon, 3 Mar 2025 17:55:37 +0000
Subject: [PATCH] Prevent commit of conflict markers

This commit introduces a pre-commit hook that checks for merge conflict
markers (e.g. "<<<<<<<", "=======", ">>>>>>>") in staged changes. If any
are detected, the hook warns the user and aborts the commit, ensuring
that unresolved conflict markers are not inadvertently committed.

Reference:
  https://blog.meain.io/2019/making-sure-you-wont-commit-conflict-markers/

Change-Id: Ia3b058298f9e38227bdbd7a3634ed9b0b855e374
---
 scripts/pre-commit.hook | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/scripts/pre-commit.hook b/scripts/pre-commit.hook
index a312944cf..b610848cc 100755
--- a/scripts/pre-commit.hook
+++ b/scripts/pre-commit.hook
@@ -82,6 +82,16 @@ if echo "$workspace" | grep -q "[一-龥]"; then
   throw "The workspace path '$workspace' contains non-ASCII characters."
 fi
 
+# Check for merge conflict markers in staged changes.
+# Assemble the conflict marker regex without embedding it directly.
+CONFLICT_MARKERS=$(printf '%s|%s|%s' "<<<<<<<" "=======" ">>>>>>>")
+# Get staged files that contain conflict markers, but exclude hook files.
+CONFLICT_FILES=$(git diff --cached --name-only -G "${CONFLICT_MARKERS}" | \
+                 grep -vE '(^|/)\.git/hooks/|(^|/)(pre-commit|commit-msg|prepare-commit-msg|pre-push)\.hook$')
+if [ -n "${CONFLICT_FILES}" ]; then
+  throw "Conflict markers are still present in the following files:\n%s" ${CONFLICT_FILES}
+fi
+
 CLANG_FORMAT=$(which clang-format)
 if [ $? -ne 0 ]; then
   throw "clang-format not installed. Unable to check source file format policy."