feat: handle widget members order separately (#1043)

* feat: handle widget members order separately

* docs: update docs

Author: incendial

CHANGELOG.md

@@ -6,6 +6,7 @@
 * feat: support report to the json file option for the `analyze` command.
 * feat: make CliRunner a part of public API in order to support transitive executable calls use-case.
 * feat: add static code diagnostic [`avoid-cascade-after-if-null`](https://dartcodemetrics.dev/docs/rules/common/avoid-cascade-after-if-null).
+* feat: **Breaking change** handle widget members order separately in [`member-ordering`](https://dartcodemetrics.dev/docs/rules/common/member-ordering).
 
 ## 4.21.2
 

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/config_parser.dart

@@ -13,6 +13,20 @@ class _ConfigParser {
     'private-methods',
   ];
 
+  static const _defaultWidgetsOrderList = [
+    'constructor',
+    'named-constructor',
+    'const-fields',
+    'static-methods',
+    'final-fields',
+    'init-state-method',
+    'var-fields',
+    'init-state-method',
+    'private-methods',
+    'overridden-public-methods',
+    'build-method',
+  ];
+
   static final _regExp = RegExp(
     '(overridden-|protected-)?(private-|public-)?(static-)?(late-)?'
     '(var-|final-|const-)?(nullable-)?(named-)?(factory-)?(build-)?'
@@ -28,6 +42,14 @@ class _ConfigParser {
     return order.map(_parseGroup).whereNotNull().toList();
   }
 
+  static List<_MemberGroup> parseWidgetsOrder(Map<String, Object> config) {
+    final widgetsOrder = config['widgets-order'] is Iterable
+        ? List<String>.from(config['widgets-order'] as Iterable)
+        : _defaultWidgetsOrderList;
+
+    return widgetsOrder.map(_parseGroup).whereNotNull().toList();
+  }
+
   static bool parseAlphabetize(Map<String, Object> config) =>
       (config['alphabetize'] as bool?) ?? false;
 

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/member_ordering_rule.dart

@@ -31,11 +31,13 @@ class MemberOrderingRule extends CommonRule {
       'type name should be alphabetically before';
 
   final List<_MemberGroup> _groupsOrder;
+  final List<_MemberGroup> _widgetsGroupsOrder;
   final bool _alphabetize;
   final bool _alphabetizeByType;
 
   MemberOrderingRule([Map<String, Object> config = const {}])
       : _groupsOrder = _ConfigParser.parseOrder(config),
+        _widgetsGroupsOrder = _ConfigParser.parseWidgetsOrder(config),
         _alphabetize = _ConfigParser.parseAlphabetize(config),
         _alphabetizeByType = _ConfigParser.parseAlphabetizeByType(config),
         super(
@@ -46,7 +48,7 @@ class MemberOrderingRule extends CommonRule {
 
   @override
   Iterable<Issue> check(InternalResolvedUnitResult source) {
-    final visitor = _Visitor(_groupsOrder);
+    final visitor = _Visitor(_groupsOrder, _widgetsGroupsOrder);
 
     final membersInfo = [
       for (final entry in source.unit.childEntities)

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/visitor.dart

@@ -2,10 +2,11 @@ part of 'member_ordering_rule.dart';
 
 class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
   final List<_MemberGroup> _groupsOrder;
+  final List<_MemberGroup> _widgetsGroupsOrder;
 
   final _membersInfo = <_MemberInfo>[];
 
-  _Visitor(this._groupsOrder);
+  _Visitor(this._groupsOrder, this._widgetsGroupsOrder);
 
   @override
   List<_MemberInfo> visitClassDeclaration(ClassDeclaration node) {
@@ -46,6 +47,7 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
           declaration.fields.type?.type
                   ?.getDisplayString(withNullability: false) ??
               '_',
+          isFlutterWidget,
         ),
       ));
     }
@@ -65,6 +67,7 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
           closestGroup,
           declaration.name?.lexeme ?? '',
           declaration.returnType.name,
+          isFlutterWidget,
         ),
       ));
     }
@@ -87,6 +90,7 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
             declaration.returnType?.type
                     ?.getDisplayString(withNullability: false) ??
                 '_',
+            isFlutterWidget,
           ),
         ));
       }
