rust-lang/rust-clippy

`use_debug` lint should not trigger on `debug!()` log macro calls

Open

#2.132 geöffnet am 12. Okt. 2017

Auf GitHub ansehen
 (7 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Rust (1.391 Forks)batch import
C-enhancementT-middlegood first issue

Repository-Metriken

Stars
 (10.406 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 19T 22h) (113 gemergte PRs in 30 T)

Beschreibung

Example use-case:

#![cfg_attr(feature = "cargo-clippy", warn(use_debug))]

#[macro_use]
extern crate log;

pub fn euclid_steps(mut x: u64, mut y: u64) -> Vec<u64> {
    debug!("x = {}, y = {}", x, y);

    let mut steps = vec![];

    loop {
        let tmp = x % y;

        if tmp == 0 {
            debug!("Steps performed in Euclidean algorithm: {:?}", steps);
            return steps;
        }

        steps.push(tmp);
        x = y;
        y = tmp;
    }
}

Placing #![cfg_attr(feature = "cargo-clippy", allow(use_debug))] before each debug!() usage seems tedious to me when there are several dozens of them; and turning it off (even if locally) defeats the purpose of the lint.

Contributor Guide

Research-Richtung
Untersuche die Implementierung des `use debug` Lints in der Clippy Codebasis (wahrscheinlich in `clippy lints/src/use debug.rs`). Verstehe, wie es derzeit bei `debug!()` Aufrufen ausgelöst wird. Erwäge, eine Ausnahme für das `debug!` Makro aus der `log` Crate hinzuzufügen, möglicherweise durch Überprüfung des Makro Pfads oder die Verwendung einer Whitelist. Überprüfe die bestehende Diskussion in den Issue Kommentaren auf vorgeschlagene Lösungen.
Tech Stack
rust
Domain
tooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65