feat: Use git worktrees to generate analysis (#15)

Author: ElectricCookie

bin/mtrust_api_guard.dart

@@ -6,7 +6,9 @@ import 'package:mtrust_api_guard/changelog_generator/changelog_generator_command
 import 'package:mtrust_api_guard/doc_comparator/doc_comparator_command.dart';
 import 'package:mtrust_api_guard/doc_generator/doc_generator_command.dart';
 import 'package:mtrust_api_guard/logger.dart';
+import 'package:mtrust_api_guard/version.dart';
 import 'package:mtrust_api_guard/version/version_command.dart';
+import 'package:mtrust_api_guard/version/version_workspace_command.dart';
 
 main(List<String> args) async {
   final commandRunner = CommandRunner(
@@ -18,7 +20,8 @@ main(List<String> args) async {
     ..addCommand(DocGeneratorCommand())
     ..addCommand(DocComparatorCommand())
     ..addCommand(ChangelogGeneratorCommand())
-    ..addCommand(VersionCommand());
+    ..addCommand(VersionCommand())
+    ..addCommand(VersionWorkspaceCommand());
 
   commandRunner.argParser.addFlag(
     "verbose",
@@ -32,6 +35,13 @@ main(List<String> args) async {
     defaultsTo: false,
   );
 
+  logger.info(" ");
+  logger.info('▄████▄ █████▄ ██    ▄████  ██  ██ ▄████▄ █████▄  ████▄  ');
+  logger.info('██▄▄██ ██▄▄█▀ ██   ██  ▄▄▄ ██  ██ ██▄▄██ ██▄▄██▄ ██  ██ ');
+  logger.info('██  ██ ██     ██    ▀███▀  ▀████▀ ██  ██ ██   ██ ████▀  ');
+  logger.info('mtrust_api_guard version: $mtrustApiGuardVersion');
+  logger.info(" ");
+
   if (args.isEmpty) {
     // ignore: avoid_print
     print(commandRunner.usage);

lib/changelog_generator/changelog_generator.dart

@@ -118,7 +118,7 @@ class ChangelogGenerator {
     final updatedContent = '$newEntry$existingContent';
     await changelogFile.writeAsString(updatedContent);
 
-    logger.info('CHANGELOG.md updated successfully.');
+    logger.info('${changelogFile.absolute.path} updated successfully.');
   }
 
   /// Retrieves the package version and homepage from pubspec.yaml

lib/doc_comparator/api_change.dart

@@ -76,7 +76,24 @@ enum ApiChangeOperation {
   dependencyVersionChange(ApiChangeMagnitude.patch),
   dependencyAddition(ApiChangeMagnitude.patch),
   dependencyRemoval(ApiChangeMagnitude.minor),
-  platformConstraintChange(ApiChangeMagnitude.major),
+  // Dart SDK constraints
+  minDartSdkVersionDecrease(ApiChangeMagnitude.patch),
+  minDartSdkVersionIncrease(ApiChangeMagnitude.major),
+  maxDartSdkVersionDecrease(ApiChangeMagnitude.major),
+  maxDartSdkVersionIncrease(ApiChangeMagnitude.patch),
+  // Flutter SDK constraints
+  minFlutterSdkVersionIncrease(ApiChangeMagnitude.major),
+  maxFlutterSdkVersionDecrease(ApiChangeMagnitude.major),
+  maxFlutterSdkVersionIncrease(ApiChangeMagnitude.patch),
+  minFlutterSdkVersionDecrease(ApiChangeMagnitude.patch),
+
+  // Android constraints
+  minAndroidSdkVersionDecrease(ApiChangeMagnitude.patch),
+  minAndroidSdkVersionIncrease(ApiChangeMagnitude.major),
+
+  // iOS constraints
+  minIosSdkVersionDecrease(ApiChangeMagnitude.patch),
+  minIosSdkVersionIncrease(ApiChangeMagnitude.major),
 
   // Feature changes
   featureAddition(ApiChangeMagnitude.minor),
@@ -142,7 +159,18 @@ class MetaApiChange extends ApiChange {
     ApiChangeOperation.dependencyVersionChange,
     ApiChangeOperation.dependencyAddition,
     ApiChangeOperation.dependencyRemoval,
-    ApiChangeOperation.platformConstraintChange,
+    ApiChangeOperation.minDartSdkVersionDecrease,
+    ApiChangeOperation.minDartSdkVersionIncrease,
+    ApiChangeOperation.maxDartSdkVersionDecrease,
+    ApiChangeOperation.maxDartSdkVersionIncrease,
+    ApiChangeOperation.minFlutterSdkVersionDecrease,
+    ApiChangeOperation.minFlutterSdkVersionIncrease,
+    ApiChangeOperation.maxFlutterSdkVersionDecrease,
+    ApiChangeOperation.maxFlutterSdkVersionIncrease,
+    ApiChangeOperation.minAndroidSdkVersionDecrease,
+    ApiChangeOperation.minAndroidSdkVersionIncrease,
+    ApiChangeOperation.minIosSdkVersionDecrease,
+    ApiChangeOperation.minIosSdkVersionIncrease,
   };
 
   factory MetaApiChange.dependencyVersionChange({
@@ -177,6 +205,143 @@ class MetaApiChange extends ApiChange {
       description: 'removed',
     );
   }
+
+  factory MetaApiChange.minDartSdkVersionDecrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minDartSdkVersionDecrease,
+      title: "Minimum Dart SDK version decreased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.minDartSdkVersionIncrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minDartSdkVersionIncrease,
+      title: "Minimum Dart SDK version increased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.maxDartSdkVersionDecrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.maxDartSdkVersionDecrease,
+      title: "Maximum Dart SDK version decreased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.maxDartSdkVersionIncrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.maxDartSdkVersionIncrease,
+      title: "Maximum Dart SDK version increased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.minFlutterSdkVersionDecrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minFlutterSdkVersionDecrease,
+      title: "Minimum Flutter SDK version decreased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.minFlutterSdkVersionIncrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minFlutterSdkVersionIncrease,
+      title: "Minimum Flutter SDK version increased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.maxFlutterSdkVersionDecrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.maxFlutterSdkVersionDecrease,
+      title: "Maximum Flutter SDK version decreased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.maxFlutterSdkVersionIncrease({
+    required String version,
+    required String previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.maxFlutterSdkVersionIncrease,
+      title: "Maximum Flutter SDK version increased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.minAndroidSdkVersionDecrease({
+    required int version,
+    required int previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minAndroidSdkVersionDecrease,
+      title: "Minimum Android SDK version decreased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.minAndroidSdkVersionIncrease({
+    required int version,
+    required int previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minAndroidSdkVersionIncrease,
+      title: "Minimum Android SDK version increased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.minIosSdkVersionDecrease({
+    required num version,
+    required num previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minIosSdkVersionDecrease,
+      title: "Minimum iOS SDK version decreased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  factory MetaApiChange.minIosSdkVersionIncrease({
+    required num version,
+    required num previousVersion,
+  }) {
+    return MetaApiChange(
+      operation: ApiChangeOperation.minIosSdkVersionIncrease,
+      title: "Minimum iOS SDK version increased",
+      description: 'from `$previousVersion` to `$version`',
+    );
+  }
+
+  @override
+  toString() {
+    return 'MetaApiChange(component: ${component.name}, operation: $operation, annotation: $annotation, changedValue: $changedValue)';
+  }
 }
 
 /// A change that belongs to a specific component.
@@ -206,6 +371,11 @@ class ComponentApiChange extends ApiChange {
     ApiChangeOperation.mixinRemoval,
     ApiChangeOperation.superClassChange,
   };
+
+  @override
+  toString() {
+    return 'ComponentApiChange(component: ${component.name}, operation: $operation, annotation: $annotation, changedValue: $changedValue)';
+  }
 }
 
 /// A change that belongs to a specific property of a component.
@@ -259,6 +429,11 @@ class PropertyApiChange extends ApiChange {
 
     return super.getMagnitude();
   }
+
+  @override
+  toString() {
+    return 'PropertyApiChange(component: ${component.name}, operation: $operation, annotation: $annotation, changedValue: $changedValue, property: ${property.name})';
+  }
 }
 
 /// A change that belongs to a specific method of a component or a top-level function.
@@ -319,6 +494,11 @@ class MethodApiChange extends ApiChange {
   bool isFunctionChange() {
     return component.type == DocComponentType.functionType;
   }
+
+  @override
+  toString() {
+    return 'MethodApiChange(component: ${component.name}, operation: $operation, annotation: $annotation, changedValue: $changedValue, method: ${method.name})';
+  }
 }
 
 /// Base class for parameter changes to share magnitude logic
@@ -395,6 +575,11 @@ abstract class ParameterApiChange extends ApiChange {
     }
     return super.getMagnitude();
   }
+
+  @override
+  toString() {
+    return 'ParameterApiChange(component: ${component.name}, operation: $operation, annotation: $annotation, changedValue: $changedValue, parameter: ${parameter.name}, parentName: $parentName, oldName: $oldName, newType: $newType)';
+  }
 }
 
 class MethodParameterApiChange extends ParameterApiChange {
@@ -433,7 +618,6 @@ class ConstructorApiChange extends ApiChange {
     ApiChangeOperation.dependencyAddition,
     ApiChangeOperation.dependencyRemoval,
     ApiChangeOperation.dependencyVersionChange,
-    ApiChangeOperation.platformConstraintChange,
   };
 
   @override
@@ -458,6 +642,11 @@ class ConstructorApiChange extends ApiChange {
 
     return super.getMagnitude();
   }
+
+  @override
+  toString() {
+    return 'ConstructorApiChange(component: ${component.name}, operation: $operation, annotation: $annotation, changedValue: $changedValue, constructor: ${constructor.name})';
+  }
 }
 
 class ConstructorParameterApiChange extends ParameterApiChange {
@@ -472,4 +661,9 @@ class ConstructorParameterApiChange extends ParameterApiChange {
     super.newType,
     super.annotation,
   }) : super(parentName: constructor.name);
+
+  @override
+  toString() {
+    return 'ConstructorParameterApiChange(component: ${component.name}, operation: $operation, annotation: $annotation, changedValue: $changedValue, constructor: ${constructor.name}, parameter: ${parameter.name}, oldName: $oldName, newType: $newType)';
+  }
 }