@@ -103,6 +107,7 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
             declaration.returnType?.type
                     ?.getDisplayString(withNullability: false) ??
                 '_',
+            isFlutterWidget,
           ),
         ));
       }
@@ -113,13 +118,13 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     _MemberGroup parsedGroup,
     bool isFlutterWidget,
   ) {
-    final closestGroups = _groupsOrder
+    final closestGroups = (isFlutterWidget ? _widgetsGroupsOrder : _groupsOrder)
         .where(
           (group) =>
               _isConstructorGroup(group, parsedGroup) ||
               _isFieldGroup(group, parsedGroup) ||
               _isGetSetGroup(group, parsedGroup) ||
-              (isFlutterWidget && _isFlutterMethodGroup(group, parsedGroup)) ||
+              _isFlutterMethodGroup(group, parsedGroup) ||
               _isMethodGroup(group, parsedGroup),
         )
         .sorted(
@@ -133,6 +138,7 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     _MemberGroup memberGroup,
     String memberName,
     String typeName,
+    bool isFlutterWidget,
   ) {
     if (_membersInfo.isNotEmpty) {
       final lastMemberOrder = _membersInfo.last.memberOrder;
@@ -162,7 +168,11 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
         memberGroup: memberGroup,
         previousMemberGroup: previousMemberGroup,
         isWrong: (hasSameGroup && lastMemberOrder.isWrong) ||
-            _isCurrentGroupBefore(lastMemberOrder.memberGroup, memberGroup),
+            _isCurrentGroupBefore(
+              lastMemberOrder.memberGroup,
+              memberGroup,
+              isFlutterWidget,
+            ),
       );
     }
 
@@ -179,8 +189,12 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
   bool _isCurrentGroupBefore(
     _MemberGroup lastMemberGroup,
     _MemberGroup memberGroup,
-  ) =>
-      _groupsOrder.indexOf(lastMemberGroup) > _groupsOrder.indexOf(memberGroup);
+    bool isFlutterWidget,
+  ) {
+    final group = isFlutterWidget ? _widgetsGroupsOrder : _groupsOrder;
+
+    return group.indexOf(lastMemberGroup) > group.indexOf(memberGroup);
+  }
 
   bool _isConstructorGroup(_MemberGroup group, _MemberGroup parsedGroup) =>
       group is _ConstructorMemberGroup &&

test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/examples/flutter_methods_example.dart renamed to test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/examples/flutter_widget_example.dart

@@ -0,0 +1,23 @@
+class MyNotWidget {
+  const MyNotWidget();
+
+  void doNothing() {}
+
+  @override
+  void build(Object context) {}
+
+  @override
+  void initState() {}
+
+  @override
+  void didChangeDependencies() {}
+
+  @override
+  void didUpdateWidget() {}
+
+  @override
+  void dispose() {}
+
+  @override
+  void someOtherMethod() {}
+}

test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/examples/not_widget_example.dart

@@ -13,8 +13,10 @@ const _alphabeticalCorrectExamplePath =
     'member_ordering/examples/alphabetical_correct_example.dart';
 const _typeAlphabeticalExamplePath =
     'member_ordering/examples/type_alphabetical_example.dart';
