feat: add build method config entry to member-ordering-extended (#926)

* feat: add build method config entry to member-ordering-extended

* chore: fix analyzer issue

* feat: add flutter specific methods config

Co-authored-by: Dmitry Krutskikh <dmitry.krutskikh@gmail.com>

Author: incendial

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 * feat: add configuration to [`prefer-moving-to-variable`](https://dartcodemetrics.dev/docs/rules/common/prefer-moving-to-variable).
+* feat: add flutter specific methods config to [`member-ordering-extended`](https://dartcodemetrics.dev/docs/rules/common/member-ordering-extended).
 * feat: add static code diagnostic [`avoid-duplicate-exports`](https://dartcodemetrics.dev/docs/rules/common/avoid-duplicate-exports).
 * feat: add static code diagnostic [`avoid-shrink-wrap-in-lists`](https://dartcodemetrics.dev/docs/rules/flutter/avoid-shrink-wrap-in-lists).
 * feat: add static code diagnostic [`avoid-top-level-members-in-tests`](https://dartcodemetrics.dev/docs/rules/common/avoid-top-level-members-in-tests).

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

@@ -15,7 +15,9 @@ class _ConfigParser {
 
   static final _regExp = RegExp(
     '(overridden-|protected-)?(private-|public-)?(static-)?(late-)?'
-    '(var-|final-|const-)?(nullable-)?(named-)?(factory-)?',
+    '(var-|final-|const-)?(nullable-)?(named-)?(factory-)?(build-)?'
+    '(init-state-)?(did-change-dependencies-)?(did-update-widget-)?'
+    '(dispose-)?',
   );
 
   static List<_MemberGroup> parseOrder(Map<String, Object> config) {
@@ -52,6 +54,11 @@ class _ConfigParser {
       final isNullable = match.group(6) != null;
       final isNamed = match.group(7) != null;
       final isFactory = match.group(8) != null;
+      final isBuild = match.group(9) != null;
+      final isInitState = match.group(10) != null;
+      final isDidChangeDependencies = match.group(11) != null;
+      final isDidUpdateWidget = match.group(12) != null;
+      final isDispose = match.group(13) != null;
 
       switch (type) {
         case _MemberType.field:
@@ -70,6 +77,11 @@ class _ConfigParser {
           return _MethodMemberGroup._(
             isNullable: isNullable,
             isStatic: isStatic,
+            isBuild: isBuild,
+            isInitState: isInitState,
+            isDidChangeDependencies: isDidChangeDependencies,
+            isDidUpdateWidget: isDidUpdateWidget,
+            isDispose: isDispose,
             annotation: annotation,
             memberType: type,
             modifier: modifier,

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/member_ordering_extended_rule.dart

@@ -5,6 +5,7 @@ import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:analyzer/dart/element/nullability_suffix.dart';
 import 'package:collection/collection.dart';
 
+import '../../../../../utils/flutter_types_utils.dart';
 import '../../../../../utils/node_utils.dart';
 import '../../../lint_utils.dart';
 import '../../../models/internal_resolved_unit_result.dart';

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/models/member_group.dart

@@ -89,10 +89,20 @@ class _FieldMemberGroup extends _MemberGroup {
 class _MethodMemberGroup extends _MemberGroup {
   final bool isStatic;
   final bool isNullable;
+  final bool isBuild;
+  final bool isInitState;
+  final bool isDidChangeDependencies;
+  final bool isDidUpdateWidget;
+  final bool isDispose;
 
   const _MethodMemberGroup._({
     required this.isNullable,
     required this.isStatic,
+    required this.isBuild,
+    required this.isInitState,
+    required this.isDidChangeDependencies,
+    required this.isDidUpdateWidget,
+    required this.isDispose,
     required _Annotation annotation,
     required _MemberType memberType,
     required _Modifier modifier,
@@ -105,18 +115,33 @@ class _MethodMemberGroup extends _MemberGroup {
         );
 
   factory _MethodMemberGroup.parse(MethodDeclaration declaration) {
+    final methodName = declaration.name.name;
     final annotation = declaration.metadata
         .map((metadata) => _Annotation.parse(metadata.name.name))
         .whereNotNull()
         .firstOrNull;
-    final modifier = Identifier.isPrivateName(declaration.name.name)
+    final modifier = Identifier.isPrivateName(methodName)
         ? _Modifier.private
         : _Modifier.public;
 
+    final hasOverrideAnnotation = annotation == _Annotation.override;
+    final isBuild = methodName == 'build' && hasOverrideAnnotation;
+    final isInitState = methodName == 'initState' && hasOverrideAnnotation;
+    final isDidChangeDependencies =
+        methodName == 'didChangeDependencies' && hasOverrideAnnotation;
+    final isDidUpdateWidget =
+        methodName == 'didUpdateWidget' && hasOverrideAnnotation;
+    final isDispose = methodName == 'dispose' && hasOverrideAnnotation;
+
     return _MethodMemberGroup._(
       annotation: annotation ?? _Annotation.unset,
       isStatic: declaration.isStatic,
       isNullable: declaration.returnType?.question != null,
+      isBuild: isBuild,
+      isInitState: isInitState,
+      isDidChangeDependencies: isDidChangeDependencies,
+      isDidUpdateWidget: isDidUpdateWidget,
+      isDispose: isDispose,
       memberType: _MemberType.method,
       modifier: modifier,
       rawRepresentation: '',
@@ -131,6 +156,11 @@ class _MethodMemberGroup extends _MemberGroup {
     coefficient += isNullable ? 1 : 0;
     coefficient += annotation != _Annotation.unset ? 1 : 0;
     coefficient += modifier != _Modifier.unset ? 1 : 0;
+    coefficient += isBuild ? 10 : 0;
+    coefficient += isInitState ? 10 : 0;
+    coefficient += isDidChangeDependencies ? 10 : 0;
+    coefficient += isDidUpdateWidget ? 10 : 0;
+    coefficient += isDispose ? 10 : 0;
 
     return coefficient;
   }

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/models/member_type.dart

@@ -2,9 +2,10 @@ part of '../member_ordering_extended_rule.dart';
 
 class _MemberType {
   final String type;
+  final String? typeAlias;
 
   static const field = _MemberType._('fields');
-  static const method = _MemberType._('methods');
+  static const method = _MemberType._('methods', typeAlias: 'method');
   static const constructor = _MemberType._('constructors');
   static const getter = _MemberType._('getters');
   static const setter = _MemberType._('setters');
@@ -19,8 +20,8 @@ class _MemberType {
     getterAndSetter,
   ];
 
-  const _MemberType._(this.type);
+  const _MemberType._(this.type, {this.typeAlias});
 
-  static _MemberType? parse(String? name) =>
-      all.firstWhereOrNull((type) => name == type.type);
+  static _MemberType? parse(String? name) => all
+      .firstWhereOrNull((type) => name == type.type || name == type.typeAlias);
 }

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

@@ -13,22 +13,29 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
 
     _membersInfo.clear();
 
+    final type = node.extendsClause?.superclass.type;
+    final isFlutterWidget =
+        isWidgetOrSubclass(type) || isWidgetStateOrSubclass(type);
+
     for (final member in node.members) {
       if (member is FieldDeclaration) {
-        _visitFieldDeclaration(member);
+        _visitFieldDeclaration(member, isFlutterWidget);
       } else if (member is ConstructorDeclaration) {
-        _visitConstructorDeclaration(member);
+        _visitConstructorDeclaration(member, isFlutterWidget);
       } else if (member is MethodDeclaration) {
-        _visitMethodDeclaration(member);
+        _visitMethodDeclaration(member, isFlutterWidget);
       }
     }
 
     return _membersInfo;
   }
 
-  void _visitFieldDeclaration(FieldDeclaration declaration) {
+  void _visitFieldDeclaration(
+    FieldDeclaration declaration,
+    bool isFlutterWidget,
+  ) {
     final group = _FieldMemberGroup.parse(declaration);
-    final closestGroup = _getClosestGroup(group);
+    final closestGroup = _getClosestGroup(group, isFlutterWidget);
 
     if (closestGroup != null) {
       _membersInfo.add(_MemberInfo(
@@ -44,9 +51,12 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     }
   }
 
-  void _visitConstructorDeclaration(ConstructorDeclaration declaration) {
+  void _visitConstructorDeclaration(
+    ConstructorDeclaration declaration,
+    bool isFlutterWidget,
+  ) {
     final group = _ConstructorMemberGroup.parse(declaration);
-    final closestGroup = _getClosestGroup(group);
+    final closestGroup = _getClosestGroup(group, isFlutterWidget);
 
     if (closestGroup != null) {
       _membersInfo.add(_MemberInfo(
@@ -60,10 +70,13 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     }
   }
 
-  void _visitMethodDeclaration(MethodDeclaration declaration) {
+  void _visitMethodDeclaration(
+    MethodDeclaration declaration,
+    bool isFlutterWidget,
+  ) {
     if (declaration.isGetter || declaration.isSetter) {
       final group = _GetSetMemberGroup.parse(declaration);
-      final closestGroup = _getClosestGroup(group);
+      final closestGroup = _getClosestGroup(group, isFlutterWidget);
 
       if (closestGroup != null) {
         _membersInfo.add(_MemberInfo(
@@ -79,7 +92,7 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
       }
     } else {
       final group = _MethodMemberGroup.parse(declaration);
-      final closestGroup = _getClosestGroup(group);
+      final closestGroup = _getClosestGroup(group, isFlutterWidget);
 
       if (closestGroup != null) {
         _membersInfo.add(_MemberInfo(
@@ -96,13 +109,17 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     }
   }
 
-  _MemberGroup? _getClosestGroup(_MemberGroup parsedGroup) {
+  _MemberGroup? _getClosestGroup(
+    _MemberGroup parsedGroup,
+    bool isFlutterWidget,
+  ) {
     final closestGroups = _groupsOrder
         .where(
           (group) =>
               _isConstructorGroup(group, parsedGroup) ||
               _isFieldGroup(group, parsedGroup) ||
               _isGetSetGroup(group, parsedGroup) ||
+              (isFlutterWidget && _isFlutterMethodGroup(group, parsedGroup)) ||
               _isMethodGroup(group, parsedGroup),
         )
         .sorted(
@@ -180,11 +197,28 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
       parsedGroup is _MethodMemberGroup &&
       (!group.isStatic || group.isStatic == parsedGroup.isStatic) &&
       (!group.isNullable || group.isNullable == parsedGroup.isNullable) &&
+      !group.isBuild &&
+      !group.isDidChangeDependencies &&
+      !group.isDidUpdateWidget &&
+      !group.isInitState &&
+      !group.isDispose &&
       (group.modifier == _Modifier.unset ||
           group.modifier == parsedGroup.modifier) &&
       (group.annotation == _Annotation.unset ||
           group.annotation == parsedGroup.annotation);
 
+  bool _isFlutterMethodGroup(_MemberGroup group, _MemberGroup parsedGroup) =>
+      group is _MethodMemberGroup &&
+      parsedGroup is _MethodMemberGroup &&
+      ((group.isBuild && group.isBuild == parsedGroup.isBuild) ||
+          (group.isInitState && group.isInitState == parsedGroup.isInitState) ||
+          (group.isDidChangeDependencies &&
+              group.isDidChangeDependencies ==
+                  parsedGroup.isDidChangeDependencies) ||
+          (group.isDidUpdateWidget &&
+              group.isDidUpdateWidget == parsedGroup.isDidUpdateWidget) ||
+          (group.isDispose && group.isDispose == parsedGroup.isDispose));
+
   bool _isGetSetGroup(_MemberGroup group, _MemberGroup parsedGroup) =>
       group is _GetSetMemberGroup &&
       parsedGroup is _GetSetMemberGroup &&

test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/examples/flutter_methods_example.dart

@@ -0,0 +1,44 @@
+class _MyStatelessWidget extends StatelessWidget {
+  const _MyStatelessWidget();
+
+  void doNothing() {}
+
+  // LINT
+  @override
+  Widget build(BuildContext context) {
+    return Widget();
+  }
+
+  @override
+  void initState() {} // LINT
+
+  @override
+  void didChangeDependencies() {} // LINT
+
+  @override
+  void didUpdateWidget() {} // LINT
+
+  @override
+  void dispose() {} // LINT
+
+  @override
+  void someOtherMethod() {} // LINT
+}
+
+class Widget {}
+
+class StatelessWidget extends Widget {
+  Widget build(BuildContext context);
+
+  void initState();
+
+  void didChangeDependencies();
+
+  void didUpdateWidget();
+
+  void dispose();
+
+  void someOtherMethod();
+}
+
+class BuildContext {}

test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/member_ordering_extened_rule_test.dart

@@ -13,6 +13,8 @@ const _alphabeticalCorrectExamplePath =
     'member_ordering_extended/examples/alphabetical_correct_example.dart';
 const _typeAlphabeticalExamplePath =
     'member_ordering_extended/examples/type_alphabetical_example.dart';
+const _flutterMethodsExamplePath =
+    'member_ordering_extended/examples/flutter_methods_example.dart';
 
 void main() {
   group('MemberOrderingExtendedRule', () {
@@ -208,6 +210,55 @@ void main() {
         },
       );
 
+      test('accepts flutter methods and reports issues', () async {
+        final unit =
+            await RuleTestHelper.resolveFromFile(_flutterMethodsExamplePath);
+        final config = {
+          'order': [
+            'constructors',
+            'overridden-methods',
+            'dispose-method',
+            'did-update-widget-method',
+            'did-change-dependencies-method',
+            'init-state-method',
+            'build-method',
+            'public-methods',
+          ],
+        };
+
+        final issues = MemberOrderingExtendedRule(config).check(unit);
+
+        RuleTestHelper.verifyIssues(
+          issues: issues,
+          startLines: [7, 12, 15, 18, 21, 24],
+          startColumns: [3, 3, 3, 3, 3, 3],
+          locationTexts: [
+            '@override\n'
+                '  Widget build(BuildContext context) {\n'
+                '    return Widget();\n'
+                '  }',
+            '@override\n'
+                '  void initState() {}',
+            '@override\n'
+                '  void didChangeDependencies() {}',
+            '@override\n'
+                '  void didUpdateWidget() {}',
+            '@override\n'
+                '  void dispose() {}',
+            '@override\n'
+                '  void someOtherMethod() {}',
+          ],
+          messages: [
+            'build-method should be before public-methods.',
+            'init-state-method should be before build-method.',
+            'did-change-dependencies-method should be before init-state-method.',
+            'did-update-widget-method should be before did-change-dependencies-method.',
+            'dispose-method should be before did-update-widget-method.',
+            'overridden-methods should be before dispose-method.',
+          ],
+        );
+      });
+
       group('and alphabetical order', () {
         test('reports about found issues', () async {
           final unit =