lib/doc_comparator/api_change_formatter.dart

@@ -253,8 +253,32 @@ extension ApiChangeFormattingHelpers on List<ApiChange> {
       case ApiChangeOperation.dependencyVersionChange:
         return '📦 Dependency version changed: ${change.changedValue}';
 
-      case ApiChangeOperation.platformConstraintChange:
-        return '📱 Platform constraint changed: ${change.changedValue}';
+      case ApiChangeOperation.minDartSdkVersionDecrease:
+        return '🎯 Minimum Dart SDK version decreased: ${change.changedValue}';
+      case ApiChangeOperation.minDartSdkVersionIncrease:
+        return '🎯 Minimum Dart SDK version increased: ${change.changedValue}';
+      case ApiChangeOperation.maxDartSdkVersionDecrease:
+        return '🎯 Maximum Dart SDK version decreased: ${change.changedValue}';
+      case ApiChangeOperation.maxDartSdkVersionIncrease:
+        return '🎯 Maximum Dart SDK version increased: ${change.changedValue}';
+
+      case ApiChangeOperation.minFlutterSdkVersionDecrease:
+        return '🎯 Minimum Flutter SDK version decreased: ${change.changedValue}';
+      case ApiChangeOperation.minFlutterSdkVersionIncrease:
+        return '🎯 Minimum Flutter SDK version increased: ${change.changedValue}';
+      case ApiChangeOperation.maxFlutterSdkVersionDecrease:
+        return '🎯 Maximum Flutter SDK version decreased: ${change.changedValue}';
+      case ApiChangeOperation.maxFlutterSdkVersionIncrease:
+        return '🎯 Maximum Flutter SDK version increased: ${change.changedValue}';
+
+      case ApiChangeOperation.minAndroidSdkVersionDecrease:
+        return '🤖 Minimum Android SDK version decreased: ${change.changedValue}';
+      case ApiChangeOperation.minAndroidSdkVersionIncrease:
+        return '🤖 Minimum Android SDK version increased: ${change.changedValue}';
+      case ApiChangeOperation.minIosSdkVersionDecrease:
+        return '🍎 Minimum iOS SDK version decreased: ${change.changedValue}';
+      case ApiChangeOperation.minIosSdkVersionIncrease:
+        return '🍎 Minimum iOS SDK version increased: ${change.changedValue}';
 
       default:
         return '$entityName changed';