-const _flutterMethodsExamplePath =
-    'member_ordering/examples/flutter_methods_example.dart';
+const _flutterWidgetExamplePath =
+    'member_ordering/examples/flutter_widget_example.dart';
+const _notWidgetExamplePath =
+    'member_ordering/examples/not_widget_example.dart';
 
 void main() {
   group('MemberOrderingRule', () {
@@ -64,6 +66,25 @@ void main() {
 
         RuleTestHelper.verifyNoIssues(issues);
       });
+
+      test('reports about Flutter widget issues', () async {
+        final unit =
+            await RuleTestHelper.resolveFromFile(_flutterWidgetExamplePath);
+        final issues = MemberOrderingRule().check(unit);
+
+        RuleTestHelper.verifyIssues(
+          issues: issues,
+          startLines: [12],
+          startColumns: [3],
+          locationTexts: [
+            '@override\n'
+                '  void initState() {}',
+          ],
+          messages: [
+            'init-state-method should be before build-method.',
+          ],
+        );
+      });
     });
 
     group('with custom config', () {
@@ -210,11 +231,11 @@ void main() {
         },
       );
 
-      test('accepts flutter methods and reports issues', () async {
+      test('accepts Flutter widgets order and reports issues', () async {
         final unit =
-            await RuleTestHelper.resolveFromFile(_flutterMethodsExamplePath);
+            await RuleTestHelper.resolveFromFile(_flutterWidgetExamplePath);
         final config = {
-          'order': [
+          'widgets-order': [
             'constructors',
             'overridden-methods',
             'dispose-method',
@@ -259,6 +280,28 @@ void main() {
         );
       });
 
+      test('report no issue for non-widget classes', () async {
+        final unit =
+            await RuleTestHelper.resolveFromFile(_notWidgetExamplePath);
+        final config = {
+          'widgets-order': [
+            'constructors',
+            'overridden-methods',
+            'dispose-method',
+            'did-update-widget-method',
+            'did-change-dependencies-method',
+            'init-state-method',
+            'build-method',
+            'public-methods',
+          ],
+          'order': <String>[],
+        };
+
+        final issues = MemberOrderingRule(config).check(unit);
+
+        RuleTestHelper.verifyNoIssues(issues);
+      });
+
       group('and alphabetical order', () {
         test('reports about found issues', () async {
           final unit =

test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/member_ordering_rule_test.dart

@@ -4,7 +4,9 @@ import RuleDetails from '@site/src/components/RuleDetails';
 
 Enforces extended member ordering.
 
-The value for the `order` entry should match the following pattern:
+Order for regular classes can be confugured by `order`. To configure widget class members order use `widgets-order`.
+
+The value for the `order` or `widgets-order` entries should match the following pattern:
 
 `< (overridden | protected)- >< (private | public)- >< static- >< late- >< (var | final | const)- >< nullable- >< named- >< factory- > (fields | getters | getters-setters | setters | constructors | methods) `
 
@@ -16,15 +18,7 @@ Not all of the pattern parts are applicable for every case, for example, `late-c
 
 :::
 
-Additionally, in order to apply ordering for the Flutter specific widget methods, you can configure the rule with:
-
-- build-method
-- init-state-method
-- did-change-dependencies-method
-- did-update-widget-method
-- dispose-method
-
-For example, the value for `order` may be an array consisting of the following strings:
+For example, the value for `order` or `widgets-order` may be an array consisting of the following strings:
 
 - public-late-final-fields
 - private-late-final-fields
@@ -47,7 +41,7 @@ You can simply configure the rule to sort only by a type:
 - getters (or just **getters-setters** if you don't want to separate them)
 - constructors
 
-The default config is:
+The default config for `order` is:
 
 - public-fields
 - private-fields
@@ -59,6 +53,20 @@ The default config is:
 - public-methods
 - private-methods
 
+The default config for `widgets-order` is ([from Flutter style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#order-other-class-members-in-a-way-that-makes-sense)):
+
+- constructor
+- named-constructor
+- const-fields
+- static-methods
+- final-fields
+- init-state-method
+- var-fields
+- init-state-method
+- private-methods
+- overridden-public-methods
+- build-method
+
 The `alphabetize` option will enforce that members within the same category should be alphabetically sorted by name.
 
 The `alphabetize-by-type` option will enforce that members within the same category should be alphabetically sorted by theirs type name.