chore(shorebird_cli): improve error message when Flutter project does…

… not support macOS
shorebirdtech · Jan 16, 2025 · 22fcbca · 22fcbca
1 parent a5c9edf
commit 22fcbca
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/packages/shorebird_cli/lib/src/validators/macos_network_entitlement_validator.dart b/packages/shorebird_cli/lib/src/validators/macos_network_entitlement_validator.dart
@@ -48,8 +48,13 @@ class MacosNetworkEntitlementValidator extends Validator {
   String get description => 'macOS app has Outgoing Connections entitlement';
 
   @override
-  bool canRunInCurrentContext() =>
-      _macosDirectory != null && _macosDirectory!.existsSync();
+  bool canRunInCurrentContext() => _macosDirectory?.existsSync() ?? false;
+
+  @override
+  String? get incorrectContextMessage => '''
+The ${_macosDirectory?.path ?? 'macos'} directory does not exist.
+
+The command you are running must be run within a Flutter app project that supports the macOS platform.''';
 
   @override
   Future<List<ValidationIssue>> validate() async {

diff --git a/packages/shorebird_cli/test/src/validators/macos_network_entitlement_validator_test.dart b/packages/shorebird_cli/test/src/validators/macos_network_entitlement_validator_test.dart
@@ -91,6 +91,10 @@ void main() {
             runWithOverrides(() => validator.canRunInCurrentContext()),
             isTrue,
           );
+          expect(
+            runWithOverrides(() => validator.incorrectContextMessage),
+            isNull,
+          );
         });
       });
 
@@ -100,6 +104,12 @@ void main() {
             runWithOverrides(() => validator.canRunInCurrentContext()),
             isFalse,
           );
+          expect(
+            runWithOverrides(() => validator.incorrectContextMessage),
+            contains(
+              '''The command you are running must be run within a Flutter app project that supports the macOS platform.''',
+            ),
+          );
         });
       });
     });