yurii-prykhodko-solid · May 5, 2025 · Apr 28, 2025 · Apr 28, 2025 · Apr 29, 2025 · Apr 29, 2025
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## 0.4.0
 
 - Added `allow_with_comments` parameter for `no_empty_block` lint.
+- Added `exclude_entity` parameter for `prefer_match_feli_name` lint.
 
 ## 0.3.0
 

diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml
@@ -93,7 +93,8 @@ custom_lint:
 
     - prefer_first
     - prefer_last
-    - prefer_match_file_name
+    - prefer_match_file_name:
+      ignore_extensions: true
     - proper_super_calls
 
 linter:

diff --git a/lib/src/common/parameters/excluded_entities_list_parameter.dart b/lib/src/common/parameters/excluded_entities_list_parameter.dart
@@ -0,0 +1,50 @@
+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.
+class ExcludedEntitiesListParameters {
+  /// The parameter model
+  final List<String> excludedEntityNames;
+
+  /// A common parameter key for analysis_options.yaml
+  static const String excludeEntityKey = 'exclude_entity';
+
+  /// Constructor for [ExcludedEntitiesListParameters] class
+  ExcludedEntitiesListParameters({
+    required this.excludedEntityNames,
+  });
+
+  /// Method for creating from json data
+  factory ExcludedEntitiesListParameters.fromJson(Map<String, dynamic> json) {
+    final raw = json['exclude_entity'];
+    if (raw is List) {
+      return ExcludedEntitiesListParameters(
+        excludedEntityNames: List<String>.from(raw),
+      );
+    }
+    return ExcludedEntitiesListParameters(
+      excludedEntityNames: [],
+    );
+  }
+
+  /// Returns whether the target node should be ignored during analysis.
+  bool shouldIgnoreEntity(Declaration node) {
+    if (excludedEntityNames.isEmpty) return false;
+
+    if (node is ClassDeclaration && excludedEntityNames.contains('class')) {
+      return true;
+    } else if (node is MixinDeclaration &&
+        excludedEntityNames.contains('mixin')) {
+      return true;
+    } else if (node is EnumDeclaration &&
+        excludedEntityNames.contains('enum')) {
+      return true;
+    } else if (node is ExtensionDeclaration &&
+        excludedEntityNames.contains('extension')) {
+      return true;
+    }
+
+    return false;
+  }
+}
diff --git a/lib/src/lints/prefer_match_file_name/models/prefer_match_file_name_parameters.dart b/lib/src/lints/prefer_match_file_name/models/prefer_match_file_name_parameters.dart
@@ -0,0 +1,19 @@
+import 'package:solid_lints/src/common/parameters/excluded_entities_list_parameter.dart';
+
+/// A data model class that represents the "prefer match file name" input
+/// parameters
+class PreferMatchFileNameParameters {
+  /// A list of entities that should be excluded from the lint.
+  final ExcludedEntitiesListParameters excludeEntity;
+
+  /// Constructor for [PreferMatchFileNameParameters] model
+  const PreferMatchFileNameParameters({
+    required this.excludeEntity,
+  });
+
+  /// Method for creating from json data
+  factory PreferMatchFileNameParameters.fromJson(Map<String, Object?> json) =>
+      PreferMatchFileNameParameters(
+        excludeEntity: ExcludedEntitiesListParameters.fromJson(json),
+      );
+}
diff --git a/lib/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart b/lib/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart
@@ -1,6 +1,7 @@
 import 'package:analyzer/error/listener.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:path/path.dart' as p;
+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';
@@ -48,7 +49,8 @@ import 'package:solid_lints/src/utils/node_utils.dart';
 /// class SomethingPublic {}  // OK
 /// ```
 ///
