feat: rename member-ordering-extended to member-ordering (#1041)

* chore: bump dorny/test-reporter from 1.5.0 to 1.6.0 (#1037)

Bumps [dorny/test-reporter](https://github.com/dorny/test-reporter) from 1.5.0 to 1.6.0.
- [Release notes](https://github.com/dorny/test-reporter/releases)
- [Changelog](https://github.com/dorny/test-reporter/blob/main/CHANGELOG.md)
- [Commits](dorny/test-reporter@v1.5.0...v1.6.0)

---
updated-dependencies:
- dependency-name: dorny/test-reporter
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: rename member-ordering-extended to member-ordering

* fix: update imports

* fix: update imports

* test: update tests

* test: update tests

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: incendial

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+* feat: **Breaking change** rename `member-ordering-extended` to `member-ordering`, discarding the old implementation.
 * 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).

lib/presets/dart_all.yaml

@@ -23,7 +23,7 @@ dart_code_metrics:
     - binary-expression-operand-order
     - double-literal-format
     - format-comment
-    - member-ordering-extended
+    - member-ordering
     - newline-before-return
     - no-boolean-literal-compare
     - no-empty-block

lib/src/analyzers/lint_analyzer/rules/rules_factory.dart

@@ -35,7 +35,6 @@ import 'rules_list/consistent_update_render_object/consistent_update_render_obje
 import 'rules_list/double_literal_format/double_literal_format_rule.dart';
 import 'rules_list/format_comment/format_comment_rule.dart';
 import 'rules_list/member_ordering/member_ordering_rule.dart';
-import 'rules_list/member_ordering_extended/member_ordering_extended_rule.dart';
 import 'rules_list/missing_test_assertion/missing_test_assertion_rule.dart';
 import 'rules_list/newline_before_return/newline_before_return_rule.dart';
 import 'rules_list/no_boolean_literal_compare/no_boolean_literal_compare_rule.dart';
@@ -111,7 +110,6 @@ final _implementedRules = <String, Rule Function(Map<String, Object>)>{
   DoubleLiteralFormatRule.ruleId: DoubleLiteralFormatRule.new,
   FormatCommentRule.ruleId: FormatCommentRule.new,
   MemberOrderingRule.ruleId: MemberOrderingRule.new,
-  MemberOrderingExtendedRule.ruleId: MemberOrderingExtendedRule.new,
   MissingTestAssertionRule.ruleId: MissingTestAssertionRule.new,
   NewlineBeforeReturnRule.ruleId: NewlineBeforeReturnRule.new,
   NoBooleanLiteralCompareRule.ruleId: NoBooleanLiteralCompareRule.new,

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

@@ -1,22 +1,117 @@
 part of 'member_ordering_rule.dart';
 
 class _ConfigParser {
-  static const _orderConfig = 'order';
-
-  static List<_MembersGroup> parseOrder(Map<String, Object> config) {
-    final order = config[_orderConfig] is Iterable
-        ? List<String>.from(config[_orderConfig] as Iterable)
-        : <String>[];
-
-    return order.isEmpty
-        ? _MembersGroup._groupsOrder
-        : order
-            .map((group) => group.snakeCaseToKebab())
-            .map(_MembersGroup.parse)
-            .whereNotNull()
-            .toList();
+  static const _defaultOrderList = [
+    'public-fields',
+    'private-fields',
+    'public-getters',
+    'private-getters',
+    'public-setters',
+    'private-setters',
+    'constructors',
+    'public-methods',
+    'private-methods',
+  ];
+
+  static final _regExp = RegExp(
+    '(overridden-|protected-)?(private-|public-)?(static-)?(late-)?'
+    '(var-|final-|const-)?(nullable-)?(named-)?(factory-)?(build-)?'
+    '(init-state-)?(did-change-dependencies-)?(did-update-widget-)?'
+    '(dispose-)?',
+  );
+
+  static List<_MemberGroup> parseOrder(Map<String, Object> config) {
+    final order = config['order'] is Iterable
+        ? List<String>.from(config['order'] as Iterable)
+        : _defaultOrderList;
+
+    return order.map(_parseGroup).whereNotNull().toList();
   }
 
   static bool parseAlphabetize(Map<String, Object> config) =>
       (config['alphabetize'] as bool?) ?? false;
+
+  static bool parseAlphabetizeByType(Map<String, Object> config) =>
+      (config['alphabetize-by-type'] as bool?) ?? false;
+
+  // ignore: long-method
+  static _MemberGroup? _parseGroup(String group) {
+    final lastGroup = group.endsWith('getters-setters')
+        ? 'getters-setters'
+        : group.split('-').lastOrNull;
+    final type = _MemberType.parse(lastGroup);
+    final result = _regExp.allMatches(group.toLowerCase());
+
+    final hasGroups = result.isNotEmpty && result.first.groupCount > 0;
+    if (hasGroups && type != null) {
+      final match = result.first;
+
+      final annotation = _Annotation.parse(match.group(1)?.replaceAll('-', ''));
+      final modifier = _Modifier.parse(match.group(2)?.replaceAll('-', ''));
+      final isStatic = match.group(3) != null;
+      final isLate = match.group(4) != null;
+      final keyword = _FieldKeyword.parse(match.group(5)?.replaceAll('-', ''));
+      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:
+          return _FieldMemberGroup._(
+            isLate: isLate,
+            isNullable: isNullable,
+            isStatic: isStatic,
+            keyword: keyword,
+            annotation: annotation,
+            memberType: type,
+            modifier: modifier,
+            rawRepresentation: group,
+          );
+
+        case _MemberType.method:
+          return _MethodMemberGroup._(
+            isNullable: isNullable,
+            isStatic: isStatic,
+            isBuild: isBuild,
+            isInitState: isInitState,
+            isDidChangeDependencies: isDidChangeDependencies,
+            isDidUpdateWidget: isDidUpdateWidget,
+            isDispose: isDispose,
+            annotation: annotation,
+            memberType: type,
+            modifier: modifier,
+            rawRepresentation: group,
+          );
+
+        case _MemberType.getter:
+        case _MemberType.setter:
+        case _MemberType.getterAndSetter:
+          return _GetSetMemberGroup._(
+            isNullable: isNullable,
+            isStatic: isStatic,
+            annotation: annotation,
+            memberType: type,
+            modifier: modifier,
+            rawRepresentation: group,
+          );
+
+        case _MemberType.constructor:
+          return _ConstructorMemberGroup._(
+            isNamed: isFactory || isNamed,
+            isFactory: isFactory,
+            annotation: annotation,
+            memberType: type,
+            modifier: modifier,
+            rawRepresentation: group,
+          );
+      }
+    }
+
+    return null;
+  }
 }

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

@@ -2,10 +2,11 @@
 
 import 'package:analyzer/dart/ast/ast.dart';
 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 '../../../../../utils/string_extensions.dart';
 import '../../../lint_utils.dart';
 import '../../../models/internal_resolved_unit_result.dart';
 import '../../../models/issue.dart';
@@ -14,22 +15,29 @@ import '../../models/common_rule.dart';
 import '../../rule_utils.dart';
 
 part 'config_parser.dart';
+part 'models/annotation.dart';
+part 'models/field_keyword.dart';
+part 'models/member_group.dart';
+part 'models/member_type.dart';
+part 'models/modifier.dart';
 part 'visitor.dart';
 
-// Inspired by TSLint (https://palantir.github.io/tslint/rules/member-ordering/)
-
 class MemberOrderingRule extends CommonRule {
   static const ruleId = 'member-ordering';
 
   static const _warningMessage = 'should be before';
   static const _warningAlphabeticalMessage = 'should be alphabetically before';
+  static const _warningTypeAlphabeticalMessage =
+      'type name should be alphabetically before';
 
-  final List<_MembersGroup> _groupsOrder;
+  final List<_MemberGroup> _groupsOrder;
   final bool _alphabetize;
+  final bool _alphabetizeByType;
 
   MemberOrderingRule([Map<String, Object> config = const {}])
       : _groupsOrder = _ConfigParser.parseOrder(config),
         _alphabetize = _ConfigParser.parseAlphabetize(config),
+        _alphabetizeByType = _ConfigParser.parseAlphabetizeByType(config),
         super(
           id: ruleId,
           severity: readSeverity(config, Severity.style),
@@ -55,7 +63,7 @@ class MemberOrderingRule extends CommonRule {
                 withCommentOrMetadata: true,
               ),
               message:
-                  '${info.memberOrder.memberGroup.name} $_warningMessage ${info.memberOrder.previousMemberGroup?.name}.',
+                  '${info.memberOrder.memberGroup} $_warningMessage ${info.memberOrder.previousMemberGroup}.',
             ),
           ),
       if (_alphabetize)
@@ -75,6 +83,19 @@ class MemberOrderingRule extends CommonRule {
                 '${names.currentName} $_warningAlphabeticalMessage ${names.previousName}.',
           );
         }),
+      if (!_alphabetize && _alphabetizeByType)
+        ...membersInfo.where((info) => info.memberOrder.isByTypeWrong).map(
+              (info) => createIssue(
+                rule: this,
+                location: nodeLocation(
+                  node: info.classMember,
+                  source: source,
+                  withCommentOrMetadata: true,
+                ),
+                message:
+                    '${info.memberOrder.memberNames.currentName} $_warningTypeAlphabeticalMessage ${info.memberOrder.memberNames.previousName}.',
+              ),
+            ),
     ];
   }
 }

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/models/annotation.dart renamed to lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/models/annotation.dart

@@ -1,4 +1,4 @@
-part of '../member_ordering_extended_rule.dart';
+part of '../member_ordering_rule.dart';
 
 class _Annotation {
   final String name;

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/models/field_keyword.dart renamed to lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/models/field_keyword.dart

@@ -1,4 +1,4 @@
-part of '../member_ordering_extended_rule.dart';
+part of '../member_ordering_rule.dart';
 
 class _FieldKeyword {
   final String type;

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

@@ -1,4 +1,4 @@
-part of '../member_ordering_extended_rule.dart';
+part of '../member_ordering_rule.dart';
 
 abstract class _MemberGroup {
   final _Annotation annotation;

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

@@ -1,4 +1,4 @@
-part of '../member_ordering_extended_rule.dart';
+part of '../member_ordering_rule.dart';
 
 class _MemberType {
   final String type;

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/models/modifier.dart renamed to lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering/models/modifier.dart

@@ -1,4 +1,4 @@
-part of '../member_ordering_extended_rule.dart';
+part of '../member_ordering_rule.dart';
 
 class _Modifier {
   final String type;