Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
271 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| // 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 _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 when the named constructors | ||
| capture the intent of the code more succinctly. | ||
| **Examples** | ||
| **BAD:** | ||
| ```dart | ||
| Widget buildLogo() { | ||
| return SizedBox( | ||
| height: 0, | ||
| width: 0, | ||
| child:const MyLogo(), | ||
| ); | ||
| } | ||
| ``` | ||
| ```dart | ||
| Widget buildLogo() { | ||
| return SizedBox( | ||
| height: double.infinity, | ||
| width: double.infinity, | ||
| child:const MyLogo(), | ||
| ); | ||
| } | ||
| ``` | ||
| **GOOD:** | ||
| ```dart | ||
| Widget buildLogo() { | ||
| return SizedBox.shrink( | ||
| child:const MyLogo(), | ||
| ); | ||
| } | ||
| ``` | ||
| ```dart | ||
| Widget buildLogo() { | ||
| return SizedBox.expand( | ||
| child:const MyLogo(), | ||
| ); | ||
| } | ||
| ``` | ||
| '''; | ||
|
|
||
| class SizedBoxShrinkExpand extends LintRule { | ||
| SizedBoxShrinkExpand() | ||
| : super( | ||
| name: 'sized_box_shrink_expand', | ||
| description: 'Use SizedBox shrink and expand named constructors.', | ||
| details: _details, | ||
| group: Group.style); | ||
|
|
||
| @override | ||
| void registerNodeProcessors( | ||
| NodeLintRegistry registry, LinterContext context) { | ||
| var visitor = _Visitor(this); | ||
|
|
||
| registry.addInstanceCreationExpression(this, visitor); | ||
| } | ||
| } | ||
|
|
||
| class _Visitor extends SimpleAstVisitor { | ||
| final SizedBoxShrinkExpand rule; | ||
|
|
||
| _Visitor(this.rule); | ||
|
|
||
| static const LintCode useShrink = LintCode( | ||
| 'sized_box_shrink_expand', 'Use the `SizedBox.shrink` constructor.'); | ||
| static const LintCode useExpand = LintCode( | ||
| 'sized_box_shrink_expand', 'Use the `SizedBox.expand` constructor.'); | ||
|
|
||
| @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.positionalArgumentFound) { | ||
| return; | ||
| } | ||
| if (data.width == 0 && data.height == 0) { | ||
| rule.reportLint(node.constructorName, errorCode: useShrink); | ||
| } else if (data.width == double.infinity && | ||
| data.height == double.infinity) { | ||
| rule.reportLint(node.constructorName, errorCode: useExpand); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class _ArgumentData { | ||
| _ArgumentData(ArgumentList node) { | ||
| for (var argument in node.arguments) { | ||
| if (argument is! NamedExpression) { | ||
| positionalArgumentFound = true; | ||
| return; | ||
| } | ||
| if (argument.name.label.name == 'width') { | ||
| width = _argumentValue(argument.expression); | ||
| } else if (argument.name.label.name == 'height') { | ||
| height = _argumentValue(argument.expression); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| double? _argumentValue(Expression argument) { | ||
| if (argument is IntegerLiteral) { | ||
| return argument.value?.toDouble(); | ||
| } else if (argument is DoubleLiteral) { | ||
| return argument.value; | ||
| } else if (argument is PropertyAccess && | ||
| (argument.propertyName.name == 'infinity' || | ||
| argument.propertyName.name == 'INFINITY')) { | ||
| var target = argument.target; | ||
| if (target is SimpleIdentifier && target.name == 'double') { | ||
| return double.infinity; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| var positionalArgumentFound = false; | ||
| double? width; | ||
| double? height; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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(), | ||
| ); | ||
| } |