Use custom lints (#1948)

* set up `custom_lint` in all packages

* gitignore all custom_lint.log files

* fix new lint warnings

* update prepare-* workflows to run custom_lint

* delete analysis_options in directories that do not have pubspec.yaml

This is needed because of bug in custom_lint: invertase/dart_custom_lint#148

* fix tests

.github/workflows/adb-prepare.yaml

@@ -35,8 +35,11 @@ jobs:
       - name: dart test
         run: dart test
 
-      - name: dart analyze
-        run: dart analyze
+      - name: Run analyzer
+        if: success() || failure()
+        run: |
+          dart analyze
+          dart run custom_lint
 
       - name: dart format
         run: dart format --set-exit-if-changed .

.github/workflows/patrol-prepare.yaml

@@ -226,9 +226,11 @@ jobs:
         if: success() || failure()
         run: flutter test --coverage
 
-      - name: flutter analyze
+      - name: Run analyzer
         if: success() || failure()
-        run: flutter analyze
+        run: |
+          flutter analyze
+          dart run custom_lint
 
       - name: dart format
         if: success() || failure()

.github/workflows/patrol_cli-prepare.yaml

@@ -49,8 +49,11 @@ jobs:
           dart test --coverage coverage
           dart run coverage:format_coverage --lcov --in coverage --out coverage/lcov.info --report-on lib
 
-      - name: dart analyze
-        run: dart analyze
+      - name: Run analyzer
+        if: success() || failure()
+        run: |
+          flutter analyze
+          dart run custom_lint
 
       - name: dart format
         run: dart format --set-exit-if-changed .

.github/workflows/patrol_devtools_extension-prepare.yaml

@@ -38,9 +38,11 @@ jobs:
         if: success() || failure()
         run: flutter test --coverage
 
-      - name: flutter analyze
+      - name: Run analyzer
         if: success() || failure()
-        run: flutter analyze
+        run: |
+          flutter analyze
+          dart run custom_lint
 
       - name: dart format
         if: success() || failure()

.github/workflows/patrol_finders-prepare.yaml

@@ -38,9 +38,11 @@ jobs:
         if: success() || failure()
         run: flutter test --coverage
 
-      - name: flutter analyze
+      - name: Run analyzer
         if: success() || failure()
-        run: flutter analyze
+        run: |
+          flutter analyze
+          dart run custom_lint
 
       - name: dart format
         if: success() || failure()

.github/workflows/patrol_gen-prepare.yaml

@@ -32,9 +32,11 @@ jobs:
       - name: dart pub get
         run: dart pub get
 
-      - name: dart analyze
+      - name: Run analyzer
         if: success() || failure()
-        run: dart analyze
+        run: |
+          dart analyze
+          dart run custom_lint
 
       - name: dart format
         if: success() || failure()

.gitignore

@@ -10,3 +10,4 @@
 *.iml
 /pubspec.lock
 pubspec_overrides.yaml
+custom_lint.log

packages/adb/analysis_options.yaml

@@ -1 +1,5 @@
 include: package:leancode_lint/analysis_options_package.yaml
+
+analyzer:
+  plugins:
+    - custom_lint

packages/adb/pubspec.yaml

@@ -8,6 +8,7 @@ environment:
   sdk: '>=3.2.0 <4.0.0'
 
 dev_dependencies:
+  custom_lint: ^0.5.7
   leancode_lint: ^7.0.0+1
   mocktail: ^1.0.1
   test: ^1.24.9

packages/patrol/analysis_options.yaml

@@ -1,5 +1,7 @@
 include: package:leancode_lint/analysis_options_package.yaml
 
 analyzer:
+  plugins:
+    - custom_lint
   exclude:
     - lib/**/*.g.dart

packages/patrol/lib/src/devtools_service_extensions/devtools_service_extensions.dart

@@ -1,6 +1,7 @@
 // ignore_for_file: public_member_api_docs
 
 import 'dart:convert';
+
 import 'package:flutter/widgets.dart';
 import 'package:http/http.dart' as http;
 import 'package:patrol/src/native/contracts/contracts.dart';
@@ -47,9 +48,9 @@ class DevtoolsServiceExtensions {
         'result': res,
         'success': true,
       };
-    } catch (e, t) {
+    } catch (err, st) {
       return <String, dynamic>{
-        'result': '$e $t',
+        'result': '$err $st',
         'success': false,
       };
     }

packages/patrol/pubspec.yaml

@@ -31,6 +31,7 @@ dependencies:
 
 dev_dependencies:
   build_runner: ^2.4.6
+  custom_lint: ^0.5.7
   json_serializable: ^6.7.1
   leancode_lint: ^7.0.0+1
 

packages/patrol_cli/analysis_options.yaml

@@ -1 +1,5 @@
 include: package:leancode_lint/analysis_options.yaml
+
+analyzer:
+  plugins:
+    - custom_lint

packages/patrol_cli/pubspec.yaml

@@ -36,6 +36,7 @@ dependencies:
   yaml: ^3.1.2
 dev_dependencies:
   build_runner: ^2.4.6
+  custom_lint: ^0.5.7
   fake_async: ^1.3.1
   leancode_lint: ^7.0.0+1
   mocktail: ^1.0.1

packages/patrol_cli/test/commands/patrol_command_runner_test.dart

