Relax lowerCaseAfterPrefix to permit ALLCAPS after prefix

ahunt · ahunt · commit a79b159ab20c · 2021-03-14T19:43:37.000+01:00
We do want to block things like:
init: A bad example
init: Another bad example

However this should be acceptable:
init: UNLEAK foo

Therefore we tweak the regex to permit ALLCAPS after the prefix.

Signed-off-by: Andrzej Hunt &lt;ajrhunt@google.com&gt;
diff --git a/lib/commit-lint.ts b/lib/commit-lint.ts
@@ -87,10 +87,11 @@ export class LintCommit {
     }
 
     // Verify if the first line starts with a prefix (e.g. tests:), it continues
-    // in lower-case
+    // in lower-case (except for ALLCAPS as that is likely to be a code
+    // identifier)
 
     private lowerCaseAfterPrefix(): void {
-        const match = this.lines[0].match(/^\S+?:\s*?([A-Z])/);
+        const match = this.lines[0].match(/^\S+?:\s*?([A-Z][a-z ])/);
 
         if (match) {
             this.block(`Prefixed commit message must be in lower case: ${
diff --git a/tests/commit-lint.test.ts b/tests/commit-lint.test.ts
@@ -76,13 +76,40 @@ test("basic lint tests", () => {
         }
     }
 
+    commit.message = `tests: A title that should also be lower case\n
+Signed-off-by: x`;
+    {
+        const linter = new LintCommit(commit);
+        const lintError = linter.lint();
+        expect(lintError).not.toBeUndefined();
+        if (lintError) {
+            expect(lintError.checkFailed).toBe(true);
+            expect(lintError.message).toMatch(/lower/);
+        }
+    }
+
+    commit.message = "tests: THIS can be allcaps\n\nSigned-off-by: x";
+    {
+        const linter = new LintCommit(commit);
+        const lintError = linter.lint();
+        expect(lintError).toBeUndefined();
+    }
+
     commit.message = "doc: success as Lower Case\n\nSigned-off-by: x";
     {
         const linter = new LintCommit(commit);
         const lintError = linter.lint();
         expect(lintError).toBeUndefined();
     }
 
+    commit.message = `doc: a single-letter Lower Case message also succeeds\n
+Signed-off-by: x`;
+    {
+        const linter = new LintCommit(commit);
+        const lintError = linter.lint();
+        expect(lintError).toBeUndefined();
+    }
+
     commit.message = "Fail not signed off\n\nNotSigned-off-by: x";
     {
         const linter = new LintCommit(commit);
