pkg/linter/lib/src/rules/avoid_print.dart

// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'package:analyzer/analysis_rule/analysis_rule.dart';
import 'package:analyzer/analysis_rule/rule_context.dart';
import 'package:analyzer/analysis_rule/rule_visitor_registry.dart';
import 'package:analyzer/dart/ast/ast.dart';
import 'package:analyzer/dart/ast/visitor.dart';
import 'package:analyzer/error/error.dart';
import 'package:analyzer/src/utilities/extensions/ast.dart'; // ignore: implementation_imports

import '../analyzer.dart';
import '../diagnostic.dart' as diag;
import '../extensions.dart';
import '../util/flutter_utils.dart';

const _desc = r'Avoid `print` calls in production code.';

class AvoidPrint extends AnalysisRule {
  new() : super(name: LintNames.avoid_print, description: _desc);

  @override
  DiagnosticCode get diagnosticCode => diag.avoidPrint;

  @override
  void registerNodeProcessors(
    RuleVisitorRegistry registry,
    RuleContext context,
  ) {
    var visitor = _Visitor(this);
    registry.addMethodInvocation(this, visitor);
  }
}

class _Visitor(final AnalysisRule rule) extends SimpleAstVisitor<void> {
  @override
  void visitMethodInvocation(MethodInvocation node) {
    if ((node.methodName.element?.isDartCorePrint ?? false) &&
        !node.inCommentReference &&
        !_isDebugOnly(node)) {
      rule.reportAtNode(node.methodName);
    }

    for (var argument in node.argumentList.arguments) {
      if (argument is Expression) {
        _validateArgument(argument);
      }
    }
  }

  bool _isDebugOnly(Expression expression) {
    AstNode? node = expression;
    while (node != null) {
      var parent = node.parent;
      if (parent is IfStatement && node == parent.thenStatement) {
        var condition = parent.expression;
        if (condition is SimpleIdentifier && condition.element.isKDebugMode) {
          return true;
        }
      } else if (parent is FunctionBody) {
        return false;
      }
      node = parent;
    }
    return false;
  }

  void _validateArgument(Expression expression) {
    if (expression.inCommentReference) return;
    if (expression is SimpleIdentifier) {
      var element = expression.element;
      if (element.isDartCorePrint) {
        rule.reportAtNode(expression);
      }
    }
  }
}