change default named parameters ordering in rule config and test

extract models from visitor into their separate files
rename some ParameterType enums to avoid using dart keywords
add ParameterType.fromType
remove unnecessary base class from documentation text
perf(rule): make visitor a class member to avoid recreating new instance
update test with new default ordering

Author: Andrew-Bekhiet

lib/src/lints/named_parameters_ordering/config_parser.dart

@@ -21,14 +21,13 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-import 'package:collection/collection.dart';
 import 'package:solid_lints/src/lints/named_parameters_ordering/models/parameter_type.dart';
 
 /// Helper class to parse member_ordering rule config
 class NamedParametersConfigParser {
   static const _defaultOrderList = [
-    'super',
     'required_super',
+    'super',
     'required',
     'nullable',
     'default',
@@ -40,12 +39,6 @@ class NamedParametersConfigParser {
         ? List<String>.from(orderConfig)
         : _defaultOrderList;
 
-    return order
-        .map(
-          (type) =>
-              ParameterType.values.firstWhereOrNull((o) => o.type == type),
-        )
-        .nonNulls
-        .toList();
+    return order.map(ParameterType.fromType).nonNulls.toList();
   }
 }

lib/src/lints/named_parameters_ordering/models/parameter_info.dart

@@ -0,0 +1,17 @@
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:solid_lints/src/lints/named_parameters_ordering/models/parameter_ordering_info.dart';
+
+/// Data class that holds AST function parameter and it's order info
+class ParameterInfo {
+  /// AST instance of an [FormalParameter]
+  final FormalParameter formalParameter;
+
+  /// Function parameter order info
+  final ParameterOrderingInfo parameterOrderingInfo;
+
+  /// Creates instance of an [ParameterInfo]
+  const ParameterInfo({
+    required this.formalParameter,
+    required this.parameterOrderingInfo,
+  });
+}

lib/src/lints/named_parameters_ordering/models/parameter_ordering_info.dart

@@ -0,0 +1,20 @@
+import 'package:solid_lints/src/lints/named_parameters_ordering/models/parameter_type.dart';
+
+/// Data class holds information about parameter order info
+class ParameterOrderingInfo {
+  /// Indicates if order is wrong
+  final bool isWrong;
+
+  /// Info about current parameter parameter type
+  final ParameterType parameterType;
+
+  /// Info about previous parameter parameter type
+  final ParameterType? previousParameterType;
+
+  /// Creates instance of [ParameterOrderingInfo]
+  const ParameterOrderingInfo({
+    required this.isWrong,
+    required this.parameterType,
+    required this.previousParameterType,
+  });
+}

lib/src/lints/named_parameters_ordering/models/parameter_type.dart

@@ -1,19 +1,26 @@
+import 'package:collection/collection.dart';
+
 /// Represents a function parameter type
 enum ParameterType {
-  /// Super parameter type (super.parameterName)
-  super$('super'),
+  /// Inherited (super) parameter type (super.parameterName)
+  inherited('super'),
 
-  /// Required super parameter type (required super.parameterName)
-  requiredSuper('required_super'),
+  /// Required inherited (super) parameter type (required super.parameterName)
+  requiredInherited('required_super'),
 
   /// Required parameter type (required String parameterName)
   required('required'),
 
   /// Nullable parameter type (String? parameterName)
   nullable('nullable'),
 
-  /// Default parameter type (String parameterName = 'defaultValue')
-  default$('default');
+  /// Default value parameter type (String parameterName = 'defaultValue')
+  defaultValue('default');
+
+  /// Returns [ParameterType] from type or null if not found
+  static ParameterType? fromType(String type) {
+    return values.firstWhereOrNull((o) => o.type == type);
+  }
 
   /// String representation of the parameter type
   final String type;

lib/src/lints/named_parameters_ordering/named_parameters_ordering_rule.dart

@@ -1,6 +1,7 @@
 import 'package:analyzer/error/listener.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:solid_lints/src/lints/named_parameters_ordering/models/named_parameters_ordering_parameters.dart';
+import 'package:solid_lints/src/lints/named_parameters_ordering/models/parameter_ordering_info.dart';
 import 'package:solid_lints/src/lints/named_parameters_ordering/visitors/named_parameters_ordering_visitor.dart';
 import 'package:solid_lints/src/models/rule_config.dart';
 import 'package:solid_lints/src/models/solid_lint_rule.dart';
@@ -41,16 +42,6 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// #### BAD:
 ///
 /// ```dart
-/// class User {
-///   final String accountType;
-///   final String? userId;
-///
-///   User({
-///     required this.accountType,
-///     this.userId,
-///   });
-/// }
-///
 /// class UserProfile extends User {
 ///   final String? age;
 ///   final String? country;
@@ -82,16 +73,6 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// #### GOOD:
 ///
 /// ```dart
-/// class User {
-///   final String accountType;
-///   final String? userId;
-///
-///   User({
-///     required this.accountType,
-///     this.userId,
-///   });
-/// }
-///
 /// class UserProfile extends User {
 ///   final String? age;
 ///   final String? country;
@@ -121,11 +102,10 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// ```
 class NamedParametersOrderingRule
     extends SolidLintRule<NamedParametersOrderingParameters> {
-  /// This lint rule represents
-  /// the error whether we use bad formatted double literals.
+  /// The name of this lint rule.
   static const lintName = 'named_parameters_ordering';
 
-  static const _warningMessage = 'should be before';
+  late final _visitor = NamedParametersOrderingVisitor(config.parameters.order);
 
   NamedParametersOrderingRule._(super.config);
 
@@ -149,9 +129,7 @@ class NamedParametersOrderingRule
     CustomLintContext context,
   ) {
     context.registry.addFormalParameterList((node) {
-      final visitor = NamedParametersOrderingVisitor(config.parameters.order);
-
-      final parametersInfo = visitor.visitFormalParameterList(node);
+      final parametersInfo = _visitor.visitFormalParameterList(node);
 
       final wrongOrderParameters = parametersInfo.where(
         (info) => info.parameterOrderingInfo.isWrong,
@@ -173,7 +151,7 @@ class NamedParametersOrderingRule
     return LintCode(
       name: lintName,
       problemMessage: "${parameterOrdering.displayName} named parameters"
-          " $_warningMessage "
+          " should be before "
           "${previousParameterOrdering!.displayName} named parameters.",
     );
   }

lib/src/lints/named_parameters_ordering/visitors/named_parameters_ordering_visitor.dart

@@ -23,6 +23,8 @@
 
 import 'package:analyzer/dart/ast/ast.dart' hide Annotation;
 import 'package:analyzer/dart/ast/visitor.dart';
+import 'package:solid_lints/src/lints/named_parameters_ordering/models/parameter_info.dart';
+import 'package:solid_lints/src/lints/named_parameters_ordering/models/parameter_ordering_info.dart';
 import 'package:solid_lints/src/lints/named_parameters_ordering/models/parameter_type.dart';
 
 /// AST Visitor which finds all methods, functions and constructor named
@@ -88,11 +90,13 @@ class NamedParametersOrderingVisitor
 
     switch (parameter) {
       case SuperFormalParameter(:final isRequired):
-        return isRequired ? ParameterType.requiredSuper : ParameterType.super$;
+        return isRequired
+            ? ParameterType.requiredInherited
+            : ParameterType.inherited;
 
       case DefaultFormalParameter():
       case _ when hasDefaultValue:
-        return ParameterType.default$;
+        return ParameterType.defaultValue;
 
       case FieldFormalParameter(:final isRequired) ||
             FunctionTypedFormalParameter(:final isRequired) ||
@@ -110,37 +114,3 @@ class NamedParametersOrderingVisitor
             _parametersOrder.indexOf(currentParameterType);
   }
 }
-
-/// Data class that holds AST function parameter and it's order info
-class ParameterInfo {
-  /// AST instance of an [FormalParameter]
-  final FormalParameter formalParameter;
-
-  /// Function parameter order info
-  final ParameterOrderingInfo parameterOrderingInfo;
-
-  /// Creates instance of an [ParameterInfo]
-  const ParameterInfo({
-    required this.formalParameter,
-    required this.parameterOrderingInfo,
-  });
-}
-
-/// Data class holds information about parameter order info
-class ParameterOrderingInfo {
-  /// Indicates if order is wrong
-  final bool isWrong;
-
-  /// Info about current parameter parameter type
-  final ParameterType parameterType;
-
-  /// Info about previous parameter parameter type
-  final ParameterType? previousParameterType;
-
-  /// Creates instance of [ParameterOrderingInfo]
-  const ParameterOrderingInfo({
-    required this.isWrong,
-    required this.parameterType,
-    required this.previousParameterType,
-  });
-}

lint_test/analysis_options.yaml

@@ -84,8 +84,8 @@ custom_lint:
     - avoid_final_with_getter
     - named_parameters_ordering:
       order:
-        - required
         - required_super
-        - default
-        - nullable
         - super
+        - required
+        - nullable
+        - default

lint_test/named_parameters_ordering_test.dart

@@ -1,4 +1,4 @@
-// ignore_for_file: unused_field, prefer_match_file_name, proper_super_calls, number_of_parameters
+// ignore_for_file: unused_field, prefer_match_file_name, proper_super_calls, number_of_parameters, avoid_unused_parameters, member_ordering
 // ignore_for_file: unused_element
 // ignore_for_file: no_empty_block
 
@@ -21,84 +21,113 @@ class UserProfile extends User {
   final String email;
   final bool isActive;
   final String name;
+  final String? profileId;
 
   // no lint
-  UserProfile.orderedConstructor({
+  UserProfile.orderedConstructor(
+    this.profileId, {
+    required super.accountType,
+    super.userId,
     required this.name,
     required this.email,
-    required super.accountType,
-    this.isActive = true,
     this.age,
     this.country,
-    super.userId,
+    this.isActive = true,
   });
 
-  UserProfile.partiallyOrderedConstructor({
+  UserProfile.partiallyOrderedConstructor(
+    this.profileId, {
     required super.accountType,
-    // expect_lint: named_parameters_ordering
     required this.email,
     this.age,
     // expect_lint: named_parameters_ordering
     required this.name,
     this.country,
     // expect_lint: named_parameters_ordering
-    this.isActive = true,
     super.userId,
+    this.isActive = true,
   });
 
-  UserProfile.unorderedConstructor({
+  UserProfile.unorderedConstructor(
+    String profileId, {
     this.age,
     // expect_lint: named_parameters_ordering
-    required super.accountType,
-    // expect_lint: named_parameters_ordering
-    required this.name,
     super.userId,
     // expect_lint: named_parameters_ordering
+    required super.accountType,
     this.country,
     // expect_lint: named_parameters_ordering
+    required this.name,
     this.isActive = true,
     // expect_lint: named_parameters_ordering
     required this.email,
-  });
+  }) : profileId = profileId;
 
+  // no lint
   void orderedMethod({
     required String name,
     required String email,
-    bool isActive = true,
     int? age,
+    bool isActive = true,
   }) {
     return;
   }
 
   void partiallyOrderedMethod({
     required String name,
-    required String email,
     int? age,
     // expect_lint: named_parameters_ordering
+    required String email,
     bool isActive = true,
   }) {
     return;
   }
 
   void unorderedMethod({
-    required String name,
     int? age,
     // expect_lint: named_parameters_ordering
+    required String email,
     bool isActive = true,
     // expect_lint: named_parameters_ordering
+    required String name,
+  }) {
+    return;
+  }
+
+  void mixedParameters(
+    String accountType,
+    String? userId, {
+    int? age,
+    // expect_lint: named_parameters_ordering
     required String email,
+    bool isActive = true,
+    // expect_lint: named_parameters_ordering
+    required String name,
   }) {
     return;
   }
 }
 
 void functionExample({
   required String name,
+  bool isActive = true,
+  // expect_lint: named_parameters_ordering
   int? age,
   // expect_lint: named_parameters_ordering
-  bool isActive = true,
+  required String email,
+}) {
+  return;
+}
+
+void mixedParameters(
+  String accountType,
+  String? userId, {
+  int? age,
   // expect_lint: named_parameters_ordering
   required String email,
+  bool isActive = true,
+  // expect_lint: named_parameters_ordering
+  required String name,
 }) {
   return;
 }