feat: improve prefer-correct-type-name rule (#627)

* feat: improve `prefer-correct-type-name` rule

* chore: update example

Author: dkrutskikh

CHANGELOG.md

@@ -3,21 +3,22 @@
 ## Unreleased
 
 * feat: add static code diagnostics `avoid-global-state`.
-* chore: migrate from deprecated api
-* fix: fixed issue with type check in prefer-match-file-name
-* fix: stabilized command usage tests
-* doc: add flutter favorite badge
-* chore: disable github_checks annotations from codecov
-* chore: activate language strict rules
-* fix: add missing severity for rules
-* feat: facelift console reporters
+* chore: migrate from deprecated api.
+* fix: fixed issue with type check in prefer-match-file-name.
+* fix: stabilized command usage tests.
+* doc: add flutter favorite badge.
+* chore: disable github_checks annotations from codecov.
+* chore: activate language strict rules.
+* fix: add missing severity for rules.
+* feat: facelift console reporters.
 * chore: restrict `analyzer` version to `>=2.4.0 <3.1.0`.
 * chore: restrict `analyzer_plugin` version to `>=0.8.0 <0.10.0`.
 * feat: support extensions for check-unused-l10n.
+* feat: improve `prefer-correct-type-name` rule.
 
 ## 4.8.1
 
-* feat: add cli options for fatal exit if unused files or l10n are found
+* feat: add cli options for fatal exit if unused files or l10n are found.
 
 ## 4.8.0
 

lib/src/analyzers/lint_analyzer/rules/rules_list/prefer_correct_type_name/validator.dart

@@ -12,6 +12,7 @@ class _Validator {
   });
 
   bool isValid(String name) =>
+      name.isEmpty ||
       exceptions.contains(name) ||
       (isUpperCase(name) &&
           withoutUnderscore(name).length >= minLength &&

test/src/analyzers/lint_analyzer/rules/rules_list/prefer_correct_type_name/examples/class_example.dart

@@ -15,7 +15,7 @@ class _ex {
 
 // LINT Class with short name
 class ex {
-  _ex();
+  ex();
 }
 
 // LINT Private class with long name

test/src/analyzers/lint_analyzer/rules/rules_list/prefer_correct_type_name/prefer_correct_type_name_rule_test.dart

@@ -7,8 +7,8 @@ import '../../../../../helpers/rule_test_helper.dart';
 const _path = 'prefer_correct_type_name/examples';
 const _classExample = '$_path/class_example.dart';
 const _enumExample = '$_path/enum_example.dart';
-const _mixinExample = '$_path/mixin_example.dart';
 const _extensionExample = '$_path/extension_example.dart';
+const _mixinExample = '$_path/mixin_example.dart';
 
 void main() {
   group('PreferCorrectTypeNameRule', () {
@@ -25,6 +25,7 @@ void main() {
 
     test('reports about all found issues in class_example.dart', () async {
       final unit = await RuleTestHelper.resolveFromFile(_classExample);
+
       final issues = PreferCorrectTypeNameRule({
         'max-length': 15,
         'min-length': 3,
@@ -33,10 +34,10 @@ void main() {
 
       RuleTestHelper.verifyIssues(
         issues: issues,
-        startOffsets: [52, 124, 196, 250, 310, 397],
+        startOffsets: [52, 124, 196, 250, 309, 396],
         startLines: [2, 7, 12, 17, 22, 27],
         startColumns: [7, 7, 7, 7, 7, 7],
-        endOffsets: [59, 132, 199, 252, 330, 416],
+        endOffsets: [59, 132, 199, 252, 329, 415],
         locationTexts: [
           'example',
           '_example',
@@ -58,6 +59,7 @@ void main() {
 
     test('reports about all found issues in enum_example.dart', () async {
       final unit = await RuleTestHelper.resolveFromFile(_enumExample);
+
       final issues = PreferCorrectTypeNameRule({
         'max-length': 15,
         'min-length': 3,
@@ -91,6 +93,7 @@ void main() {
 
     test('reports about all found issues in extension_example.dart', () async {
       final unit = await RuleTestHelper.resolveFromFile(_extensionExample);
+
       final issues = PreferCorrectTypeNameRule({
         'max-length': 15,
         'min-length': 3,
@@ -124,6 +127,7 @@ void main() {
 
     test('reports about all found issues in mixin_example.dart', () async {
       final unit = await RuleTestHelper.resolveFromFile(_mixinExample);
+
       final issues = PreferCorrectTypeNameRule({
         'max-length': 15,
         'min-length': 3,
@@ -154,5 +158,33 @@ void main() {
         ],
       );
     });
+
+    test('works with invalid files', () async {
+      final rule = PreferCorrectTypeNameRule();
+
+      final classExampleUnit = await RuleTestHelper.createAndResolveFromFile(
+        content: 'class ',
+        filePath: '$_path/invalid_class_example.dart',
+      );
+      expect(rule.check(classExampleUnit), isEmpty);
+
+      final classEnumUnit = await RuleTestHelper.createAndResolveFromFile(
+        content: 'enum ',
+        filePath: '$_path/invalid_enum_example.dart',
+      );
+      expect(rule.check(classEnumUnit), isEmpty);
+
+      final classExtensionUnit = await RuleTestHelper.createAndResolveFromFile(
+        content: 'extension ',
+        filePath: '$_path/invalid_extension_example.dart',
+      );
+      expect(rule.check(classExtensionUnit), isEmpty);
+
+      final classMixinUnit = await RuleTestHelper.createAndResolveFromFile(
+        content: 'mixin ',
+        filePath: '$_path/invalid_mixin_example.dart',
+      );
+      expect(rule.check(classMixinUnit), isEmpty);
+    });
   });
 }

test/src/helpers/file_resolver.dart

@@ -6,9 +6,7 @@ import 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/internal_re
 import 'package:path/path.dart';
 
 class FileResolver {
-  static Future<InternalResolvedUnitResult> resolve(
-    String filePath,
-  ) async {
+  static Future<InternalResolvedUnitResult> resolve(String filePath) async {
     final file = File(filePath);
 
     if (!file.existsSync()) {

test/src/helpers/rule_test_helper.dart

@@ -1,3 +1,5 @@
+import 'dart:io';
+
 import 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/internal_resolved_unit_result.dart';
 import 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/issue.dart';
 import 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/severity.dart';
@@ -15,6 +17,20 @@ class RuleTestHelper {
     return FileResolver.resolve(fullPath);
   }
 
+  static Future<InternalResolvedUnitResult> createAndResolveFromFile({
+    required String content,
+    required String filePath,
+  }) async {
+    final fullPath =
+        'test/src/analyzers/lint_analyzer/rules/rules_list/$filePath';
+
+    final file = File(fullPath)..writeAsStringSync(content);
+    final result = await FileResolver.resolve(fullPath);
+    file.deleteSync();
+
+    return result;
+  }
+
   static void verifyInitialization({
     required Iterable<Issue> issues,
     required String ruleId,