feat: add method call chains support on ban-name ident (#1034)

* Added breadcrumb on ban-name's visitor
- Added tests
- Changed docs

* Fixed visitor breadcrumb build logic

* Added more tests

* Updated docs

* Updated issue matches

Author: Hideart

lib/src/analyzers/lint_analyzer/rules/rules_list/ban_name/ban_name_rule.dart

@@ -42,11 +42,32 @@ class BanNameRule extends CommonRule {
 
     source.unit.visitChildren(visitor);
 
-    return visitor.nodes
+    final filteredNodeList = visitor.nodes.where((node) {
+      if (node.endNode != null) {
+        final inlineNode = source.content
+            .substring(
+              node.node.offset,
+              node.endNode!.end,
+            )
+            .replaceAll('\n', '');
+
+        if (!inlineNode.contains(node.fullName)) {
+          return false;
+        }
+      }
+
+      return true;
+    });
+
+    return filteredNodeList
         .map(
           (node) => createIssue(
             rule: this,
-            location: nodeLocation(node: node.node, source: source),
+            location: nodeLocation(
+              node: node.node,
+              source: source,
+              endNode: node.endNode,
+            ),
             message: node.message,
           ),
         )

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

@@ -3,9 +3,11 @@ part of 'ban_name_rule.dart';
 class _Visitor extends GeneralizingAstVisitor<void> {
   final Map<String, _BanNameConfigEntry> _entryMap;
 
-  final _nodes = <_NodeWithMessage>[];
+  final _nodes = <_NodeInfo>[];
 
-  Iterable<_NodeWithMessage> get nodes => _nodes;
+  Iterable<_NodeInfo> get nodes => _nodes;
+
+  final _nodeBreadcrumb = <String, AstNode>{};
 
   _Visitor(List<_BanNameConfigEntry> entries)
       : _entryMap = Map.fromEntries(entries.map((e) => MapEntry(e.ident, e)));
@@ -39,18 +41,51 @@ class _Visitor extends GeneralizingAstVisitor<void> {
   }
 
   void _visitIdent(AstNode node, String name) {
+    final prevNode =
+        _nodeBreadcrumb.isNotEmpty ? _nodeBreadcrumb.values.last : null;
+    if (node.offset - 1 == prevNode?.end) {
+      _nodeBreadcrumb.addAll({name: node});
+    } else {
+      _nodeBreadcrumb.clear();
+    }
+
+    if (_nodeBreadcrumb.isEmpty) {
+      _nodeBreadcrumb.addAll({name: node});
+    }
+
     if (_entryMap.containsKey(name)) {
-      _nodes.add(_NodeWithMessage(
+      _nodes.add(_NodeInfo(
         node,
-        '${_entryMap[name]!.description} ($name is banned)',
+        fullName: name,
+        message: '${_entryMap[name]!.description} ($name is banned)',
+      ));
+
+      return;
+    }
+
+    final breadcrumbString = _nodeBreadcrumb.keys.join('.');
+    if (_entryMap.containsKey(breadcrumbString)) {
+      _nodes.add(_NodeInfo(
+        _nodeBreadcrumb.values.first,
+        fullName: breadcrumbString,
+        message:
+            '${_entryMap[breadcrumbString]!.description} ($breadcrumbString is banned)',
+        endNode: _nodeBreadcrumb.values.last,
       ));
     }
   }
 }
 
-class _NodeWithMessage {
+class _NodeInfo {
   final AstNode node;
+  final String fullName;
   final String message;
+  final AstNode? endNode;
 
-  _NodeWithMessage(this.node, this.message);
+  _NodeInfo(
+    this.node, {
+    required this.fullName,
+    required this.message,
+    this.endNode,
+  });
 }

test/src/analyzers/lint_analyzer/rules/rules_list/ban_name/ban_name_rule_test.dart

@@ -27,13 +27,21 @@ void main() {
           {'ident': 'showDialog', 'description': 'Please use myShowDialog'},
           {'ident': 'strangeName', 'description': 'The name is too strange'},
           {'ident': 'AnotherStrangeName', 'description': 'Oops'},
+          {
+            'ident': 'StrangeClass.someMethod',
+            'description': 'Please use NonStrangeClass.someMethod instead',
+          },
+          {
+            'ident': 'DateTime.now',
+            'description': 'Please use clock.now instead',
+          },
         ],
       }).check(unit);
 
       RuleTestHelper.verifyIssues(
         issues: issues,
-        startLines: [6, 7, 9, 12, 15, 16],
-        startColumns: [3, 12, 7, 1, 1, 12],
+        startLines: [7, 8, 10, 13, 16, 17, 20, 23, 24, 26],
+        startColumns: [3, 12, 7, 1, 1, 12, 1, 1, 1, 28],
         locationTexts: [
           'showDialog',
           'showDialog',
@@ -43,6 +51,10 @@ void main() {
               '  late var strangeName; // LINT\n'
               '}',
           'strangeName',
+          'StrangeClass.someMethod();',
+          'DateTime.now();',
+          'DateTime.now()',
+          'DateTime.now',
         ],
         messages: [
           'Please use myShowDialog (showDialog is banned)',
@@ -51,6 +63,10 @@ void main() {
           'The name is too strange (strangeName is banned)',
           'Oops (AnotherStrangeName is banned)',
           'The name is too strange (strangeName is banned)',
+          'Please use NonStrangeClass.someMethod instead (StrangeClass.someMethod is banned)',
+          'Please use clock.now instead (DateTime.now is banned)',
+          'Please use clock.now instead (DateTime.now is banned)',
+          'Please use clock.now instead (DateTime.now is banned)',
         ],
       );
     });

test/src/analyzers/lint_analyzer/rules/rules_list/ban_name/examples/classes.dart

@@ -0,0 +1,7 @@
+class StrangeClass {
+  void someMethod();
+}
+
+class NonStrangeClass {
+  void someMethod();
+}

test/src/analyzers/lint_analyzer/rules/rules_list/ban_name/examples/example.dart

@@ -1,5 +1,6 @@
 import 'dialog.dart';
 import 'dialog.dart' as material;
+import 'classes.dart';
 
 void func() {
   myShowDialog('some_arguments', 'another_argument');
@@ -15,3 +16,13 @@ void strangeName() {} // LINT
 class AnotherStrangeName {
   late var strangeName; // LINT
 }
+
+StrangeClass.someMethod(); // LINT
+NonStrangeClass.someMethod();
+
+DateTime.now(); // LINT
+DateTime.now().day; // LINT
+class DateTimeTest {
+  final currentTimestamp = DateTime.now(); // LINT
+}
+DateTime now = DateTime(2022);

website/docs/rules/common/ban-name.mdx

@@ -9,6 +9,7 @@ Example: When you add some extra functionalities to built-in Flutter functions (
 :::caution
 
 When trying to ban some methods in your package, it also triggers on imported from an external package code.
+But you can specify the name to ban (ex: 'DateTime.now' instead of 'now').
 
 :::
 
@@ -30,12 +31,28 @@ void strangeName() {} // LINT
 class AnotherStrangeName {
   late var strangeName; // LINT
 }
+
+StrangeClass.someMethod(); // LINT
+NonStrangeClass.someMethod();
+
+DateTime.now(); // LINT
+DateTime.now().day; // LINT
+class DateTimeTest {
+  final currentTimestamp = DateTime.now(); // LINT
+}
+DateTime currentTimestamp = DateTime('01.01.1959');
 ```
 
 **✅ Good:**
 
 ```dart
 myShowDialog();
+NonStrangeClass.someMethod();
+clock.now();
+clock.now().day;
+class DateTimeTest {
+  final currentTimestamp = clock.now();
+}
 ```
 
 ### ⚙️ Config example {#config-example}
@@ -53,4 +70,8 @@ dart_code_metrics:
           description: The name is too strange
         - ident: AnotherStrangeName
           description: Oops
+        - ident: StrangeClass.someMethod
+          description: Please use a NonStrangeClass.someMethod instead
+        - ident: DateTime.now
+          description: Please use a clock.now instead
 ```