refactor: migrate prefer_match_file_name (#305)

* refactor: migrate prefer_match_file_name

* refactor: improve prefer_match_file_name lint logic with switch expressions and centralized parameter initialization

* test: add test cases for prefer_match_file_name rule

* refactor: move normalization logic to visitor and add multi-sort utility to improve PreferMatchFileName rule encapsulation

* refactor: replace hardcoded exclude_entity key with constant in ExcludedEntitiesListParameter

---------

Co-authored-by: Illia Aihistov <illia.aihistov-us@solid.software>

Author: solid-illiaaihistov

lib/main.dart

@@ -32,6 +32,7 @@ import 'package:solid_lints/src/lints/prefer_first/fixes/prefer_first_fix.dart';
 import 'package:solid_lints/src/lints/prefer_first/prefer_first_rule.dart';
 import 'package:solid_lints/src/lints/prefer_last/fixes/prefer_last_fix.dart';
 import 'package:solid_lints/src/lints/prefer_last/prefer_last_rule.dart';
+import 'package:solid_lints/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart';
 import 'package:solid_lints/src/lints/proper_super_calls/proper_super_calls_rule.dart';
 import 'package:solid_lints/src/lints/use_nearest_context/fixes/rename_nearest_context_parameter_fix.dart';
 import 'package:solid_lints/src/lints/use_nearest_context/use_nearest_context_rule.dart';
@@ -84,6 +85,7 @@ class SolidLintsPlugin extends Plugin {
       preferFirstRule,
       preferConditionalExpressionsRule,
       preferLastRule,
+      PreferMatchFileNameRule(analysisOptionsLoader: analysisLoader),
       // TODO: Add more lint rules and use analysisLoader
       // for rules that need parameters
       // For example: `CyclomaticComplexityRule(analysisLoader)`

lib/src/common/parameters/excluded_entities_list_parameter.dart

@@ -1,11 +1,12 @@
 import 'package:analyzer/dart/ast/ast.dart';
 
 /// A model representing "exclude_entity" parameters for linting, defining
-/// identifiers (classes, mixins, enums, extensions) to be ignored during
-/// analysis.
+/// identifiers (classes, mixins, enums, extensions, extension_types) to be
+/// ignored during analysis.
 /// Supported entities:
 ///   - mixin
 ///   - extension
+///   - extension_type
 ///   - enum
 class ExcludedEntitiesListParameter {
   /// The parameter model
@@ -19,22 +20,20 @@ class ExcludedEntitiesListParameter {
     required this.excludedEntityNames,
   });
 
-  /// Method for creating from json data
-  factory ExcludedEntitiesListParameter.fromJson(Map<String, dynamic> json) {
-    final raw = json['exclude_entity'];
+  /// Creates an [ExcludedEntitiesListParameter] from JSON.
+  factory ExcludedEntitiesListParameter.fromJson(Map<String, Object?> json) {
+    final raw = json[excludeEntityKey];
     if (raw is Iterable) {
       return ExcludedEntitiesListParameter(
-        excludedEntityNames: Set<String>.from(raw.whereType<String>()),
+        excludedEntityNames: raw.whereType<String>().toSet(),
       );
     } else if (raw is String) {
       return ExcludedEntitiesListParameter(
         excludedEntityNames: {raw},
       );
     }
 
-    return ExcludedEntitiesListParameter(
-      excludedEntityNames: {},
-    );
+    return ExcludedEntitiesListParameter(excludedEntityNames: {});
   }
 
   /// Returns whether the target node should be ignored during analysis.
@@ -49,6 +48,9 @@ class ExcludedEntitiesListParameter {
     } else if (node is ExtensionDeclaration &&
         excludedEntityNames.contains('extension')) {
       return true;
+    } else if (node is ExtensionTypeDeclaration &&
+        excludedEntityNames.contains('extension_type')) {
+      return true;
     }
 
     return false;

lib/src/lints/prefer_match_file_name/models/prefer_match_file_name_parameters.dart

@@ -11,6 +11,13 @@ class PreferMatchFileNameParameters {
     required this.excludeEntity,
   });
 
+  /// Empty [PreferMatchFileNameParameters] model.
+  factory PreferMatchFileNameParameters.empty() {
+    return PreferMatchFileNameParameters(
+      excludeEntity: ExcludedEntitiesListParameter(excludedEntityNames: {}),
+    );
+  }
+
   /// Method for creating from json data
   factory PreferMatchFileNameParameters.fromJson(Map<String, Object?> json) =>
       PreferMatchFileNameParameters(

lib/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart

@@ -1,16 +1,28 @@
-import 'package:analyzer/error/listener.dart';
-import 'package:custom_lint_builder/custom_lint_builder.dart';
-import 'package:path/path.dart' as p;
+import 'package:analyzer/analysis_rule/rule_context.dart';
+import 'package:analyzer/analysis_rule/rule_visitor_registry.dart';
+import 'package:analyzer/error/error.dart';
 import 'package:solid_lints/src/lints/prefer_match_file_name/models/prefer_match_file_name_parameters.dart';
 import 'package:solid_lints/src/lints/prefer_match_file_name/visitors/prefer_match_file_name_visitor.dart';
-import 'package:solid_lints/src/models/rule_config.dart';
 import 'package:solid_lints/src/models/solid_lint_rule.dart';
-import 'package:solid_lints/src/utils/node_utils.dart';
 
 /// Warns about a mismatch between file name and first declared element inside.
 ///
 /// This improves navigation by matching file content and file name.
 ///
+/// ### Example config:
+///
+/// ```yaml
+/// plugins:
+///   solid_lints:
+///     diagnostics:
+///       prefer_match_file_name:
+///         exclude_entity:
+///           - mixin
+///           - extension
+///           - extension_type
+///           - enum
+/// ```
+///
 /// ## Tests
 ///
 /// State: **Disabled**.
@@ -51,80 +63,46 @@ import 'package:solid_lints/src/utils/node_utils.dart';
 ///
 class PreferMatchFileNameRule
     extends SolidLintRule<PreferMatchFileNameParameters> {
-  /// This lint rule represents the error if iterable
-  /// access can be simplified.
-  static const String lintName = 'prefer_match_file_name';
-  static final _onlySymbolsRegex = RegExp('[^a-zA-Z0-9]');
+  /// Name of the lint.
+  static const lintName = 'prefer_match_file_name';
 
-  PreferMatchFileNameRule._(super.config);
+  static const _code = LintCode(
+    lintName,
+    'File name does not match with first {0} name.',
+  );
+
+  @override
+  DiagnosticCode get diagnosticCode => _code;
 
   /// Creates a new instance of [PreferMatchFileNameRule]
   /// based on the lint configuration.
-  factory PreferMatchFileNameRule.createRule(CustomLintConfigs configs) {
-    final config = RuleConfig(
-      configs: configs,
-      name: lintName,
-      paramsParser: PreferMatchFileNameParameters.fromJson,
-      problemMessage: (value) =>
-          'File name does not match with first declared element name.',
-    );
-
-    return PreferMatchFileNameRule._(config);
-  }
+  PreferMatchFileNameRule({
+    required super.analysisOptionsLoader,
+  }) : super.withParameters(
+         name: lintName,
+         description:
+             'Warns about a mismatch between file name and first declared '
+             'element inside.',
+         parametersParser: PreferMatchFileNameParameters.fromJson,
+       );
 
   @override
-  void run(
-    CustomLintResolver resolver,
-    DiagnosticReporter reporter,
-    CustomLintContext context,
+  void registerNodeProcessors(
+    RuleVisitorRegistry registry,
+    RuleContext context,
   ) {
-    context.registry.addCompilationUnit((node) {
-      final excludedEntities = config.parameters.excludeEntity;
-
-      final visitor = PreferMatchFileNameVisitor(
-        excludedEntities: excludedEntities,
-      );
-
-      node.accept(visitor);
+    super.registerNodeProcessors(registry, context);
 
-      if (visitor.declarations.isEmpty) return;
+    final parameters =
+        getParametersForContext(context) ??
+        PreferMatchFileNameParameters.empty();
 
-      final firstDeclaration = visitor.declarations.first;
-
-      if (_doNormalizedNamesMatch(
-        resolver.source.fullName,
-        firstDeclaration.token.lexeme,
-      )) {
-        return;
-      }
-
-      final nodeType =
-          humanReadableNodeType(firstDeclaration.parent).toLowerCase();
-
-      reporter.atToken(
-        firstDeclaration.token,
-        LintCode(
-          name: lintName,
-          problemMessage: 'File name does not match with first $nodeType name.',
-        ),
-      );
-    });
-  }
-
-  bool _doNormalizedNamesMatch(String path, String identifierName) {
-    final fileName = _normalizePath(path);
-    final dartIdentifier = _normalizeDartIdentifierName(identifierName);
+    final visitor = PreferMatchFileNameVisitor(
+      diagnosticCode: diagnosticCode,
+      context: context,
+      excludedEntities: parameters.excludeEntity,
+    );
 
-    return fileName == dartIdentifier;
+    registry.addCompilationUnit(this, visitor);
   }
-
-  String _normalizePath(String s) => p
-      .basename(s)
-      .split('.')
-      .first
-      .replaceAll(_onlySymbolsRegex, '')
-      .toLowerCase();
-
-  String _normalizeDartIdentifierName(String s) =>
-      s.replaceAll(_onlySymbolsRegex, '').toLowerCase();
 }

lib/src/lints/prefer_match_file_name/visitors/prefer_match_file_name_visitor.dart

@@ -1,83 +1,97 @@
+import 'package:analyzer/analysis_rule/rule_context.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
+import 'package:analyzer/error/error.dart';
+import 'package:collection/collection.dart';
+import 'package:path/path.dart' as p;
 import 'package:solid_lints/src/common/parameters/excluded_entities_list_parameter.dart';
 import 'package:solid_lints/src/lints/prefer_match_file_name/models/declaration_token_info.dart';
+import 'package:solid_lints/src/utils/iterable_utils.dart';
+import 'package:solid_lints/src/utils/node_utils.dart';
 
-/// The AST visitor that will collect all Class, Enum, Extension and Mixin
-/// declarations
-class PreferMatchFileNameVisitor extends RecursiveAstVisitor<void> {
-  final _declarations = <DeclarationTokenInfo>[];
+/// The AST visitor that will collect all Class, Enum, Extension, Mixin and
+/// Extension Type declarations
+class PreferMatchFileNameVisitor extends SimpleAstVisitor<void> {
+  static final _onlySymbolsRegex = RegExp('[^a-zA-Z0-9]');
+
+  /// The diagnostic code to report
+  final DiagnosticCode diagnosticCode;
+
+  /// The rule context
+  final RuleContext context;
 
   /// Iterable that contains the name of entity (or entities) that should
   /// be ignored
   final ExcludedEntitiesListParameter excludedEntities;
 
   /// Constructor of [PreferMatchFileNameVisitor] class
   PreferMatchFileNameVisitor({
+    required this.diagnosticCode,
+    required this.context,
     required this.excludedEntities,
   });
 
-  /// List of all declarations
-  Iterable<DeclarationTokenInfo> get declarations => _declarations.where(
-        (declaration) {
-          if (declaration.parent is Declaration) {
-            return !excludedEntities
-                .shouldIgnoreEntity(declaration.parent as Declaration);
-          }
-          return true;
-        },
-      ).toList()
-        ..sort(
-          (a, b) => _publicDeclarationsFirst(a, b) ?? _byDeclarationOrder(a, b),
-        );
-
   @override
-  void visitClassDeclaration(ClassDeclaration node) {
-    super.visitClassDeclaration(node);
+  void visitCompilationUnit(CompilationUnit node) {
+    final declarations = node.declarations
+        .whereNot(excludedEntities.shouldIgnoreEntity)
+        .map<DeclarationTokenInfo?>(
+          (d) {
+            final token = switch (d) {
+              ClassDeclaration() => d.namePart.typeName,
+              ExtensionDeclaration() => d.name,
+              MixinDeclaration() => d.name,
+              EnumDeclaration() => d.namePart.typeName,
+              ExtensionTypeDeclaration() => d.primaryConstructor.typeName,
+              _ => null,
+            };
 
-    _declarations.add((token: node.name, parent: node));
-  }
+            return token == null ? null : (token: token, parent: d);
+          },
+        )
+        .nonNulls
+        .multiSortedBy(
+          [
+            (t) => Identifier.isPrivateName(t.token.lexeme) ? 1 : 0,
+            (t) => t.token.offset,
+          ],
+        );
 
-  @override
-  void visitExtensionDeclaration(ExtensionDeclaration node) {
-    super.visitExtensionDeclaration(node);
+    if (declarations.isEmpty) return;
 
-    final name = node.name;
-    if (name != null) {
-      _declarations.add((token: name, parent: node));
+    final firstDeclaration = declarations.first;
+    final fullName = context.currentUnit?.file.path;
+
+    if (fullName != null &&
+        _doNormalizedNamesMatch(
+          fullName,
+          firstDeclaration.token.lexeme,
+        )) {
+      return;
     }
-  }
 
-  @override
-  void visitMixinDeclaration(MixinDeclaration node) {
-    super.visitMixinDeclaration(node);
+    final nodeType = humanReadableNodeType(
+      firstDeclaration.parent,
+    ).toLowerCase();
 
-    _declarations.add((token: node.name, parent: node));
+    final reporter = context.currentUnit?.diagnosticReporter;
+    reporter?.atToken(
+      firstDeclaration.token,
+      diagnosticCode,
+      arguments: [nodeType],
+    );
   }
 
-  @override
-  void visitEnumDeclaration(EnumDeclaration node) {
-    super.visitEnumDeclaration(node);
+  bool _doNormalizedNamesMatch(String path, String identifierName) {
+    final fileName = _normalizePath(path);
+    final dartIdentifier = _normalizeDartIdentifierName(identifierName);
 
-    _declarations.add((token: node.name, parent: node));
+    return fileName == dartIdentifier;
   }
 
-  int? _publicDeclarationsFirst(
-    DeclarationTokenInfo a,
-    DeclarationTokenInfo b,
-  ) {
-    final isAPrivate = Identifier.isPrivateName(a.token.lexeme);
-    final isBPrivate = Identifier.isPrivateName(b.token.lexeme);
-    if (!isAPrivate && isBPrivate) {
-      return -1;
-    } else if (isAPrivate && !isBPrivate) {
-      return 1;
-    }
-    // no reorder needed;
-    return null;
-  }
+  String _normalizePath(String s) =>
+      _normalizeDartIdentifierName(p.basename(s).split('.').first);
 
-  int _byDeclarationOrder(DeclarationTokenInfo a, DeclarationTokenInfo b) {
-    return a.token.offset.compareTo(b.token.offset);
-  }
+  String _normalizeDartIdentifierName(String s) =>
+      s.replaceAll(_onlySymbolsRegex, '').toLowerCase();
 }