feat: support mixins, extensions and enums for prefer-match-file-name (#573)

* feat: add support mixins, extensions and enums for `prefer-match-file-name` rule.

* chore: add missed calls super functions

Author: dkrutskikh

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 * feat: add alphabetical sorting by type for `member-ordering-extended` rule.
+* feat: add support mixins, extensions and enums for `prefer-match-file-name` rule.
 * fix: prefer conditional expressions rule breaks code with increment / decrement operators
 
 ## 4.7.0

lib/src/analyzers/lint_analyzer/rules/node_utils.dart

@@ -0,0 +1,15 @@
+import 'package:analyzer/dart/ast/ast.dart';
+
+String humanReadableNodeType(AstNode? node) {
+  if (node is ClassDeclaration) {
+    return 'Class';
+  } else if (node is EnumDeclaration) {
+    return 'Enum';
+  } else if (node is ExtensionDeclaration) {
+    return 'Extension';
+  } else if (node is MixinDeclaration) {
+    return 'Mixin';
+  }
+
+  return 'Node';
+}

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid-unnecessary-type-casts/visitor.dart

@@ -7,6 +7,8 @@ class _Visitor extends RecursiveAstVisitor<void> {
 
   @override
   void visitAsExpression(AsExpression node) {
+    super.visitAsExpression(node);
+
     final objectType = node.expression.staticType;
     final castedType = node.type.type;
     if (_isUselessTypeCheck(objectType, castedType)) {

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_type_assertions/visitor.dart

@@ -36,6 +36,8 @@ class _Visitor extends RecursiveAstVisitor<void> {
 
   @override
   void visitIsExpression(IsExpression node) {
+    super.visitIsExpression(node);
+
     final objectType = node.expression.staticType;
     final castedType = node.type.type;
     if (_isUselessTypeCheck(objectType, castedType)) {

lib/src/analyzers/lint_analyzer/rules/rules_list/prefer_match_file_name/prefer_match_file_name_rule.dart

@@ -2,22 +2,21 @@
 
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
-import 'package:path/path.dart';
+import 'package:path/path.dart' as p;
 
 import '../../../../../utils/node_utils.dart';
 import '../../../lint_utils.dart';
 import '../../../models/internal_resolved_unit_result.dart';
 import '../../../models/issue.dart';
 import '../../../models/severity.dart';
 import '../../models/common_rule.dart';
+import '../../node_utils.dart';
 import '../../rule_utils.dart';
 
 part 'visitor.dart';
 
 class PreferMatchFileNameRule extends CommonRule {
   static const String ruleId = 'prefer-match-file-name';
-  static const _notMatchNameFailure =
-      'File name does not match with first class name.';
   static final _onlySymbolsRegex = RegExp('[^a-zA-Z0-9]');
 
   PreferMatchFileNameRule([Map<String, Object> config = const {}])
@@ -27,18 +26,6 @@ class PreferMatchFileNameRule extends CommonRule {
           excludes: readExcludes(config),
         );
 
-  bool _hasMatchName(String path, String className) {
-    final classNameFormatted =
-        className.replaceAll(_onlySymbolsRegex, '').toLowerCase();
-
-    return classNameFormatted ==
-        basename(path)
-            .split('.')
-            .first
-            .replaceAll(_onlySymbolsRegex, '')
-            .toLowerCase();
-  }
-
   @override
   Iterable<Issue> check(InternalResolvedUnitResult source) {
     final visitor = _Visitor();
@@ -48,19 +35,32 @@ class PreferMatchFileNameRule extends CommonRule {
 
     if (visitor.declaration.isNotEmpty &&
         !_hasMatchName(source.path, visitor.declaration.first.name)) {
+      final node = visitor.declaration.first;
+      final nodeType = humanReadableNodeType(node.parent).toLowerCase();
+
       final issue = createIssue(
         rule: this,
-        location: nodeLocation(
-          node: visitor.declaration.first,
-          source: source,
-          withCommentOrMetadata: true,
-        ),
-        message: _notMatchNameFailure,
+        location: nodeLocation(node: node, source: source),
+        message: 'File name does not match with first $nodeType name.',
       );
 
       _issue.add(issue);
     }
 
     return _issue;
   }
+
+  bool _hasMatchName(String path, String identifierName) {
+    final identifierNameFormatted =
+        identifierName.replaceAll(_onlySymbolsRegex, '').toLowerCase();
+
+    final fileNameFormatted = p
+        .basename(path)
+        .split('.')
+        .first
+        .replaceAll(_onlySymbolsRegex, '')
+        .toLowerCase();
+
+    return identifierNameFormatted == fileNameFormatted;
+  }
 }

lib/src/analyzers/lint_analyzer/rules/rules_list/prefer_match_file_name/visitor.dart

@@ -13,6 +13,30 @@ class _Visitor extends RecursiveAstVisitor<void> {
     _declarations.add(node.name);
   }
 
+  @override
+  void visitExtensionDeclaration(ExtensionDeclaration node) {
+    super.visitExtensionDeclaration(node);
+
+    final name = node.name;
+    if (name != null) {
+      _declarations.add(name);
+    }
+  }
+
+  @override
+  void visitMixinDeclaration(MixinDeclaration node) {
+    super.visitMixinDeclaration(node);
+
+    _declarations.add(node.name);
+  }
+
+  @override
+  void visitEnumDeclaration(EnumDeclaration node) {
+    super.visitEnumDeclaration(node);
+
+    _declarations.add(node.name);
+  }
+
   int _compareByPrivateType(SimpleIdentifier a, SimpleIdentifier b) {
     final isAPrivate = Identifier.isPrivateName(a.name);
     final isBPrivate = Identifier.isPrivateName(b.name);

test/src/analyzers/lint_analyzer/rules/rules_list/prefer_match_file_name/examples/multiple_enums.dart

@@ -0,0 +1,5 @@
+enum _MultiEnum { a, b, c }
+
+enum MultipleEnumExample { a, b, c }
+
+enum Test { a, b, c }

test/src/analyzers/lint_analyzer/rules/rules_list/prefer_match_file_name/examples/multiple_extensions.dart

@@ -0,0 +1,5 @@
+extension _MultiExtension on String {}
+
+extension MultipleExtensionExample on String {}
+
+extension Test on String {}

test/src/analyzers/lint_analyzer/rules/rules_list/prefer_match_file_name/examples/multiple_mixins.dart

@@ -0,0 +1,5 @@
+mixin _MultiMixin {}
+
+mixin MultipleMixinExample {}
+
+mixin Test {}

test/src/analyzers/lint_analyzer/rules/rules_list/prefer_match_file_name/prefer_match_file_name_rule_test.dart

@@ -12,6 +12,9 @@ const _withIssue = '$_examplePath/example_with_issue.dart';
 const _emptyFile = '$_examplePath/empty_file.dart';
 const _privateClass = '$_examplePath/private_class.dart';
 const _multiClass = '$_examplePath/multiple_classes_example.dart';
+const _multipleEnums = '$_examplePath/multiple_enums.dart';
+const _multipleExtensions = '$_examplePath/multiple_extensions.dart';
+const _multipleMixins = '$_examplePath/multiple_mixins.dart';
 const _codegenFile = '$_examplePath/some_widget.codegen.dart';
 
 void main() {
@@ -77,6 +80,60 @@ void main() {
       RuleTestHelper.verifyNoIssues(issues);
     });
 
+    test(
+      'reports about found issue about incorrect file name with enums',
+      () async {
+        final unit = await RuleTestHelper.resolveFromFile(_multipleEnums);
+        final issues = PreferMatchFileNameRule().check(unit);
+
+        RuleTestHelper.verifyIssues(
+          issues: issues,
+          startOffsets: [34],
+          startLines: [3],
+          startColumns: [6],
+          endOffsets: [53],
+          messages: ['File name does not match with first enum name.'],
+          locationTexts: ['MultipleEnumExample'],
+        );
+      },
+    );
+
+    test(
+      'reports about found issue about incorrect file name with extensions',
+      () async {
+        final unit = await RuleTestHelper.resolveFromFile(_multipleExtensions);
+        final issues = PreferMatchFileNameRule().check(unit);
+
+        RuleTestHelper.verifyIssues(
+          issues: issues,
+          startOffsets: [50],
+          startLines: [3],
+          startColumns: [11],
+          endOffsets: [74],
+          messages: ['File name does not match with first extension name.'],
+          locationTexts: ['MultipleExtensionExample'],
+        );
+      },
+    );
+
+    test(
+      'reports about found issue about incorrect file name with mixins',
+      () async {
+        final unit = await RuleTestHelper.resolveFromFile(_multipleMixins);
+        final issues = PreferMatchFileNameRule().check(unit);
+
+        RuleTestHelper.verifyIssues(
+          issues: issues,
+          startOffsets: [28],
+          startLines: [3],
+          startColumns: [7],
+          endOffsets: [48],
+          messages: ['File name does not match with first mixin name.'],
+          locationTexts: ['MultipleMixinExample'],
+        );
+      },
+    );
+
     test('reports no issues for codegen file', () async {
       final unit = await RuleTestHelper.resolveFromFile(_codegenFile);
       final issues = PreferMatchFileNameRule().check(unit);

website/docs/rules/common/prefer-match-file-name.md

@@ -10,8 +10,7 @@ Warning
 
 ## Description {#description}
 
-Warns if the file name does not match the name of the first public class in the file or a private class if there are no
-public classes.
+Warns if the file name does not match the name of the first public class / mixin / extension / enum in the file or a private one if there are no public entries.
 
 ### Config example {#config-example}