@@ -34,7 +34,7 @@ void main() {
       ).thenAnswer((_) async => version);
 
       commandRunner = PatrolCommandRunner(
-        platform: FakePlatform(),
+        platform: FakePlatform(environment: {}),
         processManager: FakeProcessManager(),
         pubUpdater: pubUpdater,
         fs: MemoryFileSystem.test(),

packages/patrol_cli/test/crossplatform/app_options_test.dart

@@ -10,13 +10,13 @@ void main() {
 
     group('correctly encodes default invocation', () {
       test('on Windows', () {
-        final flutterOptions = FlutterAppOptions(
+        const flutterOptions = FlutterAppOptions(
           target: r'C:\Users\john\app\integration_test\app_test.dart',
           buildMode: BuildMode.debug,
           flavor: null,
           dartDefines: {},
         );
-        options = AndroidAppOptions(flutter: flutterOptions);
+        options = const AndroidAppOptions(flutter: flutterOptions);
 
         final invocation =
             options.toGradleAssembleTestInvocation(isWindows: true);
@@ -31,13 +31,13 @@ void main() {
       });
 
       test('on macOS', () {
-        final flutterOpts = FlutterAppOptions(
+        const flutterOpts = FlutterAppOptions(
           target: '/Users/john/app/integration_test/app_test.dart',
           buildMode: BuildMode.release,
           flavor: null,
           dartDefines: {},
         );
-        options = AndroidAppOptions(flutter: flutterOpts);
+        options = const AndroidAppOptions(flutter: flutterOpts);
 
         final invocation =
             options.toGradleAssembleTestInvocation(isWindows: false);
@@ -60,13 +60,13 @@ void main() {
       };
 
       test('on Windows', () {
-        final flutterOpts = FlutterAppOptions(
+        const flutterOpts = FlutterAppOptions(
           target: r'C:\Users\john\app\integration_test\app_test.dart',
           buildMode: BuildMode.release,
           flavor: 'dev',
           dartDefines: dartDefines,
         );
-        options = AndroidAppOptions(flutter: flutterOpts);
+        options = const AndroidAppOptions(flutter: flutterOpts);
 
         final invocation =
             options.toGradleAssembleTestInvocation(isWindows: true);
@@ -82,13 +82,13 @@ void main() {
       });
 
       test('on macOS', () {
-        final flutterOpts = FlutterAppOptions(
+        const flutterOpts = FlutterAppOptions(
           target: '/Users/john/app/integration_test/app_test.dart',
           buildMode: BuildMode.debug,
           flavor: 'dev',
           dartDefines: dartDefines,
         );
-        options = AndroidAppOptions(flutter: flutterOpts);
+        options = const AndroidAppOptions(flutter: flutterOpts);
 
         final invocation =
             options.toGradleAssembleTestInvocation(isWindows: false);
@@ -109,7 +109,7 @@ void main() {
     late IOSAppOptions options;
 
     group('correctly encodes default xcodebuild invocation for simulator', () {
-      final flutterOpts = FlutterAppOptions(
+      const flutterOpts = FlutterAppOptions(
         target: 'integration_test/app_test.dart',
         buildMode: BuildMode.debug,
         flavor: null,
@@ -185,7 +185,7 @@ void main() {
     group(
       'correctly encodes customized xcodebuild invocation for real device',
       () {
-        final flutterOpts = FlutterAppOptions(
+        const flutterOpts = FlutterAppOptions(
           target: 'integration_test/app_test.dart',
           buildMode: BuildMode.release,
           flavor: 'prod',

packages/patrol_devtools_extension/analysis_options.yaml

@@ -1,5 +1,7 @@
 include: package:leancode_lint/analysis_options.yaml
 
 analyzer:
+  plugins:
+    - custom_lint
   exclude:
     - lib/**/*.g.dart

packages/patrol_devtools_extension/lib/api/contracts.dart

@@ -300,9 +300,9 @@ class NativeView with EquatableMixin {
   final bool focused;
   final bool enabled;
   final int? childCount;
-  //TODO: rename to "resourceId" for consistency
+  // TODO: rename to "resourceId" for consistency
   final String? resourceName;
-  //TODO: rename to "pkg" for consistency
+  // TODO: rename to "pkg" for consistency
   final String? applicationPackage;
   final List<NativeView> children;
 

packages/patrol_devtools_extension/lib/api/patrol_service_extension_api.dart

@@ -58,7 +58,7 @@ class PatrolServiceExtensionApi {
       final extensionName = 'ext.flutter.$methodName';
       final r = await _service.callServiceExtension(
         extensionName,
-        isolateId: _isolate.value!.id, //Verify
+        isolateId: _isolate.value!.id,
         args: args,
       );
 
@@ -70,8 +70,8 @@ class PatrolServiceExtensionApi {
       final res = resultFactory(json['result']);
 
       return ApiSuccess(res);
-    } catch (e, t) {
-      return ApiFailure(e, t);
+    } catch (err, st) {
+      return ApiFailure(err, st);
     }
   }
 }

packages/patrol_devtools_extension/pubspec.yaml

@@ -21,6 +21,7 @@ dependencies:
   vm_service: ^11.0.0
 
 dev_dependencies:
+  custom_lint: ^0.5.7
   flutter_test:
     sdk: flutter
   leancode_lint: ^7.0.0+1

packages/patrol_finders/analysis_options.yaml

@@ -1 +1,5 @@
 include: package:leancode_lint/analysis_options_package.yaml
+
+analyzer:
+  plugins:
+    - custom_lint