Don't warn on keys based on enum values

Workiva · Sep 8, 2023 · 2aaba91 · 2aaba91
1 parent 9bcf9b0
commit 2aaba91
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/tools/analyzer_plugin/lib/src/diagnostic/bad_key.dart b/tools/analyzer_plugin/lib/src/diagnostic/bad_key.dart
@@ -185,13 +185,15 @@ class BadKeyDiagnostic extends ComponentUsageDiagnosticContributor {
   }
 
   static bool inheritsToStringImplFromObject(Element element) =>
-      element
+      // Enums have toStrings that include their name.
+      element is! EnumElement &&
+      (element
           .tryCast<InterfaceElement>()
           ?.lookUpConcreteMethod('toString', element.library!)
           ?.thisOrAncestorOfType<InterfaceElement>()
           ?.thisType
           .isDartCoreObject ??
-      false;
+      false);
 }
 
 /// Recursively collects expressions that are used to effectively call `toString()`:

diff --git a/tools/analyzer_plugin/test/integration/diagnostics/bad_key_test.dart b/tools/analyzer_plugin/test/integration/diagnostics/bad_key_test.dart
@@ -47,6 +47,8 @@ class MyModelWithCustomToString {
   @override
   toString() => '$id';
 }
+
+enum AnEnum { foo }
 ''';
 }
 
@@ -59,6 +61,7 @@ class BadKeyDiagnosticTest_NoErrors extends BadKeyDiagnosticTest {
     final source = newSourceWithPrefix(/*language=dart*/ r'''
       test() => [
         (Dom.div()..key = 'a string')(),
+        (Dom.div()..key = AnEnum.foo)(),
         (Dom.div()..key = 122)(),
         (Dom.div()..key = modelVar.id)(),
         (Dom.div()..key = modelVarWithCustomToString)(),