sufftea · May 2, 2024 · Apr 29, 2024 · Apr 29, 2024 · Apr 29, 2024 · Apr 29, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,8 @@
 - Add a rule prefer_guard_clause for reversing nested if statements (https://github.com/solid-software/solid_lints/issues/91)
 - add exclude params support to avoid_returning_widgets rule (https://github.com/solid-software/solid_lints/issues/131)
 - add quick fix to avoid_final_with_getter (https://github.com/solid-software/solid_lints/pull/164)
-
+- Renamed `avoid_debug_print` to `avoid_debug_print_in_release`
+- Now, `avoid_debug_print_in_release` doesn't trigger if the `debugPrint` call is wrapped in a `!kReleaseMode` check.
 
 ## 0.1.5
 

diff --git a/example/analysis_options.yaml b/example/analysis_options.yaml
@@ -19,7 +19,7 @@ custom_lint:
     - avoid_unnecessary_setstate
     - double_literal_format
     - avoid_unnecessary_type_assertions
-    - avoid_debug_print
+    - avoid_debug_print_in_release
     - avoid_using_api:
       severity: info
       entries:

diff --git a/lib/analysis_options.yaml b/lib/analysis_options.yaml
@@ -50,7 +50,7 @@ custom_lint:
     - avoid_unnecessary_type_casts
     - avoid_unrelated_type_assertions
     - avoid_unused_parameters
-    - avoid_debug_print
+    - avoid_debug_print_in_release
     - avoid_final_with_getter
 
     - cyclomatic_complexity:

diff --git a/lib/solid_lints.dart b/lib/solid_lints.dart
@@ -1,7 +1,7 @@
 library solid_metrics;
 
 import 'package:custom_lint_builder/custom_lint_builder.dart';
-import 'package:solid_lints/src/lints/avoid_debug_print/avoid_debug_print_rule.dart';
+import 'package:solid_lints/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart';
 import 'package:solid_lints/src/lints/avoid_final_with_getter/avoid_final_with_getter_rule.dart';
 import 'package:solid_lints/src/lints/avoid_global_state/avoid_global_state_rule.dart';
 import 'package:solid_lints/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart';
@@ -62,7 +62,7 @@ class _SolidLints extends PluginBase {
       PreferLastRule.createRule(configs),
       PreferMatchFileNameRule.createRule(configs),
       ProperSuperCallsRule.createRule(configs),
-      AvoidDebugPrint.createRule(configs),
+      AvoidDebugPrintInReleaseRule.createRule(configs),
       PreferEarlyReturnRule.createRule(configs),
       AvoidFinalWithGetterRule.createRule(configs),
     ];

diff --git a/lib/src/lints/avoid_debug_print/models/avoid_debug_print_func_model.dart b/lib/src/lints/avoid_debug_print/models/avoid_debug_print_func_model.dart
diff --git a/...d_debug_print/avoid_debug_print_rule.dart → ...se/avoid_debug_print_in_release_rule.dart b/...d_debug_print/avoid_debug_print_rule.dart → ...se/avoid_debug_print_in_release_rule.dart
@@ -1,13 +1,13 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/syntactic_entity.dart';
+import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
-import 'package:solid_lints/src/lints/avoid_debug_print/models/avoid_debug_print_func_model.dart';
 import 'package:solid_lints/src/models/rule_config.dart';
 import 'package:solid_lints/src/models/solid_lint_rule.dart';
 
 /// A `avoid_debug_print` rule which forbids calling or referencing
-/// debugPrint function from flutter/foundation.
+/// debugPrint function in release mode.
 ///
 /// See more here: https://github.com/flutter/flutter/issues/147141
 ///
@@ -25,29 +25,35 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// #### GOOD:
 ///
 /// ```dart
-/// if (kDebugMode) {
+/// if (!kReleaseMode) {
 ///   debugPrint('');
 /// }
 /// ```
 ///
 ///
-class AvoidDebugPrint extends SolidLintRule {
+class AvoidDebugPrintInReleaseRule extends SolidLintRule {
   /// The [LintCode] of this lint rule that represents
   /// the error when debugPrint is called
-  static const lintName = 'avoid_debug_print';
+  static const lintName = 'avoid_debug_print_in_release';
 
-  AvoidDebugPrint._(super.config);
+  static const String _kReleaseModePath =
+      'package:flutter/src/foundation/constants.dart';
+  static const String _kReleaseModeName = 'kReleaseMode';
+  static const _debugPrintPath = 'package:flutter/src/foundation/print.dart';
+  static const _debugPrintName = 'debugPrint';
 
-  /// Creates a new instance of [AvoidDebugPrint]
+  AvoidDebugPrintInReleaseRule._(super.config);
+
+  /// Creates a new instance of [AvoidDebugPrintInReleaseRule]
   /// based on the lint configuration.
-  factory AvoidDebugPrint.createRule(CustomLintConfigs configs) {
+  factory AvoidDebugPrintInReleaseRule.createRule(CustomLintConfigs configs) {
     final rule = RuleConfig(
       configs: configs,
       name: lintName,
-      problemMessage: (_) => "Avoid using 'debugPrint'",
+      problemMessage: (_) => "Avoid using 'debugPrint' in release mode",
     );
 
-    return AvoidDebugPrint._(rule);
+    return AvoidDebugPrintInReleaseRule._(rule);
   }
 
   @override
@@ -62,6 +68,7 @@ class AvoidDebugPrint extends SolidLintRule {
         if (func is! Identifier) {
           return;
         }
+
         _checkIdentifier(
           identifier: func,
           node: node,
@@ -95,11 +102,25 @@ class AvoidDebugPrint extends SolidLintRule {
     required AstNode node,
     required ErrorReporter reporter,
   }) {
-    final funcModel = AvoidDebugPrintFuncModel.parseExpression(identifier);
+    if (!_isDebugPrintNode(identifier)) {
+      return;
+    }
+
+    final debugCheck = node.thisOrAncestorMatching(
+      (node) {
+        if (node is IfStatement) {
+          return _isNotReleaseCheck(node.expression);
+        }
 
-    if (funcModel.hasSameName && funcModel.hasTheSameSource) {
-      reporter.reportErrorForNode(code, node);
+        return false;
+      },
+    );
+
+    if (debugCheck != null) {
+      return;
     }
+
+    reporter.reportErrorForNode(code, node);
   }
 
   /// Returns null if doesn't have right operand
@@ -128,4 +149,57 @@ class AvoidDebugPrint extends SolidLintRule {
       reporter: reporter,
     );
   }
+
+  bool _isDebugPrintNode(Identifier node) {
+    final String name;
+    final String sourcePath;
+    switch (node) {
+      case PrefixedIdentifier():
+        final prefix = node.prefix.name;
+        name = node.name.replaceAll('$prefix.', '');
+        sourcePath = node.staticElement?.librarySource?.uri.toString() ?? '';
+
+      case SimpleIdentifier():
+        name = node.name;
+        sourcePath = node.staticElement?.librarySource?.uri.toString() ?? '';
+
+      default:
+        return false;
+    }
+
+    return name == _debugPrintName && sourcePath == _debugPrintPath;
+  }
+
+  bool _isNotReleaseCheck(Expression node) {
+    if (node.childEntities.toList()
+        case [
+          final Token token,
+          final Identifier identifier,
+        ]) {
+      return token.type == TokenType.BANG &&
+          _isReleaseModeIdentifier(identifier);
+    }
+
+    return false;
+  }
+
+  bool _isReleaseModeIdentifier(Identifier node) {
+    final String name;
+    final String sourcePath;
+
+    switch (node) {
+      case PrefixedIdentifier():
+        final prefix = node.prefix.name;
+
+        name = node.name.replaceAll('$prefix.', '');
+        sourcePath = node.staticElement?.librarySource?.uri.toString() ?? '';
+      case SimpleIdentifier():
+        name = node.name;
+        sourcePath = node.staticElement?.librarySource?.uri.toString() ?? '';
+      default:
+        return false;
+    }
+
+    return name == _kReleaseModeName && sourcePath == _kReleaseModePath;
+  }
 }
diff --git a/lint_test/analysis_options.yaml b/lint_test/analysis_options.yaml
@@ -24,7 +24,7 @@ custom_lint:
     - newline_before_return
     - no_empty_block
     - no_equal_then_else
-    - avoid_debug_print
+    - avoid_debug_print_in_release
     - prefer_early_return
     - member_ordering:
       alphabetize: true

diff --git a/lint_test/avoid_debug_print_in_release_test/avoid_debug_print_in_release_prefix_test.dart b/lint_test/avoid_debug_print_in_release_test/avoid_debug_print_in_release_prefix_test.dart
@@ -0,0 +1,53 @@
+// ignore_for_file: unused_local_variable
+
+import 'package:flutter/foundation.dart' as f;
+
+/// Test the avoid_debug_print_in_release
+void avoidDebugPrintTest() {
+  // expect_lint: avoid_debug_print_in_release
+  f.debugPrint('');
+
+  // expect_lint: avoid_debug_print_in_release
+  final test = f.debugPrint;
+
+  test('test');
+
+  // expect_lint: avoid_debug_print_in_release
+  final test2 = f.debugPrint('');
+
+  debugPrint();
+
+  debugPrint;
+
+  if (!f.kReleaseMode) {
+    f.debugPrint('');
+
+    final test = f.debugPrint;
+
+    var test2;
+
+    test2 = debugPrint;
+
+    test.call('test');
+
+    final test3 = f.debugPrint('');
+
+    if (true) {
+      f.debugPrint('');
+
+      final test = f.debugPrint;
+
+      var test2;
+
+      test2 = debugPrint;
+
+      test.call('test');
+
+      final test3 = f.debugPrint('');
+    }
+  }
+}
+
+void debugPrint() {
+  return;
+}
diff --git a/lint_test/avoid_debug_print_in_release_test/avoid_debug_print_in_release_test.dart b/lint_test/avoid_debug_print_in_release_test/avoid_debug_print_in_release_test.dart
@@ -0,0 +1,58 @@
+// ignore_for_file: unused_local_variable
+
+import 'package:flutter/foundation.dart';
+
+/// Test the avoid_debug_print_in_release
+void avoidDebugPrintTest() {
+  // expect_lint: avoid_debug_print_in_release
+  debugPrint('');
+
+  // expect_lint: avoid_debug_print_in_release
+  final test = debugPrint;
+
+  var test2;
+
+  // expect_lint: avoid_debug_print_in_release
+  test2 = debugPrint;
+
+  test.call('test');
+
+  // expect_lint: avoid_debug_print_in_release
+  final test3 = debugPrint('');
+
+  someOtherFunction();
+
+  if (!kReleaseMode) {
+    debugPrint('');
+
+    final test = debugPrint;
+
+    var test2;
+
+    test2 = debugPrint;
+
+    test.call('test');
+
+    final test3 = debugPrint('');
+
+    someOtherFunction();
+
+    if (true) {
+      debugPrint('');
+
+      final test = debugPrint;
+
+      var test2;
+
+      test2 = debugPrint;
+
+      test.call('test');
+
+      final test3 = debugPrint('');
+    }
+  }
+}
+
+void someOtherFunction() {
+  print('iii');
+}