Fix batch (#290)

fixes rrousselGit/riverpod#3804

Author: rrousselGit

packages/custom_lint/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Unreleased 0.7.0
+
+- `custom_lint --fix` and the generated "Fix all <code>" assists
+  now correctly handle imports.
+- Now supports a broad number of analyzer version.
+
 ## 0.6.10 - 2024-10-10
 
 - Support installing custom_lint plugins in `dependencies:` instead of `dev_dependencies` (thanks to @dickermoshe).

packages/custom_lint/example/example_lint/lib/custom_lint_example_lint.dart

@@ -1,4 +1,7 @@
-import 'package:analyzer/error/error.dart' hide LintCode;
+import 'package:analyzer/error/error.dart'
+    hide
+        // ignore: undefined_hidden_name, necessary to support lower analyzer versions
+        LintCode;
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/source/source_range.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';

packages/custom_lint/example/example_lint/pubspec.yaml

@@ -12,9 +12,3 @@ dependencies:
 
 dev_dependencies:
   custom_lint:
-
-dependency_overrides:
-  custom_lint:
-    path: ../../../custom_lint
-  custom_lint_core:
-    path: ../../../custom_lint_core

packages/custom_lint/example/pubspec.yaml

@@ -11,11 +11,3 @@ dev_dependencies:
   custom_lint:
   custom_lint_example_lint:
     path: ./example_lint
-
-dependency_overrides:
-  custom_lint:
-    path: ../../custom_lint
-  custom_lint_builder:
-    path: ../../custom_lint_builder
-  custom_lint_core:
-    path: ../../custom_lint_core

packages/custom_lint/test/cli_process_test.dart

@@ -588,6 +588,61 @@ Analyzing...
       expect(process.exitCode, 1);
     });
 
