Use DiagnosticableMixin instead of Diagnosticable (#2003)
diff --git a/lib/src/rules/diagnostic_describe_all_properties.dart b/lib/src/rules/diagnostic_describe_all_properties.dart
index 0eca773..1734e76 100644
--- a/lib/src/rules/diagnostic_describe_all_properties.dart
+++ b/lib/src/rules/diagnostic_describe_all_properties.dart
@@ -17,7 +17,7 @@
const _details = r'''
**DO** reference all public properties in `debug` method implementations.
-Implementers of `Diagnosticable` should reference all public properties in
+Implementers of `DiagnosticableMixin` should reference all public properties in
a `debugFillProperties(...)` or `debugDescribeChildren(...)` method
implementation to improve debuggability at runtime.
@@ -124,7 +124,8 @@
void visitClassDeclaration(ClassDeclaration node) {
// We only care about Diagnosticables.
final type = node.declaredElement.thisType;
- if (!DartTypeUtilities.implementsInterface(type, 'Diagnosticable', '')) {
+ if (!DartTypeUtilities.implementsInterface(
+ type, 'DiagnosticableMixin', '')) {
return;
}
diff --git a/test/mock_packages/flutter/lib/src/foundation/diagnostics.dart b/test/mock_packages/flutter/lib/src/foundation/diagnostics.dart
index fca736d..f51052c 100644
--- a/test/mock_packages/flutter/lib/src/foundation/diagnostics.dart
+++ b/test/mock_packages/flutter/lib/src/foundation/diagnostics.dart
@@ -2657,7 +2657,7 @@
List<Map<String, Object>> properties;
if (delegate.expandPropertyValues &&
delegate.includeProperties &&
- v is Diagnosticable &&
+ v is DiagnosticableMixin &&
getProperties().isEmpty) {
// Exclude children for expanded nodes to avoid cycles.
delegate = delegate.copyWith(subtreeDepth: 0, includeProperties: false);
@@ -2680,7 +2680,7 @@
if (exception != null) json['exception'] = exception.toString();
json['propertyType'] = propertyType.toString();
json['defaultLevel'] = describeEnum(_defaultLevel);
- if (value is Diagnosticable || value is DiagnosticsNode)
+ if (value is DiagnosticableMixin || value is DiagnosticsNode)
json['isDiagnosticableValue'] = true;
if (v is num)
// Workaround for https://github.com/flutter/flutter/issues/39937#issuecomment-529558033.
@@ -2852,7 +2852,7 @@
if (object is DiagnosticsNode) {
return object.getProperties();
}
- if (object is Diagnosticable) {
+ if (object is DiagnosticableMixin) {
return object.toDiagnosticsNode(style: style).getProperties();
}
}
@@ -2866,7 +2866,7 @@
if (object is DiagnosticsNode) {
return object.getChildren();
}
- if (object is Diagnosticable) {
+ if (object is DiagnosticableMixin) {
return object.toDiagnosticsNode(style: style).getChildren();
}
}
@@ -2876,8 +2876,9 @@
/// [DiagnosticsNode] that lazily calls the associated [Diagnosticable] [value]
/// to implement [getChildren] and [getProperties].
-class DiagnosticableNode<T extends Diagnosticable> extends DiagnosticsNode {
- /// Create a diagnostics describing a [Diagnosticable] value.
+class DiagnosticableNode<T extends DiagnosticableMixin>
+ extends DiagnosticsNode {
+ /// Create a diagnostics describing a [DiagnosticableMixin] value.
///
/// The [value] argument must not be null.
DiagnosticableNode({
@@ -3000,7 +3001,7 @@
}
/// Builder to accumulate properties and configuration used to assemble a
-/// [DiagnosticsNode] from a [Diagnosticable] object.
+/// [DiagnosticsNode] from a [DiagnosticableMixin] object.
class DiagnosticPropertiesBuilder {
/// Creates a [DiagnosticPropertiesBuilder] with [properties] initialize to
/// an empty array.
@@ -3028,7 +3029,7 @@
}
// Examples can assume:
-// class ExampleSuperclass extends Diagnosticable { String message; double stepWidth; double scale; double paintExtent; double hitTestExtent; double paintExtend; double maxWidth; bool primary; double progress; int maxLines; Duration duration; int depth; dynamic boxShadow; dynamic style; bool hasSize; Matrix4 transform; Map<Listenable, VoidCallback> handles; Color color; bool obscureText; ImageRepeat repeat; Size size; Widget widget; bool isCurrent; bool keepAlive; TextAlign textAlign; }
+// class ExampleSuperclass with DiagnosticableMixin { String message; double stepWidth; double scale; double paintExtent; double hitTestExtent; double paintExtend; double maxWidth; bool primary; double progress; int maxLines; Duration duration; int depth; dynamic boxShadow; dynamic style; bool hasSize; Matrix4 transform; Map<Listenable, VoidCallback> handles; Color color; bool obscureText; ImageRepeat repeat; Size size; Widget widget; bool isCurrent; bool keepAlive; TextAlign textAlign; }
/// A base class for providing string and [DiagnosticsNode] debug
/// representations describing the properties of an object.
diff --git a/test/rules/diagnostic_describe_all_properties.dart b/test/rules/diagnostic_describe_all_properties.dart
index 588c25b..0e3658f 100644
--- a/test/rules/diagnostic_describe_all_properties.dart
+++ b/test/rules/diagnostic_describe_all_properties.dart
@@ -7,7 +7,7 @@
import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';
-class MyWidget extends Diagnosticable {
+class MyWidget with DiagnosticableMixin {
Widget p0; //Skipped
List<Widget> p00; //Skipped
Widget get p000 => null; //Skipped
@@ -41,6 +41,6 @@
}
}
-class MyWidget2 extends Diagnosticable {
+class MyWidget2 with DiagnosticableMixin {
bool property; //LINT
}
