Migrate to flutter_lints (#788)

mvanbeusekom · web-flow · commit fecf2c4a17b6 · 2021-07-18T08:57:38.000+02:00
diff --git a/.github/workflows/geolocator.yaml b/.github/workflows/geolocator.yaml
@@ -1,6 +1,6 @@
 # This is a basic workflow to help you get started with Actions
 
-name: app_facing_package
+name: geolocator
 
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the develop branch
diff --git a/.github/workflows/geolocator_platform_interface.yaml b/.github/workflows/geolocator_platform_interface.yaml
@@ -1,6 +1,6 @@
 # This is a basic workflow to help you get started with Actions
 
-name: platform_interface_package
+name: geolocator_platform_interface
 
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the develop branch
diff --git a/.github/workflows/geolocator_web.yaml b/.github/workflows/geolocator_web.yaml
@@ -1,5 +1,5 @@
 # This is a basic workflow to help you get started with Actions
-name: web_implementation_package
+name: geolocator_web
 
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the develop branch
diff --git a/geolocator/README.md b/geolocator/README.md
@@ -1,6 +1,6 @@
 # Flutter Geolocator Plugin  
 
-[![pub package](https://img.shields.io/pub/v/geolocator.svg)](https://pub.dartlang.org/packages/geolocator) ![Build status](https://github.com/Baseflow/flutter-geolocator/workflows/app_facing_package/badge.svg?branch=master) [![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) [![codecov](https://codecov.io/gh/Baseflow/flutter-geolocator/branch/master/graph/badge.svg)](https://codecov.io/gh/Baseflow/flutter-geolocator)
+[![pub package](https://img.shields.io/pub/v/geolocator.svg)](https://pub.dartlang.org/packages/geolocator) ![Build status](https://github.com/Baseflow/flutter-geolocator/workflows/geolocator/badge.svg?branch=master) [![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) [![codecov](https://codecov.io/gh/Baseflow/flutter-geolocator/branch/master/graph/badge.svg)](https://codecov.io/gh/Baseflow/flutter-geolocator)
 
 A Flutter geolocation plugin which provides easy access to platform specific location services ([FusedLocationProviderClient](https://developers.google.com/android/reference/com/google/android/gms/location/FusedLocationProviderClient) or if not available the [LocationManager](https://developer.android.com/reference/android/location/LocationManager) on Android and [CLLocationManager](https://developer.apple.com/documentation/corelocation/cllocationmanager) on iOS).
 
diff --git a/geolocator_platform_interface/CHANGELOG.md b/geolocator_platform_interface/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.3.3
+
+- Migrated to [flutter_lints](https://pub.dev/packages/flutter_lints) as linter rule set as it replaces the deprecated [effective_dart](https://pub.dev/packages/effective_dart) package.
+
 ## 2.3.2
 
 - Added the possibility to pass your own purposeKey name to the requestTemporaryFullAccuracy method.
diff --git a/geolocator_platform_interface/README.md b/geolocator_platform_interface/README.md
@@ -1,6 +1,6 @@
 # geolocator_platform_interface
 
-[![pub package](https://img.shields.io/pub/v/geolocator_platform_interface.svg)](https://pub.dartlang.org/packages/geolocator_platform_interface) ![Build status](https://github.com/Baseflow/flutter-geolocator/workflows/platform_interface_package/badge.svg?branch=master) [![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart)
+[![pub package](https://img.shields.io/pub/v/geolocator_platform_interface.svg)](https://pub.dartlang.org/packages/geolocator_platform_interface) ![Build status](https://github.com/Baseflow/flutter-geolocator/workflows/geolocator_platform_interface/badge.svg?branch=master) [![style: flutter_lints](https://img.shields.io/badge/style-flutter_lints-40c4ff.svg)](https://pub.dev/packages/flutter_lints)
 
 A common platform interface for the [`geolocator`][1] plugin.
 
diff --git a/geolocator_platform_interface/analysis_options.yaml b/geolocator_platform_interface/analysis_options.yaml
@@ -1,4 +1,5 @@
-include: package:effective_dart/analysis_options.yaml
+include: package:flutter_lints/flutter.yaml
+
 analyzer:
   exclude:
     # Ignore generated files
diff --git a/geolocator_platform_interface/lib/src/geolocator_platform_interface.dart b/geolocator_platform_interface/lib/src/geolocator_platform_interface.dart
@@ -21,7 +21,7 @@ abstract class GeolocatorPlatform extends PlatformInterface {
   /// Constructs a GeolocatorPlatform.
   GeolocatorPlatform() : super(token: _token);
 
-  static final Object _token = const Object();
+  static const Object _token = Object();
 
   static GeolocatorPlatform _instance = MethodChannelGeolocator();
 
diff --git a/geolocator_platform_interface/lib/src/implementations/method_channel_geolocator.dart b/geolocator_platform_interface/lib/src/implementations/method_channel_geolocator.dart
@@ -246,9 +246,9 @@ class MethodChannelGeolocator extends GeolocatorPlatform {
       case 'ACTIVITY_MISSING':
         throw ActivityMissingException(exception.message);
       case 'LOCATION_SERVICES_DISABLED':
-        throw LocationServiceDisabledException();
+        throw const LocationServiceDisabledException();
       case 'LOCATION_SUBSCRIPTION_ACTIVE':
-        throw AlreadySubscribedException();
+        throw const AlreadySubscribedException();
       case 'PERMISSION_DEFINITIONS_NOT_FOUND':
         throw PermissionDefinitionsNotFoundException(exception.message);
       case 'PERMISSION_DENIED':
diff --git a/geolocator_platform_interface/lib/src/models/position.dart b/geolocator_platform_interface/lib/src/models/position.dart
@@ -6,7 +6,7 @@ class Position {
   /// Constructs an instance with the given values for testing. [Position]
   /// instances constructed this way won't actually reflect any real information
   /// from the platform, just whatever was passed in at construction time.
-  Position({
+  const Position({
     required this.longitude,
     required this.latitude,
     required this.timestamp,
@@ -75,18 +75,18 @@ class Position {
   final bool isMocked;
 
   @override
-  bool operator ==(Object o) {
-    var areEqual = o is Position &&
-        o.accuracy == accuracy &&
-        o.altitude == altitude &&
-        o.heading == heading &&
-        o.latitude == latitude &&
-        o.longitude == longitude &&
-        o.floor == o.floor &&
-        o.speed == speed &&
-        o.speedAccuracy == speedAccuracy &&
-        o.timestamp == timestamp &&
-        o.isMocked == isMocked;
+  bool operator ==(Object other) {
+    var areEqual = other is Position &&
+        other.accuracy == accuracy &&
+        other.altitude == altitude &&
+        other.heading == heading &&
+        other.latitude == latitude &&
+        other.longitude == longitude &&
+        other.floor == floor &&
+        other.speed == speed &&
+        other.speedAccuracy == speedAccuracy &&
+        other.timestamp == timestamp &&
+        other.isMocked == isMocked;
 
     return areEqual;
   }
diff --git a/geolocator_platform_interface/pubspec.yaml b/geolocator_platform_interface/pubspec.yaml
@@ -3,7 +3,7 @@ description: A common platform interface for the geolocator plugin.
 homepage: https://github.com/baseflow/flutter-geolocator
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 2.3.2
+version: 2.3.3
 
 dependencies:
   flutter:
@@ -17,7 +17,7 @@ dev_dependencies:
   async: ^2.5.0
   flutter_test:
     sdk: flutter
-  effective_dart: ^1.3.0
+  flutter_lints: ^1.0.4
   mockito: ^5.0.0-nullsafety.7
 
 environment:
diff --git a/geolocator_platform_interface/test/geolocator_platform_interface_test.dart b/geolocator_platform_interface/test/geolocator_platform_interface_test.dart
@@ -189,8 +189,8 @@ void main() {
 
   group('distanceBetween: When requesting the distance between points', () {
     test('the distance should be zero between the same points', () {
-      final latitude = 52.561270;
-      final longitude = 5.639382;
+      const latitude = 52.561270;
+      const longitude = 5.639382;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final distance = geolocatorPlatform.distanceBetween(
@@ -200,10 +200,10 @@ void main() {
     });
 
     test('the distance should always be non negative', () {
-      final startLatitude = 52.561270;
-      final startLongitude = 5.639382;
-      final endLatitude = 52.157296;
-      final endLongitude = 5.3851278;
+      const startLatitude = 52.561270;
+      const startLongitude = 5.639382;
+      const endLatitude = 52.157296;
+      const endLongitude = 5.3851278;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final firstDistance = geolocatorPlatform.distanceBetween(
@@ -217,11 +217,11 @@ void main() {
     });
 
     test('the distance should be in range', () {
-      final startLatitude = 52.1058731;
-      final startLongitude = 5.9076873;
-      final endLatitude = 52.157296;
-      final endLongitude = 5.3851278;
-      final expectedDistance = 36164.15150480236;
+      const startLatitude = 52.1058731;
+      const startLongitude = 5.9076873;
+      const endLatitude = 52.157296;
+      const endLongitude = 5.3851278;
+      const expectedDistance = 36164.15150480236;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final distance = geolocatorPlatform.distanceBetween(
@@ -236,8 +236,8 @@ void main() {
 
   group('bearingBetween: When requesting the bearing between points', () {
     test('the same points the bearing should be 0', () async {
-      final latitude = 56.0;
-      final longitude = 5.6;
+      const latitude = 56.0;
+      const longitude = 5.6;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final bearing = geolocatorPlatform.bearingBetween(
@@ -251,10 +251,10 @@ void main() {
     });
 
     test('the North pole to the Sounth pole bearing should be 180', () async {
-      final startLatitude = 90.0;
-      final startLongitude = 0.0;
-      final endLatitude = -90.0;
-      final endLongitude = 0.0;
+      const startLatitude = 90.0;
+      const startLongitude = 0.0;
+      const endLatitude = -90.0;
+      const endLongitude = 0.0;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final bearing = geolocatorPlatform.bearingBetween(
@@ -268,10 +268,10 @@ void main() {
     });
 
     test('the South pole to the North pole bearing should be 0', () async {
-      final startLatitude = -90.0;
-      final startLongitude = 0.0;
-      final endLatitude = 90.0;
-      final endLongitude = 0.0;
+      const startLatitude = -90.0;
+      const startLongitude = 0.0;
+      const endLatitude = 90.0;
+      const endLongitude = 0.0;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final bearing = geolocatorPlatform.bearingBetween(
@@ -285,10 +285,10 @@ void main() {
     });
 
     test('the West to the East bearing should be 90', () async {
-      final startLatitude = 0.0;
-      final startLongitude = 180.0;
-      final endLatitude = 0.0;
-      final endLongitude = -180.0;
+      const startLatitude = 0.0;
+      const startLongitude = 180.0;
+      const endLatitude = 0.0;
+      const endLongitude = -180.0;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final bearing = geolocatorPlatform.bearingBetween(
@@ -302,10 +302,10 @@ void main() {
     });
 
     test('the East to the West bearing should be -90', () async {
-      final startLatitude = 0.0;
-      final startLongitude = -180.0;
-      final endLatitude = 0.0;
-      final endLongitude = 180.0;
+      const startLatitude = 0.0;
+      const startLongitude = -180.0;
+      const endLatitude = 0.0;
+      const endLongitude = 180.0;
       final geolocatorPlatform = ExtendsGeolocatorPlatform();
 
       final bearing = geolocatorPlatform.bearingBetween(
diff --git a/geolocator_platform_interface/test/src/enums/location_accuracy_test.dart b/geolocator_platform_interface/test/src/enums/location_accuracy_test.dart
@@ -3,13 +3,13 @@ import 'package:geolocator_platform_interface/geolocator_platform_interface.dart
 
 void main() {
   test('LocationAccuracy should contain 7 options', () {
-    final values = LocationAccuracy.values;
+    const values = LocationAccuracy.values;
 
     expect(values.length, 7);
   });
 
   test("LocationAccuracy enum should have items in correct index", () {
-    final values = LocationAccuracy.values;
+    const values = LocationAccuracy.values;
 
     expect(values[0], LocationAccuracy.lowest);
     expect(values[1], LocationAccuracy.low);
diff --git a/geolocator_platform_interface/test/src/enums/location_permission_test.dart b/geolocator_platform_interface/test/src/enums/location_permission_test.dart
@@ -3,13 +3,13 @@ import 'package:geolocator_platform_interface/geolocator_platform_interface.dart
 
 void main() {
   test('LocationPermission should contain 4 options', () {
-    final values = LocationPermission.values;
+    const values = LocationPermission.values;
 
     expect(values.length, 4);
   });
 
   test('LocationPermission enum should have items in correct index', () {
-    final values = LocationPermission.values;
+    const values = LocationPermission.values;
 
     expect(values[0], LocationPermission.denied);
     expect(values[1], LocationPermission.deniedForever);
diff --git a/geolocator_platform_interface/test/src/errors/activity_missing_exception_test.dart b/geolocator_platform_interface/test/src/errors/activity_missing_exception_test.dart
@@ -5,11 +5,11 @@ void main() {
   test('toString: Should return the default description when message is null',
       () {
     // Arrange
-    final expected =
+    const expected =
         'Activity is missing. This might happen when running a certain '
         'function from the background that requires a UI element (e.g. '
         'requesting permissions or enabling the location services).';
-    final exception = ActivityMissingException(null);
+    const exception = ActivityMissingException(null);
 
     // Act
     final actual = exception.toString();
@@ -21,11 +21,11 @@ void main() {
   test('toString: Should return the default description when message is empty',
       () {
     // Arrange
-    final expected =
+    const expected =
         'Activity is missing. This might happen when running a certain '
         'function from the background that requires a UI element (e.g. '
         'requesting permissions or enabling the location services).';
-    final exception = ActivityMissingException('');
+    const exception = ActivityMissingException('');
 
     // Act
     final actual = exception.toString();
@@ -36,8 +36,8 @@ void main() {
 
   test('toString: Should return the message as description', () {
     // Arrange
-    final expected = 'Dummy error message.';
-    final exception = ActivityMissingException(expected);
+    const expected = 'Dummy error message.';
+    const exception = ActivityMissingException(expected);
 
     // Act
     final actual = exception.toString();
diff --git a/geolocator_platform_interface/test/src/errors/already_subscribed_exception_test.dart b/geolocator_platform_interface/test/src/errors/already_subscribed_exception_test.dart
@@ -4,10 +4,10 @@ import 'package:geolocator_platform_interface/geolocator_platform_interface.dart
 void main() {
   test('toString: Should return a description of the exception', () {
     // Arrange
-    final expected = 'The App is already listening to a stream of position '
+    const expected = 'The App is already listening to a stream of position '
         'updates. It is not possible to listen to more then one stream at the '
         'same time.';
-    final exception = AlreadySubscribedException();
+    const exception = AlreadySubscribedException();
 
     // Act
     final actual = exception.toString();
diff --git a/geolocator_platform_interface/test/src/errors/invalid_permission_exception_test.dart b/geolocator_platform_interface/test/src/errors/invalid_permission_exception_test.dart
@@ -6,8 +6,8 @@ void main() {
       'valueToConvert: Should return the value that should have been converted',
       () {
     // Arrange
-    final expected = 5;
-    final exception = InvalidPermissionException(expected);
+    const expected = 5;
+    const exception = InvalidPermissionException(expected);
 
     // Act
     final actual = exception.valueToConvert;
@@ -18,9 +18,9 @@ void main() {
 
   test('toString: Should return a description of the exception', () {
     // Arrange
-    final expected =
+    const expected =
         'Unable to convert the value "5" into a LocationPermission.';
-    final exception = InvalidPermissionException(5);
+    const exception = InvalidPermissionException(5);
 
     // Act
     final actual = exception.toString();
diff --git a/geolocator_platform_interface/test/src/errors/location_service_disabled_exception_test.dart b/geolocator_platform_interface/test/src/errors/location_service_disabled_exception_test.dart
@@ -4,8 +4,8 @@ import 'package:geolocator_platform_interface/geolocator_platform_interface.dart
 void main() {
   test('toString: Should return a description of the exception', () {
     // Arrange
-    final expected = 'The location service on the device is disabled.';
-    final exception = LocationServiceDisabledException();
+    const expected = 'The location service on the device is disabled.';
+    const exception = LocationServiceDisabledException();
 
     // Act
     final actual = exception.toString();
diff --git a/geolocator_platform_interface/test/src/errors/permission_definitions_not_found_exception_test.dart b/geolocator_platform_interface/test/src/errors/permission_definitions_not_found_exception_test.dart
diff --git a/geolocator_platform_interface/test/src/errors/permission_denied_exception_test.dart b/geolocator_platform_interface/test/src/errors/permission_denied_exception_test.dart
diff --git a/geolocator_platform_interface/test/src/errors/permission_request_in_progress_exception_test.dart b/geolocator_platform_interface/test/src/errors/permission_request_in_progress_exception_test.dart
diff --git a/geolocator_platform_interface/test/src/errors/position_update_exception_test.dart b/geolocator_platform_interface/test/src/errors/position_update_exception_test.dart
diff --git a/geolocator_platform_interface/test/src/extensions/integer_extensions_test.dart b/geolocator_platform_interface/test/src/extensions/integer_extensions_test.dart
diff --git a/geolocator_platform_interface/test/src/implementations/method_channel_geolocator_test.dart b/geolocator_platform_interface/test/src/implementations/method_channel_geolocator_test.dart
