Another attempt

Author: Jonas Greifenhain

packages/amplify_lints/lib/amplify_lints.dart

@@ -3,10 +3,9 @@
 
 /// Custom lint rules for Amplify Flutter packages.
 ///
-/// This package provides an analyzer plugin that is automatically discovered
-/// by the Dart Analysis Server when enabled in `analysis_options.yaml`.
+/// This library is the entry point for the custom_lint plugin.
+/// It is automatically discovered by the `custom_lint` package.
 library amplify_lints;
 
-export 'src/fixes/add_license_header_fix.dart' show AddLicenseHeaderFix;
 export 'src/lints/missing_license_header.dart' show MissingLicenseHeader;
-export 'src/plugin.dart' show AmplifyLintsPlugin;
+export 'src/plugin.dart' show createPlugin;

packages/amplify_lints/lib/app.yaml

@@ -2,7 +2,7 @@ include: package:flutter_lints/flutter.yaml
 
 analyzer:
   plugins:
-    amplify_lints:
+    - custom_lint
   language:
     strict-casts: true
     strict-inference: true

packages/amplify_lints/lib/library.yaml

@@ -2,7 +2,7 @@ include: package:lints/recommended.yaml
 
 analyzer:
   plugins:
-    amplify_lints:
+    - custom_lint
   language:
     strict-casts: true
     strict-inference: true

packages/amplify_lints/lib/main.dart

@@ -1,15 +1,14 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import 'package:analyzer/analysis_rule/analysis_rule.dart';
-import 'package:analyzer/analysis_rule/rule_context.dart';
-import 'package:analyzer/analysis_rule/rule_visitor_registry.dart';
-import 'package:analyzer/dart/ast/ast.dart';
-import 'package:analyzer/dart/ast/visitor.dart';
-import 'package:analyzer/error/error.dart';
+import 'dart:io';
+
+import 'package:analyzer/error/error.dart' show AnalysisError, ErrorSeverity;
+import 'package:analyzer/error/listener.dart';
+import 'package:custom_lint_builder/custom_lint_builder.dart';
 
 /// The expected license header lines.
