commit a624310bab6ea756c589cc96aed0b0654a665a39
author Milutin Kristofic <milutin@google.com> Tue Feb 04 06:05:00 2025 -0800
committer Gerrit Code Review <noreply-gerritcodereview@google.com> Tue Feb 04 06:05:00 2025 -0800
tree c1e1ecf94453c74cd484eb6ff64648ef6ee6c5ee
parent 2389483ae8209108f2ce90d157f4c91821ce6d0c
parent fbe7f88c2b3e4b92a99efb50fdab838dfb3e1510

Merge "feat: Detect and error on comment lines in commit message formatting"

polygerrit-ui/app/utils/commit-message-formatter-util.ts

diff --git a/polygerrit-ui/app/utils/commit-message-formatter-util.ts b/polygerrit-ui/app/utils/commit-message-formatter-util.ts
index bbd94ed..44b0f1d 100644
--- a/polygerrit-ui/app/utils/commit-message-formatter-util.ts
+++ b/polygerrit-ui/app/utils/commit-message-formatter-util.ts
@@ -24,6 +24,7 @@
   EXTRA_BLANK_LINE,
   INVALID_INDENTATION,
   TRAILING_SPACES,
+  COMMENT_LINE,
   LEADING_SPACES,
 }
 
@@ -201,9 +202,20 @@
     });
   }
 
-  // Check for extra blank lines using the raw messageString
   const lines = messageString.split('\n');
   for (let i = 0; i < lines.length; i++) {
+    if (lines[i].trim().startsWith('#')) {
+      errors.push({
+        type: ErrorType.COMMENT_LINE,
+        line: i + 1, // Line numbers are 1-based
+        message:
+          "'#' at line start is a comment marker in Git. Line will be ignored",
+      });
+    }
+  }
+
+  // Check for extra blank lines using the raw messageString
+  for (let i = 0; i < lines.length; i++) {
     if (i > 0 && lines[i].trim() === '' && lines[i - 1].trim() === '') {
       const isBetweenSubjectAndBody = i === 1 && message.body.length > 0;
       const isBetweenBodyAndFooter =

polygerrit-ui/app/utils/commit-message-formatter-util_test.ts

diff --git a/polygerrit-ui/app/utils/commit-message-formatter-util_test.ts b/polygerrit-ui/app/utils/commit-message-formatter-util_test.ts
index 1a76cd1..8b1a18e 100644
--- a/polygerrit-ui/app/utils/commit-message-formatter-util_test.ts
+++ b/polygerrit-ui/app/utils/commit-message-formatter-util_test.ts
@@ -330,5 +330,23 @@
         'Line should not start with spaces'
       );
     });
+
+    test('comment lines', () => {
+      const message =
+        'Fix the thing\n\n# This is a comment line.\nThis is body.\n# Another comment line in body.\n\nChange-Id: abcdefg\n# Comment line in footer\n';
+      const errors = detectFormattingErrorsInString(message);
+      assertError(
+        errors,
+        ErrorType.COMMENT_LINE,
+        3,
+        "'#' at line start is a comment marker in Git. Line will be ignored"
+      );
+      assertError(
+        errors,
+        ErrorType.COMMENT_LINE,
+        5,
+        "'#' at line start is a comment marker in Git. Line will be ignored"
+      );
+    });
   });
 });