feat: add named parameter

Author: xJac0b

lib/src/lints/avoid_using_api/avoid_using_api_linter.dart

@@ -309,4 +309,70 @@ class AvoidUsingApiLinter {
       reporter.atNode(node, entryCode);
     });
   }
+
+  /// Lints usages of a named parameter from a given source
+  void banUsageWithSpecificNamedParameter(
+    LintCode entryCode,
+    String identifier,
+    String namedParameter,
+    String className,
+    String source,
+  ) {
+    context.registry.addMethodInvocation((node) {
+      final methodName = node.methodName.name;
+      if (methodName != identifier) return;
+
+      final enclosingElement = node.methodName.element?.enclosingElement2;
+      if (enclosingElement == null || enclosingElement.name3 != className) {
+        return;
+      }
+
+      if (!_hasNamedParameter(node.argumentList, namedParameter)) {
+        return;
+      }
+
+      final sourcePath = enclosingElement.library2?.uri.toString() ?? '';
+      if (!_matchesSource(sourcePath, source)) {
+        return;
+      }
+
+      reporter.atNode(node.methodName, entryCode);
+    });
+
+    context.registry.addInstanceCreationExpression((node) {
+      final String? expectedConstructorName;
+      if (identifier == defaultConstructorIdentifier) {
+        expectedConstructorName = null;
+      } else {
+        expectedConstructorName = identifier;
+      }
+
+      final actualClassName = node.constructorName.type.name2.lexeme;
+      if (actualClassName != className) {
+        return;
+      }
+
+      if (node.constructorName.name?.name != expectedConstructorName) {
+        return;
+      }
+
+      if (!_hasNamedParameter(node.argumentList, namedParameter)) {
+        return;
+      }
+
+      final sourcePath =
+          node.constructorName.type.element2?.library2?.uri.toString();
+      if (sourcePath == null || !_matchesSource(sourcePath, source)) {
+        return;
+      }
+
+      reporter.atNode(node, entryCode);
+    });
+  }
+
+  bool _hasNamedParameter(ArgumentList argumentList, String namedParameter) =>
+      argumentList.arguments.any(
+        (arg) =>
+            arg is NamedExpression && arg.name.label.name == namedParameter,
+      );
 }

lib/src/lints/avoid_using_api/avoid_using_api_rule.dart