-const licenseHeader = [
+const _licenseHeader = [
   '// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.',
   '// SPDX-License-Identifier: Apache-2.0',
 ];
@@ -29,64 +28,82 @@ const licenseHeader = [
 /// ```dart
 /// library my_library;
 /// ```
-class MissingLicenseHeader extends AnalysisRule {
+class MissingLicenseHeader extends DartLintRule {
   /// Creates a new [MissingLicenseHeader] lint rule.
-  MissingLicenseHeader()
-      : super(
-          name: 'missing_license_header',
-          description:
-              'Dart files must start with the Amazon copyright and '
-              'Apache-2.0 license header.',
-        );
+  const MissingLicenseHeader() : super(code: _code);
 
-  /// The lint code reported by this rule.
-  static const LintCode code = LintCode(
-    'missing_license_header',
-    'Dart files must start with the Amazon copyright and Apache-2.0 '
-    'license header.',
+  static const _code = LintCode(
+    name: 'missing_license_header',
+    problemMessage:
+        'Dart files must start with the Amazon copyright and Apache-2.0 '
+        'license header.',
     correctionMessage: 'Add the license header to the top of this file.',
+    errorSeverity: ErrorSeverity.WARNING,
   );
 
   @override
-  LintCode get diagnosticCode => code;
-
-  @override
-  void registerNodeProcessors(
-    RuleVisitorRegistry registry,
-    RuleContext context,
+  void run(
+    CustomLintResolver resolver,
+    ErrorReporter reporter,
+    CustomLintContext context,
   ) {
-    final visitor = _Visitor(this, context);
-    registry.addCompilationUnit(this, visitor);
-  }
-}
-
-class _Visitor extends SimpleAstVisitor<void> {
-  _Visitor(this.rule, this.context);
+    context.registry.addCompilationUnit((node) {
+      final path = resolver.path;
 
-  final AnalysisRule rule;
-  final RuleContext context;
+      // Read the raw file content to check for comments (which are not
+      // present in the AST returned by toSource()).
+      final file = File(path);
+      if (!file.existsSync()) return;
 
-  @override
-  void visitCompilationUnit(CompilationUnit node) {
-    final unit = context.currentUnit;
-    if (unit == null) return;
+      final content = file.readAsStringSync();
+      if (_hasLicenseHeader(content)) return;
 
-    // Use the content provided by the analysis context (no need to read
-    // the file from disk).
-    if (_hasLicenseHeader(unit.content)) return;
-
-    // Report the lint on the first token in the file.
-    rule.reportAtToken(node.beginToken);
+      // Report the lint on the first token in the file.
+      final firstToken = node.beginToken;
+      reporter.atToken(firstToken, _code);
+    });
   }
+
+  @override
+  List<Fix> getFixes() => [_AddLicenseHeaderFix()];
 }
 
 /// Returns `true` if [content] starts with the expected license header.
 bool _hasLicenseHeader(String content) {
   final lines = content.split('\n');
-  if (lines.length < licenseHeader.length) return false;
+  if (lines.length < _licenseHeader.length) return false;
 
-  for (var i = 0; i < licenseHeader.length; i++) {
-    if (lines[i].trimRight() != licenseHeader[i]) return false;
+  for (var i = 0; i < _licenseHeader.length; i++) {
+    if (lines[i].trimRight() != _licenseHeader[i]) return false;
   }
   return true;
 }
+
+class _AddLicenseHeaderFix extends DartFix {
+  @override
+  void run(
+    CustomLintResolver resolver,
+    ChangeReporter reporter,
+    CustomLintContext context,
+    AnalysisError analysisError,
+    List<AnalysisError> others,
+  ) {
+    context.registry.addCompilationUnit((node) {
+      if (!analysisError.sourceRange.intersects(node.beginToken.sourceRange)) {
+        return;
+      }
+
+      final changeBuilder = reporter.createChangeBuilder(
+        message: 'Add license header',
+        priority: 100,
+      );
+
+      changeBuilder.addDartFileEdit((builder) {
+        builder.addSimpleInsertion(
+          0,
+          '${_licenseHeader.join('\n')}\n\n',
+        );
+      });
+    });
+  }
+}

packages/amplify_lints/lib/src/fixes/add_license_header_fix.dart

@@ -1,28 +1,15 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import 'package:amplify_lints/src/fixes/add_license_header_fix.dart';
 import 'package:amplify_lints/src/lints/missing_license_header.dart';
-import 'package:analysis_server_plugin/plugin.dart';
-import 'package:analysis_server_plugin/registry.dart';
+import 'package:custom_lint_builder/custom_lint_builder.dart';
 
-/// The amplify_lints analyzer plugin.
-///
-/// Registers custom lint rules and quick fixes for Amplify Flutter packages.
-class AmplifyLintsPlugin extends Plugin {
-  @override
-  String get name => 'amplify_lints';
+/// Creates the amplify_lints custom lint plugin.
+PluginBase createPlugin() => _AmplifyLints();
 
+class _AmplifyLints extends PluginBase {
   @override
-  void register(PluginRegistry registry) {
-    // Register lint rules (disabled by default, must be enabled in
-    // analysis_options.yaml).
-    registry.registerWarningRule(MissingLicenseHeader());
-
-    // Register quick fixes associated with lint rules.
-    registry.registerFixForRule(
-      MissingLicenseHeader.code,
-      AddLicenseHeaderFix.new,
-    );
-  }
+  List<LintRule> getLintRules(CustomLintConfigs configs) => [
+        const MissingLicenseHeader(),
+      ];
 }

packages/amplify_lints/lib/src/lints/missing_license_header.dart

@@ -6,16 +6,12 @@ repository: https://github.com/aws-amplify/amplify-flutter/tree/main/packages/am
 issue_tracker: https://github.com/aws-amplify/amplify-flutter/issues
 
 environment:
-  sdk: ^3.10.0
+  sdk: ^3.9.0
 
 dependencies:
-  analysis_server_plugin: ^0.3.0
-  analyzer: ^9.0.0
-  analyzer_plugin: ^0.13.11
+  custom_lint_builder: ^0.7.0
   flutter_lints: ^6.0.0
   lints: ^6.0.0
 
 dev_dependencies:
-  analyzer_testing: ^0.1.0
   test: ^1.24.0
-  test_reflective_loader: ^0.2.0