clippy_lints/src/methods/str_split.rs

use clippy_utils::diagnostics::span_lint_and_then;
use clippy_utils::sym;
use clippy_utils::visitors::is_const_evaluatable;
use rustc_ast::ast::LitKind;
use rustc_errors::Applicability;
use rustc_hir::{Expr, ExprKind};
use rustc_lint::LateContext;
use rustc_span::Span;

use super::STR_SPLIT_AT_NEWLINE;

pub(super) fn check<'a>(
    cx: &LateContext<'a>,
    expr: &'_ Expr<'_>,
    split_recv: &'a Expr<'_>,
    split_span: Span,
    split_arg: &'_ Expr<'_>,
) {
    // We're looking for `A.trim().split(B)`, where the adjusted type of `A` is `&str` (e.g. an
    // expression returning `String`), and `B` is a `Pattern` that hard-codes a newline (either `"\n"`
    // or `"\r\n"`). There are a lot of ways to specify a pattern, and this lint only checks the most
    // basic ones: a `'\n'`, `"\n"`, and `"\r\n"`.
    if let ExprKind::MethodCall(trim_method_name, trim_recv, [], trim_span) = split_recv.kind
        && trim_method_name.ident.name == sym::trim
        && let typeck = cx.typeck_results()
        && typeck.expr_ty_adjusted(trim_recv).peel_refs().is_str()
        && !is_const_evaluatable(cx.tcx, typeck, trim_recv)
        && let ExprKind::Lit(split_lit) = split_arg.kind
        && matches!(
            split_lit.node,
            LitKind::Char('\n') | LitKind::Str(sym::LF | sym::CRLF, _)
        )
    {
        span_lint_and_then(
            cx,
            STR_SPLIT_AT_NEWLINE,
            expr.span,
            "using `str.trim().split()` with hard-coded newlines",
            |diag| {
                diag.span_suggestion_verbose(
                    trim_span.to(split_span), // combine the call spans of the two methods
                    "use `str.lines()` instead",
                    "lines()",
                    Applicability::MaybeIncorrect,
                );
            },
        );
    }
}