@@ -126,6 +126,19 @@ class AvoidUsingApiRule extends SolidLintRule<AvoidUsingApiParameters> {
       switch (entry) {
         case AvoidUsingApiEntryParameters(:final source) when source == null:
           break;
+        case AvoidUsingApiEntryParameters(
+            :final identifier?,
+            :final namedParameter?,
+            :final className?,
+            :final source?
+          ):
+          linter.banUsageWithSpecificNamedParameter(
+            entryCode,
+            identifier,
+            namedParameter,
+            className,
+            source,
+          );
         case AvoidUsingApiEntryParameters(
             :final identifier?,
             :final className?,

lib/src/lints/avoid_using_api/models/avoid_using_api_entry_parameters.dart

@@ -7,6 +7,7 @@ import 'package:solid_lints/src/utils/parameter_utils.dart';
 ///
 /// Parameters:
 /// * identifier: Variable/method name
+/// * named_parameter: Named parameter of the constructor/method
 /// * class_name: Name of the class containing the variable/method
 /// * source: Package (e.g., dart:async or package:example)
 /// * severity: The default severity of the lint for each entry.
@@ -35,6 +36,9 @@ class AvoidUsingApiEntryParameters {
   /// Variable/method name
   final String? identifier;
 
+  /// Named parameter of the constrcutor/method
+  final String? namedParameter;
+
   /// Name of the class containing the variable/method
   final String? className;
 
@@ -56,6 +60,7 @@ class AvoidUsingApiEntryParameters {
   /// Constructor for [AvoidUsingApiEntryParameters] model
   const AvoidUsingApiEntryParameters({
     this.identifier,
+    this.namedParameter,
     this.className,
     this.source,
     this.severity,
@@ -70,6 +75,7 @@ class AvoidUsingApiEntryParameters {
   ) =>
       AvoidUsingApiEntryParameters(
         identifier: json['identifier'] as String?,
+        namedParameter: json['named_parameter'] as String?,
         className: json['class_name'] as String?,
         source: json['source'] as String?,
         severity: decodeErrorSeverity(json['severity'] as String?),

lint_test/avoid_using_api/external_source/lib/external_source.dart

@@ -4,27 +4,35 @@
 class BannedCodeUsage {
   final String test4 = 'Hello World';
 
-  BannedCodeUsage();
+  BannedCodeUsage({this.parameter1, this.parameter2});
 
-  factory BannedCodeUsage.test3() {
-    return BannedCodeUsage();
+  String? parameter1;
+  String? parameter2;
+
+  factory BannedCodeUsage.test3({String? parameter1, String? parameter2}) {
+    return BannedCodeUsage(
+      parameter1: parameter1,
+      parameter2: parameter2,
+    );
   }
 
-  void test() {}
+  BannedCodeUsage.test5({String? parameter1, String? parameter2});
+
+  void test({String? parameter1, String? parameter2}) {}
 
-  static String test2() {
+  static String test2({String? parameter1, String? parameter2}) {
     return 'Hello World';
   }
 }
 
 const test2 = 'Hello World';
 
-void test() {}
+void test({String? parameter1}) {}
 
 int banned = 5;
 
 extension BannedExtension on int {
-  int banned() => this + 10;
+  int banned({String? parameter1, String? parameter2}) => this + 10;
 
   int get bannedGetter => 10;
 }

lint_test/avoid_using_api/named_parameter_ban/analysis_options.yaml

@@ -0,0 +1,39 @@
+analyzer:
+  plugins:
+    - ../../custom_lint
+
+custom_lint:
+  rules:
+    - avoid_using_api:
+      severity: warning
+      entries:
+        - identifier: ()
+          named_parameter: parameter1
+          class_name: BannedCodeUsage
+          source: package:external_source
+          reason: "Use parameter2 instead"
+        - identifier: test3
+          named_parameter: parameter1
+          class_name: BannedCodeUsage
+          source: package:external_source
+          reason: "Use parameter2 instead"
+        - identifier: test5
+          named_parameter: parameter1
+          class_name: BannedCodeUsage
+          source: package:external_source
+          reason: "Use parameter2 instead"
+        - identifier: test2
+          named_parameter: parameter1
+          class_name: BannedCodeUsage
+          source: package:external_source
+          reason: "Use parameter2 instead"
+        - identifier: test
+          named_parameter: parameter1
+          class_name: BannedCodeUsage
+          source: package:external_source
+          reason: "Use parameter2 instead"
+        - identifier: banned
+          named_parameter: parameter1
+          class_name: BannedExtension
+          source: package:external_source
+          reason: "Use parameter2 instead"

lint_test/avoid_using_api/named_parameter_ban/lib/named_parameter_ban_test.dart

@@ -0,0 +1,28 @@
+// ignore_for_file: unused_local_variable
+
+import 'package:external_source/external_source.dart';
+
+void testingBannedCodeLint() async {
+  // expect_lint: avoid_using_api
+  final bannedCodeUsage = BannedCodeUsage(parameter1: '');
+
+  // expect_lint: avoid_using_api
+  final test3 = BannedCodeUsage.test3(parameter1: '');
+
+  // expect_lint: avoid_using_api
+  final test5 = BannedCodeUsage.test5(parameter1: '');
+
+  // expect_lint: avoid_using_api
+  BannedCodeUsage.test2(
+    parameter1: 'test',
+  );
+
+  final obj = BannedCodeUsage();
+  // expect_lint: avoid_using_api
+  obj.test(parameter1: '');
+
+  test(parameter1: '');
+
+  // expect_lint: avoid_using_api
+  2.banned(parameter1: '');
+}

lint_test/avoid_using_api/named_parameter_ban/pubspec.yaml

@@ -0,0 +1,17 @@
+name: identifier_class_source_ban
+description: A sample command-line application.
+version: 1.0.0
+publish_to: none
+
+environment:
+  sdk: ^3.1.3
+
+dependencies:
+  external_source:
+    path: ../external_source
+
+dev_dependencies:
+  lints: ^3.0.0
+  test: ^1.21.0
+  solid_lints:
+    path: ../../../