-class PreferMatchFileNameRule extends SolidLintRule {
+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';
@@ -62,6 +64,7 @@ class PreferMatchFileNameRule extends SolidLintRule {
     final config = RuleConfig(
       configs: configs,
       name: lintName,
+      paramsParser: PreferMatchFileNameParameters.fromJson,
       problemMessage: (value) =>
           'File name does not match with first declared element name.',
     );
@@ -76,7 +79,11 @@ class PreferMatchFileNameRule extends SolidLintRule {
     CustomLintContext context,
   ) {
     context.registry.addCompilationUnit((node) {
-      final visitor = PreferMatchFileNameVisitor();
+      final excludedEntities = config.parameters.excludeEntity;
+
+      final visitor = PreferMatchFileNameVisitor(
+        excludedEntities: excludedEntities,
+      );
 
       node.accept(visitor);
 

diff --git a/lib/src/lints/prefer_match_file_name/visitors/prefer_match_file_name_visitor.dart b/lib/src/lints/prefer_match_file_name/visitors/prefer_match_file_name_visitor.dart
@@ -1,12 +1,23 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
+import 'package:solid_lints/src/common/parameters/excluded_entities_list_parameter.dart';
+import 'package:solid_lints/src/common/parameters/excluded_identifiers_list_parameter.dart';
 import 'package:solid_lints/src/lints/prefer_match_file_name/models/declaration_token_info.dart';
 
 /// The AST visitor that will collect all Class, Enum, Extension and Mixin
 /// declarations
 class PreferMatchFileNameVisitor extends RecursiveAstVisitor<void> {
   final _declarations = <DeclarationTokenInfo>[];
 
+  /// Iterable that contains the name of entity (or entities) that should
+  /// be ignored
+  final ExcludedEntitiesListParameters excludedEntities;
+
+  /// Constructor of [PreferMatchFileNameVisitor] class
+  PreferMatchFileNameVisitor({
+    required this.excludedEntities,
+  });
+
   /// List of all declarations
   Iterable<DeclarationTokenInfo> get declarations => _declarations
     ..sort(
@@ -16,17 +27,38 @@ class PreferMatchFileNameVisitor extends RecursiveAstVisitor<void> {
       (a, b) => _publicDeclarationsFirst(a, b) ?? _byDeclarationOrder(a, b),
     );
 
+  // bool _shouldIgnore(Declaration node) {
+  //   if (excludedEntities.isEmpty) return false;
+  //
+  //   if (node is ClassDeclaration && excludedEntities.contains('class')) {
+  //     return true;
+  //   } else if (node is MixinDeclaration && excludedEntities.contains('mixin')) {
+  //     return true;
+  //   } else if (node is EnumDeclaration && excludedEntities.contains('enum')) {
+  //     return true;
+  //   } else if (node is ExtensionDeclaration &&
+  //       excludedEntities.contains('extension')) {
+  //     return true;
+  //   }
+  //
+  //   return false;
+  // }
+
   @override
   void visitClassDeclaration(ClassDeclaration node) {
     super.visitClassDeclaration(node);
 
+    if (excludedEntities.shouldIgnoreEntity(node)) return;
+
     _declarations.add((token: node.name, parent: node));
   }
 
   @override
   void visitExtensionDeclaration(ExtensionDeclaration node) {
     super.visitExtensionDeclaration(node);
 
+    if (excludedEntities.shouldIgnoreEntity(node)) return;
+
     final name = node.name;
     if (name != null) {
       _declarations.add((token: name, parent: node));
@@ -37,13 +69,17 @@ class PreferMatchFileNameVisitor extends RecursiveAstVisitor<void> {
   void visitMixinDeclaration(MixinDeclaration node) {
     super.visitMixinDeclaration(node);
 
+    if (excludedEntities.shouldIgnoreEntity(node)) return;
+
     _declarations.add((token: node.name, parent: node));
   }
 
   @override
   void visitEnumDeclaration(EnumDeclaration node) {
     super.visitEnumDeclaration(node);
 
+    if (excludedEntities.shouldIgnoreEntity(node)) return;
+
     _declarations.add((token: node.name, parent: node));
   }
 

diff --git a/lint_test/prefer_match_file_name_ignore_extensions.dart b/lint_test/prefer_match_file_name_ignore_extensions.dart
@@ -0,0 +1,5 @@
+// ignore_for_file: unused_element, unused_field
+
+/// Check if the `prefer_match_file_name` rule ignored for extensions
+// expect_lint: prefer_match_file_name
+extension DefaultExtension on String {}