feat: support multi scopes (#10)

Author: hyiso

lib/src/ensure.dart

@@ -2,7 +2,13 @@ import 'package:change_case/change_case.dart';
 
 import 'types/case.dart';
 
-bool ensureCase(String raw, Case target) {
+bool ensureCase(dynamic raw, Case target) {
+  if (raw is Iterable) {
+    return raw.isEmpty || raw.every((element) => ensureCase(element, target));
+  }
+  if (raw is! String) {
+    return false;
+  }
   switch (target) {
     case Case.lower:
       return raw.toLowerCase() == raw;
@@ -31,16 +37,34 @@ bool ensureLeadingBlank(String raw) {
   return raw.startsWith('\n');
 }
 
-bool ensureMaxLength(String raw, num maxLength) {
-  return raw.length <= maxLength;
+bool ensureMaxLength(dynamic raw, num maxLength) {
+  if (raw == null) {
+    return true;
+  }
+  if (raw is String) {
+    return raw.length <= maxLength;
+  }
+  if (raw is Iterable) {
+    return raw.isEmpty || raw.every((element) => element.length <= maxLength);
+  }
+  return false;
 }
 
 bool ensureMaxLineLength(String raw, num maxLineLength) {
   return raw.split('\n').every((line) => ensureMaxLength(line, maxLineLength));
 }
 
-bool ensureMinLength(String raw, num minLength) {
-  return raw.length >= minLength;
+bool ensureMinLength(dynamic raw, num minLength) {
+  if (raw == null) {
+    return false;
+  }
+  if (raw is String) {
+    return raw.length >= minLength;
+  }
+  if (raw is Iterable) {
+    return raw.isEmpty || raw.every((element) => element.length >= minLength);
+  }
+  return false;
 }
 
 bool ensureEmpty(dynamic raw) {

lib/src/parse.dart

@@ -141,7 +141,7 @@ Commit parse(String raw) {
     merge: merge,
     header: header,
     type: headerParts['type'],
-    scope: headerParts['scope'],
+    scopes: headerParts['scope']?.split(RegExp(r'(/|,|\\)')),
     subject: headerParts['subject'],
     body: body != null ? _trimOffNewlines(body) : null,
     footer: footer != null ? _trimOffNewlines(footer) : null,

lib/src/types/commit.dart

@@ -2,7 +2,7 @@
 class Commit {
   final String header;
   final String? type;
-  final String? scope;
+  final List<String>? scopes;
   final String? subject;
   final String? body;
   final String? footer;
@@ -15,7 +15,7 @@ class Commit {
   Commit({
     required this.header,
     this.type,
-    this.scope,
+    this.scopes,
     this.subject,
     this.body,
     this.footer,
@@ -29,7 +29,7 @@ class Commit {
   Commit.empty()
       : header = '',
         type = null,
-        scope = null,
+        scopes = null,
         subject = null,
         body = null,
         footer = null,
@@ -44,7 +44,7 @@ class Commit {
       case CommitComponent.type:
         return type as T?;
       case CommitComponent.scope:
-        return scope as T?;
+        return scopes as T?;
       case CommitComponent.subject:
         return subject as T?;
       case CommitComponent.header:

test/parse_test.dart

@@ -22,7 +22,7 @@ void main() {
       expect(commit.notes, equals([]));
       expect(commit.references, equals([]));
       expect(commit.type, equals(null));
-      expect(commit.scope, equals(null));
+      expect(commit.scopes, equals(null));
       expect(commit.subject, equals(null));
     });
     test('supports `type(scope): subject`', () {
@@ -35,7 +35,7 @@ void main() {
       expect(commit.notes, equals([]));
       expect(commit.references, equals([]));
       expect(commit.type, equals('type'));
-      expect(commit.scope, equals('scope'));
+      expect(commit.scopes, equals(['scope']));
       expect(commit.subject, equals('subject'));
     });
     test('supports `type!: subject`', () {
@@ -48,7 +48,7 @@ void main() {
       expect(commit.notes, equals([]));
       expect(commit.references, equals([]));
       expect(commit.type, equals('type'));
-      expect(commit.scope, equals(null));
+      expect(commit.scopes, equals(null));
       expect(commit.subject, equals('subject'));
     });
     test('supports `type(scope)!: subject`', () {
@@ -61,18 +61,24 @@ void main() {
       expect(commit.notes, equals([]));
       expect(commit.references, equals([]));
       expect(commit.type, equals('type'));
-      expect(commit.scope, equals('scope'));
+      expect(commit.scopes, equals(['scope']));
       expect(commit.subject, equals('subject'));
     });
-    test('supports scopes with /', () {
-      const message = 'type(some/scope): subject';
+    test('supports multi scopes separated by `/`', () {
+      const message = 'type(multi/scope): subject';
       final commit = parse(message);
-      expect(commit.scope, equals('some/scope'));
+      expect(commit.scopes, equals(['multi', 'scope']));
+      expect(commit.subject, equals('subject'));
+    });
+    test('supports multi scopes separated by `,`)', () {
+      const message = 'type(multi,scope): subject';
+      final commit = parse(message);
+      expect(commit.scopes, equals(['multi', 'scope']));
       expect(commit.subject, equals('subject'));
     });
 
     test('keep -side notes- in the body section', () {
-      final header = "type(some/scope): subject";
+      final header = "type(scope): subject";
       final body =
           "CI on master branch caught this:\n\n```\nUnhandled Exception:\nSystem.AggregateException: One or more errors occurred. (Some problem when connecting to 'api.mycryptoapi.com/eth')\n\n--- End of stack trace from previous location where exception was thrown ---\n\nat GWallet.Backend.FSharpUtil.ReRaise (System.Exception ex) [0x00000] in /Users/runner/work/geewallet/geewallet/src/GWallet.Backend/FSharpUtil.fs:206\n...\n```";
       final message = "$header\n\n$body";
@@ -88,7 +94,7 @@ void main() {
       const message = 'fix(面试评价): 测试';
       final commit = parse(message);
       expect(commit.subject, isNotNull);
-      expect(commit.scope, isNotNull);
+      expect(commit.scopes, isNotNull);
     });
     test('should trim extra newlines', () {
       final commit = parse(
@@ -104,7 +110,7 @@ void main() {
       expect(commit.header,
           equals('feat(scope): broadcast destroy event on scope destruction'));
       expect(commit.type, equals('feat'));
-      expect(commit.scope, equals('scope'));
+      expect(commit.scopes, equals(['scope']));
       expect(commit.subject,
           equals('broadcast destroy event on scope destruction'));
       expect(
@@ -156,7 +162,7 @@ void main() {
           equals(
               ' feat(scope): broadcast destroy event on scope destruction '));
       expect(commit.type, equals(null));
-      expect(commit.scope, equals(null));
+      expect(commit.scopes, equals(null));
       expect(commit.subject, equals(null));
       expect(
           commit.body,
@@ -200,7 +206,7 @@ void main() {
       expect(commit.header,
           equals('feat(scope): broadcast destroy event on scope destruction'));
       expect(commit.type, equals('feat'));
-      expect(commit.scope, equals('scope'));
+      expect(commit.scopes, equals(['scope']));
       expect(commit.subject,
           equals('broadcast destroy event on scope destruction'));
       expect(
@@ -267,7 +273,7 @@ void main() {
 
       test('should understand header parts in GitHub like pull request', () {
         expect(githubCommit.type, equals('feat'));
-        expect(githubCommit.scope, equals('scope'));
+        expect(githubCommit.scopes, equals(['scope']));
         expect(githubCommit.subject,
             equals('broadcast destroy event on scope destruction'));
       });
@@ -295,7 +301,7 @@ void main() {
 
       test('should understand header parts in GitLab like merge request', () {
         expect(gitlabCommit.type, equals('feat'));
-        expect(gitlabCommit.scope, equals('scope'));
+        expect(gitlabCommit.scopes, equals(['scope']));
         expect(gitlabCommit.subject,
             equals('broadcast destroy event on scope destruction'));
       });