feat: centralized package lint rule

abc873693 · Oct 13, 2024 · c2b8ad8 · c2b8ad8
1 parent b5e63d9
commit c2b8ad8
Show file tree

Hide file tree

Showing 14 changed files with 82 additions and 121 deletions.
diff --git a/packages/ap_common/analysis_options.yaml → analysis_options.yaml b/packages/ap_common/analysis_options.yaml → analysis_options.yaml
@@ -3,15 +3,14 @@ include: package:lint/strict.yaml
 analyzer:
   exclude:
     # l10n generated code
-    - lib/l10n/intl/*.dart
-    - lib/l10n/l10n.dart
-    - example/lib/l10n/intl/*.dart
-    - example/lib/l10n/l10n.dart
+    - packages/ap_common/lib/l10n/intl/*.dart
+    - packages/ap_common/lib/l10n/l10n.dart
+    - apps/example/lib/l10n/intl/*.dart
+    - apps/example/lib/l10n/l10n.dart
     # example
 #    - example/**
     # other generated files
-    - lib/models/*.g.dart
-    - lib/**/*.g.dart
+    - '**/*.g.dart'
 
 linter:
   rules:

diff --git a/packages/ap_common/pubspec.yaml b/packages/ap_common/pubspec.yaml
@@ -61,7 +61,6 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  lint: ^2.1.2
   build_runner: ^2.0.3
   json_serializable: ^6.3.0
   spider: ^4.2.2

diff --git a/packages/ap_common_core/analysis_options.yaml b/packages/ap_common_core/analysis_options.yaml
diff --git a/packages/ap_common_core/pubspec.yaml b/packages/ap_common_core/pubspec.yaml
@@ -20,6 +20,5 @@ dependencies:
   injector: ^4.0.0
 
 dev_dependencies:
-  lint: ^2.1.2
   build_runner: ^2.0.3
   json_serializable: ^6.3.0
