Lint for SizedBox.shrink(...) and SizedBox.expand(...)

example/all.yaml

@@ -146,6 +146,7 @@ linter:
     - recursive_getters
     - require_trailing_commas
     - sized_box_for_whitespace
+    - sized_box_shrink_expand
     - slash_for_doc_comments
     - sort_child_properties_last
     - sort_constructors_first

lib/src/rules.dart

@@ -150,6 +150,7 @@ import 'rules/public_member_api_docs.dart';
 import 'rules/recursive_getters.dart';
 import 'rules/require_trailing_commas.dart';
 import 'rules/sized_box_for_whitespace.dart';
+import 'rules/sized_box_shrink_expand.dart';
 import 'rules/slash_for_doc_comments.dart';
 import 'rules/sort_child_properties_last.dart';
 import 'rules/sort_constructors_first.dart';
@@ -348,6 +349,7 @@ void registerLintRules({bool inTestMode = false}) {
     ..register(RecursiveGetters())
     ..register(RequireTrailingCommas())
     ..register(SizedBoxForWhitespace())
+    ..register(SizedBoxShrinkExpand())
     ..register(SlashForDocComments())
     ..register(SortChildPropertiesLast())
     ..register(SortConstructorsFirst())

lib/src/rules/sized_box_for_whitespace.dart

@@ -74,26 +74,20 @@ class _Visitor extends SimpleAstVisitor {
       return;
     }
 
-    var visitor = _WidthOrHeightArgumentVisitor();
-    node.visitChildren(visitor);
-    if (visitor.seenIncompatibleParams) {
+    var data = _ArgumentData(node.argumentList);
+
+    if (data.seenIncompatibleParams) {
       return;
     }
-    if (visitor.seenChild && (visitor.seenWidth || visitor.seenHeight) ||
-        visitor.seenWidth && visitor.seenHeight) {
+    if (data.seenChild && (data.seenWidth || data.seenHeight) ||
+        data.seenWidth && data.seenHeight) {
       rule.reportLint(node.constructorName);
     }
   }
 }
 
-class _WidthOrHeightArgumentVisitor extends SimpleAstVisitor<void> {
-  var seenWidth = false;
-  var seenHeight = false;
-  var seenChild = false;
-  var seenIncompatibleParams = false;
-
-  @override
-  void visitArgumentList(ArgumentList node) {
+class _ArgumentData {
+  _ArgumentData(ArgumentList node) {
     for (var name in node.arguments
         .cast<NamedExpression>()
         .map((arg) => arg.name.label.name)) {
@@ -110,4 +104,9 @@ class _WidthOrHeightArgumentVisitor extends SimpleAstVisitor<void> {
       }
     }
   }
+
+  var seenWidth = false;
+  var seenHeight = false;
+  var seenChild = false;
+  var seenIncompatibleParams = false;
 }

lib/src/rules/sized_box_shrink_expand.dart

@@ -0,0 +1,147 @@
+// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/dart/ast/visitor.dart';
+
+import '../analyzer.dart';
+import '../util/flutter_utils.dart';
+
+const _sizedBoxShrinkDescription =
+    r'Use the SizedBox.shrink(...) named constructor.';
+
+const _sizedBoxExpandDescription =
+    r'Use the SizedBox.expand(...) named constructor';
+
+const _details =
+    r'''Use SizedBox.shrink and SizedBox.expand constructors appropriately.
+
+The `SizedBox.shrink(...)` and `SizedBox.expand(...)` constructors should be used
+instead of the more general `SizedBox(...)` constructor for specific use cases. 
+
+**Examples**
+
+**BAD:**
+```
+Widget buildLogo() {
+  return SizedBox(
+    height: 0,
+    width: 0,
+    child:const MyLogo(),
+  );
+}
+```
+```
+Widget buildLogo() {
+  return SizedBox(
+    height: double.infinity,
+    width: double.infinity,
+    child:const MyLogo(),
+  );
+}
+```
+
+**GOOD:**
+```
+Widget buildLogo() {
+  return SizedBox.shrink(
+    child:const MyLogo(),
+  );
+}
+```
+```
+Widget buildLogo() {
+  return SizedBox.expand(
+    child:const MyLogo(),
+  );
+}
+```
+''';
+
+class SizedBoxShrinkExpand extends LintRule {
+  SizedBoxShrinkExpand()
+      : super(
+            name: 'sized_box_shrink_expand',
+            description: '',
+            details: _details,
+            group: Group.style) {
+    lintCode = LintCode(name, 'Unused');
+  }
+
+  @override
+  void registerNodeProcessors(
+      NodeLintRegistry registry, LinterContext context) {
+    var visitor = _Visitor(this);
+
+    registry.addInstanceCreationExpression(this, visitor);
+  }
+
+  @override
+  late LintCode lintCode;
+}
+
+class _Visitor extends SimpleAstVisitor {
+  final SizedBoxShrinkExpand rule;
+
+  _Visitor(this.rule);
+
+  @override
+  void visitInstanceCreationExpression(InstanceCreationExpression node) {
+    // Only interested in the default constructor for the SizedBox widget
+    if (!isExactWidgetTypeSizedBox(node.staticType) ||
+        node.constructorName.name != null) {
+      return;
+    }
+
+    var data = _ArgumentData(node.argumentList);
+    if (data.width == 0 && data.height == 0) {
+      rule.lintCode = LintCode(rule.name, _sizedBoxShrinkDescription);
+      rule.reportLint(node.constructorName);
+    } else if (data.width == double.infinity &&
+        data.height == double.infinity) {
+      rule.lintCode = LintCode(rule.name, _sizedBoxExpandDescription);
+      rule.reportLint(node.constructorName);
+    }
+  }
+}
+
+class _ArgumentData {
+  _ArgumentData(ArgumentList node) {
+    for (var argument in node.arguments.cast<NamedExpression>()) {
+      if (argument.name.label.name == 'width') {
+        var argumentVisitor = _ArgumentVisitor();
+        argument.expression.visitChildren(argumentVisitor);
+        width = argumentVisitor.argument;
+      } else if (argument.name.label.name == 'height') {
+        var argumentVisitor = _ArgumentVisitor();
+        argument.expression.visitChildren(argumentVisitor);
+        height = argumentVisitor.argument;
+      }
+    }
+  }
+
+  double? width;
+  double? height;
+}
+
+class _ArgumentVisitor extends SimpleAstVisitor {
+  double? argument;
+
+  @override
+  visitIntegerLiteral(IntegerLiteral node) {
+    argument = node.value!.toDouble();
+  }
+
+  @override
+  visitDoubleLiteral(DoubleLiteral node) {
+    argument = node.value;
+  }
+
+  @override
+  visitSimpleIdentifier(SimpleIdentifier node) {
+    if (node.name.toLowerCase() == 'infinity') {
+      argument = double.infinity;
+    }
+  }
+}

lib/src/util/flutter_utils.dart

@@ -31,6 +31,9 @@ bool isExactWidget(ClassElement element) => _flutter.isExactWidget(element);
 bool isExactWidgetTypeContainer(DartType? type) =>
     _flutter.isExactWidgetTypeContainer(type);
 
+bool isExactWidgetTypeSizedBox(DartType? type) =>
+    _flutter.isExactWidgetTypeSizedBox(type);
+
 bool isKDebugMode(Element? element) => _flutter.isKDebugMode(element);
 
 bool isStatefulWidget(ClassElement? element) =>
@@ -56,16 +59,19 @@ class _Flutter {
   static const _nameStatefulWidget = 'StatefulWidget';
   static const _nameWidget = 'Widget';
   static const _nameContainer = 'Container';
+  static const _nameSizedBox = 'SizedBox';
 
   final String packageName;
   final String widgetsUri;
 
+  final Uri _uriBasic;
   final Uri _uriContainer;
   final Uri _uriFramework;
   final Uri _uriFoundation;
 
   _Flutter(this.packageName, String uriPrefix)
       : widgetsUri = '$uriPrefix/widgets.dart',
+        _uriBasic = Uri.parse('$uriPrefix/src/widgets/basic.dart'),
         _uriContainer = Uri.parse('$uriPrefix/src/widgets/container.dart'),
         _uriFramework = Uri.parse('$uriPrefix/src/widgets/framework.dart'),
         _uriFoundation = Uri.parse('$uriPrefix/src/foundation/constants.dart');
@@ -99,6 +105,10 @@ class _Flutter {
       type is InterfaceType &&
       _isExactWidget(type.element, _nameContainer, _uriContainer);
 
+  bool isExactWidgetTypeSizedBox(DartType? type) =>
+      type is InterfaceType &&
+      _isExactWidget(type.element, _nameSizedBox, _uriBasic);
+
   bool isKDebugMode(Element? element) =>
       element != null &&
       element.name == 'kDebugMode' &&

test_data/mock_packages/flutter/lib/src/widgets/basic.dart

@@ -122,6 +122,14 @@ class Row extends Flex {
   });
 }
 
+class SizedBox extends SingleChildRenderObjectWidget {
+  const SizedBox({Key? key, double? width, double? height, Widget? child});
+  const SizedBox.expand({Key? key, Widget? child});
+  const SizedBox.shrink({Key? key, Widget? child});
+  SizedBox.fromSize({Key? key, Widget? child, Size? size});
+  const SizedBox.square({Key? key, Widget? child, double? dimension});
+}
+
 class Transform extends SingleChildRenderObjectWidget {
   const Transform({
     Key key,

test_data/rules/sized_box_shrink_expand.dart

@@ -0,0 +1,85 @@
+// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// test w/ `dart test -N sized_box_shrink_expand`
+
+import 'package:flutter/foundation.dart';
+import 'package:flutter/widgets.dart';
+
+Widget sizedBoxWithZeroWidthZeroHeight() {
+  return SizedBox(
+    // LINT
+    height: 0,
+    width: 0,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithInfiniteWidthInfiniteHeight() {
+  return SizedBox(
+    // LINT
+    height: double.INFINITY,
+    width: double.INFINITY,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithInfiniteWidthzeroHeight() {
+  return SizedBox(
+    // OK
+    height: 0,
+    width: double.INFINITY,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithZeroWidthInfiniteHeight() {
+  return SizedBox(
+    // OK
+    height: double.INFINITY,
+    width: 0,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithMixedWidthsAndHeights() {
+  return SizedBox(
+    // OK
+    height: 26,
+    width: 42,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithZeroWidth() {
+  return SizedBox(
+    // OK
+    width: 0,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithInfiniteWidth() {
+  return SizedBox(
+    // OK
+    width: double.INFINITY,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithZeroHeight() {
+  return SizedBox(
+    // OK
+    height: 0,
+    child: Container(),
+  );
+}
+
+Widget sizedBoxWithInfiniteHeight() {
+  return SizedBox(
+    // OK
+    height: double.INFINITY,
+    child: Container(),
+  );
+}