+    test('Supports adding imports', () async {
+      final fixedPlugin = createPluginSource([
+        TestLintRule(
+          code: 'oy',
+          message: 'Oy',
+          onVariable: 'if (node.name.toString().endsWith("fixed")) return;',
+          fixes: [
+            TestLintFix(
+              name: 'OyFix',
+              dartBuilderCode: r'''
+builder.importLibrary(Uri.parse('package:path/path.dart'));
+
+builder.addSimpleReplacement(node.name.sourceRange, '${node.name}fixed');
+''',
+            ),
+          ],
+        ),
+      ]);
+
+      final plugin = createPlugin(name: 'test_lint', main: fixedPlugin);
+
+      final app = createLintUsage(
+        name: 'test_app',
+        source: {
+          'lib/main.dart': '''
+void fn() {}
+void fn2() {}
+''',
+        },
+        plugins: {'test_lint': plugin.uri},
+      );
+
+      final process = await Process.run(
+        'dart',
+        [customLintBinPath, '--fix'],
+        workingDirectory: app.path,
+      );
+
+      expect(trimDependencyOverridesWarning(process.stderr), isEmpty);
+
+      expect(app.file('lib', 'main.dart').readAsStringSync(), '''
+import 'package:path/path.dart';
+
+void fnfixed() {}
+void fn2fixed() {}
+''');
+
+      expect(process.stdout, '''
+Analyzing...
+
+No issues found!
+''');
+      expect(process.exitCode, 0);
+    });
+
     test('Can fix all lints', () async {
       final plugin = createPlugin(name: 'test_lint', main: fixedPlugin);
 

packages/custom_lint/test/cli_test.dart

@@ -1,7 +1,10 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:analyzer/error/error.dart' hide LintCode;
+import 'package:analyzer/error/error.dart'
+    hide
+        // ignore: undefined_hidden_name, Needed to support lower analyzer versions
+        LintCode;
 import 'package:custom_lint/src/output/output_format.dart';
 import 'package:test/test.dart';
 

packages/custom_lint/test/create_project.dart

@@ -1,7 +1,10 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:analyzer/error/error.dart' hide LintCode;
+import 'package:analyzer/error/error.dart'
+    hide
+        // ignore: undefined_hidden_name, Needed to support lower analyzer versions
+        LintCode;
 import 'package:path/path.dart';
 import 'package:test/scaffolding.dart';
 
@@ -100,10 +103,13 @@ class TestLintFix {
   TestLintFix({
     required this.name,
     this.nodeVisitor,
+    this.dartBuilderCode =
+        r"builder.addSimpleReplacement(node.name.sourceRange, '${node.name}fixed');",
   });
 
   final String name;
   final String? nodeVisitor;
+  final String? dartBuilderCode;
 
   void write(StringBuffer buffer, TestLintRule rule) {
     buffer.write('''
@@ -124,9 +130,9 @@ class $name extends DartFix {
         message: 'Fix ${rule.code}',
       );
 
-      ${nodeVisitor ?? r'''
+      ${nodeVisitor ?? '''
       changeBuilder.addDartFileEdit((builder) {
-        builder.addSimpleReplacement(node.name.sourceRange, '${node.name}fixed');
+        $dartBuilderCode
       });
 '''}
     });
@@ -251,6 +257,14 @@ dev_dependencies:
   custom_lint:
     path: ${PeerProjectMeta.current.customLintPath}
 ${installAsDevDependency ? pluginDependencies : ""}
+
+dependency_overrides:
+  custom_lint:
+    path: ${PeerProjectMeta.current.customLintPath}
+  custom_lint_core:
+    path: ${PeerProjectMeta.current.customLintCorePath}
+  custom_lint_builder:
+    path: ${PeerProjectMeta.current.customLintBuilderPath}
 ''',
     packageConfig: createPackageConfig(
       plugins: {...plugins, ...extraPackageConfig},

packages/custom_lint/test/fixes_test.dart

@@ -58,6 +58,8 @@ final multiChangeFixPlugin = createPluginSource([
   ),
 ]);
 
+const ignoreId = '<<ignore>>';
+
 void main() {
   test('Can emit fixes', () async {
     final plugin = createPlugin(
@@ -89,11 +91,7 @@ void fn2() {}
       [await fixes, await fixes2]
           .expand((e) => e.fixes)
           .expand((e) => e.fixes)
-          .where(
-            (e) =>
-                e.change.id != 'ignore_for_file' &&
-                e.change.id != 'ignore_for_line',
-          ),
+          .where((e) => e.change.id != ignoreId),
       sources: ({'**/*': mainSource}, relativePath: app.path),
       file: Directory.current.file(
         'test',
@@ -125,11 +123,7 @@ void fn() {}
     final fixes = await runner.getFixes(mainPath, 6);
 
     expectMatchesGoldenFixes(
-      fixes.fixes.expand((e) => e.fixes).where(
-            (e) =>
-                e.change.id != 'ignore_for_file' &&
-                e.change.id != 'ignore_for_line',
-          ),
+      fixes.fixes.expand((e) => e.fixes).where((e) => e.change.id != ignoreId),
       sources: ({'**/*': mainSource}, relativePath: app.path),
       file: Directory.current.file(
         'test',
@@ -169,11 +163,7 @@ void fn4() {}
     final fixes = await runner.getFixes(mainPath, 6);
 
     expectMatchesGoldenFixes(
-      fixes.fixes.expand((e) => e.fixes).where(
-            (e) =>
-                e.change.id != 'ignore_for_file' &&
-                e.change.id != 'ignore_for_line',
-          ),
+      fixes.fixes.expand((e) => e.fixes).where((e) => e.change.id != ignoreId),
       sources: ({'**/*': mainSource}, relativePath: app.path),
       file: Directory.current.file(
         'test',
@@ -211,11 +201,7 @@ void fn2() {}
       [await fixes, await fixes2]
           .expand((e) => e.fixes)
           .expand((e) => e.fixes)
-          .where(
-            (e) =>
-                e.change.id != 'ignore_for_file' &&
-                e.change.id != 'ignore_for_line',
-          ),
+          .where((e) => e.change.id != ignoreId),
       sources: ({'**/*': mainSource}, relativePath: app.path),
       file: Directory.current.file(
         'test',
@@ -253,11 +239,7 @@ void fn2() {}
       [await fixes, await fixes2]
           .expand((e) => e.fixes)
           .expand((e) => e.fixes)
-          .where(
-            (e) =>
-                e.change.id != 'ignore_for_file' &&
-                e.change.id != 'ignore_for_line',
-          ),
+          .where((e) => e.change.id != ignoreId),
       sources: ({'**/*': mainSource}, relativePath: app.path),
       file: Directory.current.file(
         'test',

packages/custom_lint/test/goldens.dart

@@ -55,9 +55,6 @@ String _encodePrioritizedSourceChanges(
     for (final prioritizedSourceChange in changes) {
       buffer.writeln('Message: `${prioritizedSourceChange.change.message}`');
       buffer.writeln('Priority: ${prioritizedSourceChange.priority}');
-      if (prioritizedSourceChange.change.id != null) {
-        buffer.writeln('Id: `${prioritizedSourceChange.change.id}`');
-      }
       if (prioritizedSourceChange.change.selection case final selection?) {
         buffer.writeln(
           'Selection: offset ${selection.offset} ; '

packages/custom_lint/test/goldens/fixes/add_ignore.diff

@@ -1,6 +1,5 @@
 Message: `Ignore "hello_world" for line`
 Priority: 1
-Id: `ignore_for_line`
 Diff for file `lib/main.dart:1`:
 ```
 - void fn() {}
@@ -12,7 +11,6 @@ void fn2() {}
 ---
 Message: `Ignore "hello_world" for file`
 Priority: 0
-Id: `ignore_for_file`
 Diff for file `lib/main.dart:1`:
 ```
 - void fn() {}
@@ -24,7 +22,6 @@ void fn2() {}
 ---
 Message: `Ignore "hello_world" for line`
 Priority: 1
-Id: `ignore_for_line`
 Diff for file `lib/main.dart:3`:
 ```
 void fn() {}
@@ -38,7 +35,6 @@ void fn() {}
 ---
 Message: `Ignore "hello_world" for file`
 Priority: 0
-Id: `ignore_for_file`
 Diff for file `lib/main.dart:1`:
 ```
 - void fn() {}
@@ -50,7 +46,6 @@ void fn2() {}
 ---
 Message: `Ignore "hello_world" for line`
 Priority: 1
-Id: `ignore_for_line`
 Diff for file `lib/main.dart:5`:
 ```
 void fn2() {}
@@ -62,7 +57,6 @@ void fn2() {}
 ---
 Message: `Ignore "hello_world" for file`
 Priority: 0
-Id: `ignore_for_file`
 Diff for file `lib/main.dart:1`:
 ```
 - void fn() {}