diff --git a/packages/ap_common_firebase/lib/apcommonfirebase.dart b/packages/ap_common_firebase/lib/apcommonfirebase.dart
@@ -1,5 +1,3 @@
-library apcommonfirebase;
-
 /// A Calculator.
 class Calculator {
   /// Returns [value] plus 1.

diff --git a/packages/ap_common_firebase/lib/utils/firebase_analytics_utils.dart b/packages/ap_common_firebase/lib/utils/firebase_analytics_utils.dart
@@ -3,30 +3,31 @@ import 'dart:io';
 
 import 'package:ap_common/resources/ap_theme.dart';
 import 'package:ap_common_core/ap_common_core.dart';
+import 'package:ap_common_firebase/utils/firebase_utils.dart';
 import 'package:firebase_analytics/firebase_analytics.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
-import 'firebase_utils.dart';
-
 export 'package:firebase_analytics/firebase_analytics.dart';
 
 class FirebaseAnalyticsUtils extends AnalyticsUtil {
+  FirebaseAnalyticsUtils() {
+    if (isSupported) analytics = FirebaseAnalytics.instance;
+  }
+
   static FirebaseAnalyticsUtils? _instance;
 
   static bool get isSupported =>
-      (kIsWeb || Platform.isAndroid || Platform.isIOS || Platform.isMacOS);
+      kIsWeb || Platform.isAndroid || Platform.isIOS || Platform.isMacOS;
 
+  //ignore: prefer_constructors_over_static_methods
   static FirebaseAnalyticsUtils get instance {
     return _instance ??= FirebaseAnalyticsUtils();
   }
 
-  FirebaseAnalyticsUtils() {
-    if (isSupported) analytics = FirebaseAnalytics.instance;
-  }
-
   FirebaseAnalytics? analytics;
 
+  @override
   Future<void> setCurrentScreen(
     String screenName,
     String screenClassOverride,
@@ -37,11 +38,13 @@ class FirebaseAnalyticsUtils extends AnalyticsUtil {
     );
   }
 
+  @override
   Future<void> setUserId(String id) async {
     await analytics?.setUserId(id: id);
     debugPrint('setUserId succeeded');
   }
 
+  @override
   Future<void> setUserProperty(
     String name,
     String? value,
@@ -53,6 +56,7 @@ class FirebaseAnalyticsUtils extends AnalyticsUtil {
     debugPrint('setUserProperty $name succeeded');
   }
 
+  @override
   Future<void> logEvent(
     String name, {
     Map<String, dynamic>? parameters,
@@ -63,6 +67,7 @@ class FirebaseAnalyticsUtils extends AnalyticsUtil {
     );
   }
 
+  @override
   Future<void> logUserInfo(UserInfo? userInfo) async {
     if (userInfo == null) return;
     if (userInfo.department != null && userInfo.department!.isNotEmpty) {
@@ -93,8 +98,12 @@ class FirebaseAnalyticsUtils extends AnalyticsUtil {
     debugPrint('logUserInfo succeeded');
   }
 
-  Future<void> logApiEvent(String type, int status,
-      {String message = ''}) async {
+  @override
+  Future<void> logApiEvent(
+    String type,
+    int status, {
+    String message = '',
+  }) async {
     await analytics?.logEvent(
       name: 'ap_api',
       parameters: <String, dynamic>{
@@ -116,6 +125,7 @@ class FirebaseAnalyticsUtils extends AnalyticsUtil {
     debugPrint('log CalculateUnits succeeded');
   }
 
+  @override
   Future<void> logTimeEvent(String name, double seconds) async {
     await analytics?.logEvent(
       name: name,

diff --git a/packages/ap_common_firebase/lib/utils/firebase_crashlytics_utils.dart b/packages/ap_common_firebase/lib/utils/firebase_crashlytics_utils.dart
@@ -9,19 +9,20 @@ import 'package:flutter/foundation.dart';
 export 'package:firebase_crashlytics/firebase_crashlytics.dart';
 
 class FirebaseCrashlyticsUtils extends CrashlyticsUtil {
+  FirebaseCrashlyticsUtils() {
+    if (isSupported) crashlytics = FirebaseCrashlytics.instance;
+  }
+
   static FirebaseCrashlyticsUtils? _instance;
 
+  //ignore: prefer_constructors_over_static_methods
   static FirebaseCrashlyticsUtils get instance {
     return _instance ??= FirebaseCrashlyticsUtils();
   }
 
   static bool get isSupported =>
       !kIsWeb && (Platform.isAndroid || Platform.isIOS || Platform.isMacOS);
 
-  FirebaseCrashlyticsUtils() {
-    if (isSupported) crashlytics = FirebaseCrashlytics.instance;
-  }
-
   FirebaseCrashlytics? crashlytics;
 
   @override
@@ -31,13 +32,13 @@ class FirebaseCrashlyticsUtils extends CrashlyticsUtil {
 
   @override
   Future<void> recordError(
-    exception,
+    dynamic exception,
     StackTrace stack, {
-    reason,
+    dynamic reason,
     Iterable<Object>? information,
     bool? printDetails,
   }) async {
-    information ??= const [];
+    information ??= const <Object>[];
     await crashlytics?.recordError(
       exception,
       stack,

diff --git a/packages/ap_common_firebase/lib/utils/firebase_message_utils.dart b/packages/ap_common_firebase/lib/utils/firebase_message_utils.dart
@@ -1,38 +1,39 @@
+import 'dart:developer';
 import 'dart:io';
 
 import 'package:ap_common_core/ap_common_core.dart';
+import 'package:ap_common_firebase/utils/firebase_analytics_utils.dart';
 import 'package:ap_common_firebase/utils/firebase_utils.dart';
 import 'package:flutter/foundation.dart';
 import 'package:url_launcher/url_launcher.dart';
 
-import 'firebase_analytics_utils.dart';
-
 export 'package:firebase_messaging/firebase_messaging.dart';
 
-const NOTIFY_ID = 9919;
-const NOTIFY_ANDROID_CHANNEL_ID = '1000';
-const androidChannelDescription = 'FCM';
+const int notifyId = 9919;
+const String notifyAndroidChannelId = '1000';
+const String androidChannelDescription = 'FCM';
 
 class FirebaseMessagingUtils {
+  FirebaseMessagingUtils() {
+    if (isSupported) {
+      messaging = FirebaseMessaging.instance;
+    }
+  }
+
   static FirebaseMessagingUtils? _instance;
 
+  //ignore: prefer_constructors_over_static_methods
   static FirebaseMessagingUtils get instance {
     return _instance ??= FirebaseMessagingUtils();
   }
 
   static bool get isSupported =>
-      (kIsWeb || Platform.isAndroid || Platform.isIOS || Platform.isMacOS);
+      kIsWeb || Platform.isAndroid || Platform.isIOS || Platform.isMacOS;
 
   Future<bool> isBrowserSupported() async {
     return FirebaseMessaging.instance.isSupported();
   }
 
-  FirebaseMessagingUtils() {
-    if (isSupported) {
-      messaging = FirebaseMessaging.instance;
-    }
-  }
-
   FirebaseMessaging? messaging;
 
   Future<void> init({
@@ -45,10 +46,10 @@ class FirebaseMessagingUtils {
     }
     FirebaseMessaging.onMessage.listen((RemoteMessage message) async {
       if (message.notification != null) {
-        debugPrint("onMessage: $message");
+        debugPrint('onMessage: $message');
         NotificationUtil.instance.show(
-          id: NOTIFY_ID,
-          androidChannelId: NOTIFY_ANDROID_CHANNEL_ID,
+          id: notifyId,
+          androidChannelId: notifyAndroidChannelId,
           androidChannelDescription: androidChannelDescription,
           title: message.notification!.title ?? '',
           content: message.notification!.body ?? '',
@@ -63,34 +64,26 @@ class FirebaseMessagingUtils {
       }
     });
     FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) async {
-      debugPrint("onMessageOpenedApp: $message");
+      debugPrint('onMessageOpenedApp: $message');
       await navigateToItemDetail(
         message,
         onClick,
         customOnClickAction,
       );
     });
     FirebaseMessaging.onBackgroundMessage((RemoteMessage message) async {
-      debugPrint("onBackgroundMessage: $message");
+      debugPrint('onBackgroundMessage: $message');
       await navigateToItemDetail(
         message,
         onClick,
         customOnClickAction,
       );
     });
-    final value = await messaging?.requestPermission(
-      alert: true,
-      announcement: false,
-      badge: true,
-      carPlay: false,
-      criticalAlert: false,
-      provisional: false,
-      sound: true,
-    );
+    final NotificationSettings? value = await messaging?.requestPermission();
     if (value?.authorizationStatus == AuthorizationStatus.authorized) {
       messaging?.getToken(vapidKey: vapidKey).then((String? token) {
         if (token != null && kDebugMode) {
-          print("Push Messaging token: $token");
+          log('Push Messaging token: $token', name: 'firebase');
         }
       });
       FirebaseAnalyticsUtils.instance.setUserProperty(
@@ -106,12 +99,12 @@ class FirebaseMessagingUtils {
     Function(RemoteMessage)? onClick,
     bool customOnClickAction,
   ) async {
-    final data = message.data;
+    final Map<String, dynamic> data = message.data;
     if (customOnClickAction) {
       onClick?.call(message);
-    } else if (data['type'] == "1") {
+    } else if (data['type'] == '1') {
       launchUrl(
-        Uri.parse(data['url']),
+        Uri.parse(data['url'] as String),
       );
     } else {
       onClick?.call(message);

diff --git a/packages/ap_common_firebase/lib/utils/firebase_performance_utils.dart b/packages/ap_common_firebase/lib/utils/firebase_performance_utils.dart
@@ -6,20 +6,19 @@ import 'package:flutter/foundation.dart';
 export 'package:firebase_performance/firebase_performance.dart';
 
 class FirebasePerformancesUtils {
+  FirebasePerformancesUtils() {
+    if (isSupported) {
+      performance = FirebasePerformance.instance;
+    }
+  }
   static FirebasePerformancesUtils? _instance;
 
+  //ignore: prefer_constructors_over_static_methods
   static FirebasePerformancesUtils get instance {
     return _instance ??= FirebasePerformancesUtils();
   }
 
-  static bool get isSupported =>
-      kIsWeb || Platform.isAndroid || Platform.isIOS;
-
-  FirebasePerformancesUtils() {
-    if (isSupported) {
-      performance = FirebasePerformance.instance;
-    }
-  }
+  static bool get isSupported => kIsWeb || Platform.isAndroid || Platform.isIOS;
 
   FirebasePerformance? performance;
 

diff --git a/packages/ap_common_firebase/lib/utils/firebase_remote_config_utils.dart b/packages/ap_common_firebase/lib/utils/firebase_remote_config_utils.dart
@@ -7,20 +7,20 @@ import 'package:flutter/foundation.dart';
 export 'package:firebase_remote_config/firebase_remote_config.dart';
 
 class FirebaseRemoteConfigUtils {
+  FirebaseRemoteConfigUtils() {
+    if (isSupported) remoteConfig = FirebaseRemoteConfig.instance;
+  }
   static FirebaseRemoteConfigUtils? _instance;
 
+  //ignore: prefer_constructors_over_static_methods
   static FirebaseRemoteConfigUtils get instance {
     return _instance ??= FirebaseRemoteConfigUtils();
   }
 
-  FirebaseRemoteConfigUtils() {
-    if (isSupported) remoteConfig = FirebaseRemoteConfig.instance;
-  }
-
   FirebaseRemoteConfig? remoteConfig;
 
   static bool get isSupported =>
-      (kIsWeb || Platform.isAndroid || Platform.isIOS || Platform.isMacOS);
+      kIsWeb || Platform.isAndroid || Platform.isIOS || Platform.isMacOS;
 }
 
 extension RemoteConfigExtension on FirebaseRemoteConfig {