Support multi-line git commits by stopping at the end of the first line.

Author: danrivett

packages/commitlint-github-utils/src/commitlintGitHubConstants.ts

@@ -31,7 +31,7 @@ export const ISSUE_NUMBERS_PATTERN = /^\((?<issues>.*?)\)(?: (?<type>\S+?):)?(?!
 
 // Allow WIPs to avoid specifying issue number as should only exist on feature branches which are per issue
 // Allow either 'WIP: ...', 'WIP - ...', 'WIP2', 'WIP 2', 'WIP 2: ...', 'WIP 2 - ...' etc.
-export const WIP_WITHOUT_ISSUE_NUMBER_PATTERN = /^WIP(?:\s*\d+)?(?:(?:\.|:|(?:\s*-))(?<description>.*))?$/;
+export const WIP_WITHOUT_ISSUE_NUMBER_PATTERN = /^WIP(?:\s*\d+)?(?:(?:\.|:|(?:\s*-))(?<description>.*))?(?:\n|$)/;
 export const WIP_WITH_JUST_ISSUE_NUMBERS_PATTERN = /^\((?<issues>.*?)\) WIP\b/;
 export const SUBJECT_PATTERN = /^(?<subjectSeparator>\s*)?(?<subject>.*)/;
 export const WIP_TYPE = 'WIP';

packages/commitlint-github-utils/src/tests/parseCommitMessage.test.ts

@@ -1,7 +1,15 @@
 /* eslint-disable prettier/prettier */
 import parseCommitMessage from '../parseCommitMessage';
 
-const COMMIT_MESSAGE = 'Test commit message.';
+import {
+  COMMIT_MESSAGE,
+  ISSUE_NUMBER,
+  COMMIT_TYPE,
+  MULTI_LINE_COMMIT_MESSAGE,
+  MULTI_LINE_COMMIT_MESSAGE_WITH_TYPE,
+  MULTI_LINE_WIP_COMMIT_MESSAGES,
+  MULTI_LINE_WIP_COMMIT_MESSAGE_WITH_ISSUE_NUMBERS,
+} from './parserTestData';
 
 describe('commitlintPluginGitHubTests', () => {
   it('should return correct issue numbers', () => {
@@ -79,6 +87,14 @@ describe('commitlintPluginGitHubTests', () => {
     ).toEqual([123, 45]);
   });
 
+  it('should return correct issue numbers for multi-line commit messages', () => {
+    [
+      MULTI_LINE_COMMIT_MESSAGE,
+      MULTI_LINE_COMMIT_MESSAGE_WITH_TYPE,
+      MULTI_LINE_WIP_COMMIT_MESSAGE_WITH_ISSUE_NUMBERS,
+    ].forEach(commitMessage => expect(parseCommitMessage(commitMessage).issueNumbers).toEqual([ISSUE_NUMBER]));
+  });
+
   it('should return raw issue numbers', () => {
     // Non-numeric issue numbers prefix
     expect(
@@ -103,6 +119,14 @@ describe('commitlintPluginGitHubTests', () => {
     ).toEqual('#123,#45');
   });
 
+  it('should return correct raw issue numbers for multi-line commit messages', () => {
+    [
+      MULTI_LINE_COMMIT_MESSAGE,
+      MULTI_LINE_COMMIT_MESSAGE_WITH_TYPE,
+      MULTI_LINE_WIP_COMMIT_MESSAGE_WITH_ISSUE_NUMBERS,
+    ].forEach(commitMessage => expect(parseCommitMessage(commitMessage).rawIssueNumbers).toEqual(`#${ISSUE_NUMBER}`));
+  });
+
   it('should return no raw issue numbers', () => {
     expect(
       parseCommitMessage('My commit message').rawIssueNumbers
@@ -170,6 +194,11 @@ describe('commitlintPluginGitHubTests', () => {
     ).toEqual('');
   });
 
+  it('should return no raw issue numbers for multi-line WIP commit messages without them', () => {
+    MULTI_LINE_WIP_COMMIT_MESSAGES
+      .forEach(commitMessage => expect(parseCommitMessage(commitMessage).rawIssueNumbers).toBeUndefined);
+  });
+
   it('should return no issue numbers', () => {
     // Missing issue numbers prefix entirely
     expect(
@@ -294,7 +323,12 @@ describe('commitlintPluginGitHubTests', () => {
     ).toEqual([]);
   });
 
-  it('should return correct type', () => {
+  it('should return no issue numbers for multi-line WIP commit messages without them', () => {
+    MULTI_LINE_WIP_COMMIT_MESSAGES
+      .forEach(commitMessage => expect(parseCommitMessage(commitMessage).issueNumbers).toEqual([]));
+  });
+
+  it('should return the correct type', () => {
     expect(
       parseCommitMessage(`(#1) ${COMMIT_MESSAGE}`).type
     ).toBeUndefined();
@@ -320,7 +354,11 @@ describe('commitlintPluginGitHubTests', () => {
     ).toEqual('chore');
   });
 
-  it('should return an empty type for WIPs', () => {
+  it('should return the correct type for multi-line commit messages with them', () => {
+    expect(parseCommitMessage(MULTI_LINE_COMMIT_MESSAGE_WITH_TYPE).type).toEqual(COMMIT_TYPE);
+  });
+
+  it('should return no type for WIP commit messages', () => {
     expect(
       parseCommitMessage(`(#123) WIP: ${COMMIT_MESSAGE}`).type
     ).toBeUndefined();
@@ -382,6 +420,14 @@ describe('commitlintPluginGitHubTests', () => {
     ).toBeUndefined();
   });
 
+  it('should return no type for multi-line commit messages without them', () => {
+    [
+      MULTI_LINE_COMMIT_MESSAGE,
+      MULTI_LINE_WIP_COMMIT_MESSAGE_WITH_ISSUE_NUMBERS,
+      ...MULTI_LINE_WIP_COMMIT_MESSAGES,
+    ].forEach(commitMessage => expect(parseCommitMessage(commitMessage).type).toBeUndefined());
+  });
+
   it('should return correct WIP status', () => {
     expect(
       parseCommitMessage(`(#1) ${COMMIT_MESSAGE}`).isWip
@@ -505,6 +551,20 @@ describe('commitlintPluginGitHubTests', () => {
     ).toBe(true);
   });
 
+  it('should return the correct WIP status for multi-line non-WIP commit messages', () => {
+    [
+      MULTI_LINE_COMMIT_MESSAGE,
+      MULTI_LINE_COMMIT_MESSAGE_WITH_TYPE,
+    ].forEach(commitMessage => expect(parseCommitMessage(commitMessage).isWip).toBe(false));
+  });
+
+  it('should return the correct WIP status for multi-line WIP commit messages', () => {
+    [
+      MULTI_LINE_WIP_COMMIT_MESSAGE_WITH_ISSUE_NUMBERS,
+      ...MULTI_LINE_WIP_COMMIT_MESSAGES,
+    ].forEach(commitMessage => expect(parseCommitMessage(commitMessage).isWip).toBe(true));
+  });
+
   it('should return correct subject', () => {
     expect(
       parseCommitMessage(`(#1) ${COMMIT_MESSAGE}`).subject
@@ -604,4 +664,13 @@ describe('commitlintPluginGitHubTests', () => {
       parseCommitMessage(`WIP: ${COMMIT_MESSAGE} (#22)`).subject
     ).toEqual(`${COMMIT_MESSAGE} (#22)`);
   });
+
+  it('should return the correct subject for multi-line commit messages', () => {
+    [
+      MULTI_LINE_COMMIT_MESSAGE,
+      MULTI_LINE_COMMIT_MESSAGE_WITH_TYPE,
+      MULTI_LINE_WIP_COMMIT_MESSAGE_WITH_ISSUE_NUMBERS,
+      ...MULTI_LINE_WIP_COMMIT_MESSAGES,
+    ].forEach(commitMessage => expect(parseCommitMessage(commitMessage).subject).toEqual(COMMIT_MESSAGE));
+  });
 });

packages/commitlint-github-utils/src/tests/parserTestData.ts

@@ -0,0 +1,103 @@
+export const COMMIT_MESSAGE = 'Test commit message.';
+export const ISSUE_NUMBER = 42;
+export const COMMIT_TYPE = 'chore';
+
+// Note: We need to trim the beginning of each multiline String to it starts with the first non-whitespace character
+//       As otherwise it adds a leading line break and whitespace which is invalid.
+//       We deliberately don't trim the end to leave a trailing new line and ensure that works.
+
+export const MULTI_LINE_COMMIT_MESSAGE = `
+  (#${ISSUE_NUMBER}) ${COMMIT_MESSAGE}
+
+  My commit message description
+    - SUBTASK-1: I added a new feature
+    * SUBTASK-2: I fixed a issue
+
+  For more information see: https://github.com/conventional-changelog/commitlint/
+`.trimStart();
+
+export const MULTI_LINE_COMMIT_MESSAGE_WITH_TYPE = `
+  (#${ISSUE_NUMBER}) ${COMMIT_TYPE}: ${COMMIT_MESSAGE}
+
+  My commit message description
+    - SUBTASK-1: I added a new feature
+    * SUBTASK-2: I fixed a issue
+
+  For more information see: https://github.com/conventional-changelog/commitlint/
+`.trimStart();
+
+export const MULTI_LINE_WIP_COMMIT_MESSAGES = [
+  `
+    WIP: ${COMMIT_MESSAGE}
+
+    My commit message description
+        - SUBTASK-1: I added a new feature
+        * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart(),
+  `
+    WIP2: ${COMMIT_MESSAGE}
+
+    My commit message description
+        - SUBTASK-1: I added a new feature
+        * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart(),
+  `
+    WIP 2: ${COMMIT_MESSAGE}
+
+    My commit message description
+        - SUBTASK-1: I added a new feature
+        * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart(),
+  `
+    WIP2:${COMMIT_MESSAGE}
+
+    My commit message description
+        - SUBTASK-1: I added a new feature
+        * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart(),
+  `
+    WIP 2:${COMMIT_MESSAGE}
+
+    My commit message description
+        - SUBTASK-1: I added a new feature
+        * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart(),
+  `
+    WIP 2 - ${COMMIT_MESSAGE}
+
+    My commit message description
+        - SUBTASK-1: I added a new feature
+        * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart(),
+  `
+    WIP2 - ${COMMIT_MESSAGE}
+
+    My commit message description
+        - SUBTASK-1: I added a new feature
+        * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart(),
+];
+
+export const MULTI_LINE_WIP_COMMIT_MESSAGE_WITH_ISSUE_NUMBERS = `
+    (#${ISSUE_NUMBER}) WIP: ${COMMIT_MESSAGE}
+
+    My commit message description
+    - SUBTASK-1: I added a new feature
+    * SUBTASK-2: I fixed a issue
+
+    For more information see: https://github.com/conventional-changelog/commitlint/
+  `.trimStart();