feat: relax commit message validation to accept commit messages witho…

…ut spaces before the description (after `:`)
invertase · Jan 7, 2022 · ddf7fb1 · ddf7fb1
1 parent b1eff4d
commit ddf7fb1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/packages/conventional_commit/lib/conventional_commit.dart b/packages/conventional_commit/lib/conventional_commit.dart
@@ -16,7 +16,7 @@
  */
 
 final _conventionalCommitRegex = RegExp(
-  r'^(?<type>build|chore|ci|docs|feat|fix|bug|perf|refactor|revert|style|test)(?<scope>\([a-zA-Z0-9_,\s\*]+\)?((?=:\s)|(?=!:\s)))?(?<breaking>!)?(?<description>:\s.*)?|^(?<merge>Merge \w+)',
+  r'^(?<type>build|chore|ci|docs|feat|fix|bug|perf|refactor|revert|style|test)(?<scope>\([a-zA-Z0-9_,\s\*]+\)?((?=:\s?)|(?=!:\s?)))?(?<breaking>!)?(?<description>:\s?.*)?|^(?<merge>Merge \w+)',
 );
 
 final _breakingChangeRegex =

diff --git a/packages/conventional_commit/test/conventional_commit_test.dart b/packages/conventional_commit/test/conventional_commit_test.dart
@@ -66,6 +66,14 @@ void main() {
       expect(ConventionalCommit.tryParse('custom: new feature'), isNull);
     });
 
+    test('accepts commit messages with or without a space before description',
+        () {
+      expect(ConventionalCommit.tryParse('feat:new thing'), isNotNull);
+      expect(ConventionalCommit.tryParse('feat(foo):new thing'), isNotNull);
+      expect(ConventionalCommit.tryParse('feat: new thing'), isNotNull);
+      expect(ConventionalCommit.tryParse('feat(foo): new thing'), isNotNull);
+    });
+
     test('correctly handles messages with a `*` scope', () {
       final commit = ConventionalCommit.tryParse(commitMessageStarScope);
       expect(commit, isNotNull);