Skip to main content
1//! Load only workspace-owned source files and validate diagnostic coordinates.2use crate::diagnostic::model::*; warning: clippy::wildcard_imports3use std::{collections::BTreeMap, path::PathBuf};4#[derive(Debug)]5pub struct SourceFile {6    pub display_path: String,7    pub text: Option<String>,8    pub reason: Option<String>,9}10pub fn all_spans(f: &Finding) -> Vec<&Span> {11    fn notes<'a>(n: &'a Note, out: &mut Vec<&'a Span>) {12        out.extend(&n.spans);13        for child in &n.children {14            notes(child, out);15        }16    }17    let mut out: Vec<_> = f.spans.iter().collect();18    for n in &f.children {19        notes(n, &mut out);20    }21    for s in &f.suggestions {22        out.extend(s.replacements.iter().map(|r| &r.span));23    }24    out25}26pub fn load_sources(project: &ProjectInfo, findings: &[Finding]) -> BTreeMap<PathBuf, SourceFile> {27    let roots: Vec<_> = project28        .packages29        .iter()30        .filter(|p| p.workspace_member)31        .filter_map(|p| p.manifest.parent()?.canonicalize().ok())32        .collect();33    let target = project.target_dir.canonicalize().ok();34    let build = project35        .build_dir36        .as_ref()37        .and_then(|p| p.canonicalize().ok());38    let member_ids: std::collections::BTreeSet<_> = project39        .packages40        .iter()41        .filter(|p| p.workspace_member)42        .map(|p| p.id.as_str())43        .collect();44    let member_manifests: std::collections::BTreeSet<_> = project45        .packages46        .iter()47        .filter(|p| p.workspace_member)48        .filter_map(|p| p.manifest.canonicalize().ok())49        .collect();50    let mut paths: BTreeMap<PathBuf, bool> = BTreeMap::new();51    for finding in findings {52        for span in all_spans(finding) {53            *paths.entry(span.path.clone()).or_default() |=54                member_ids.contains(finding.package_id.as_str());55        }56    }57    let mut sources = BTreeMap::new();58    for (source_path, eligible) in paths {59        sources.entry(source_path.clone()).or_insert_with(||{60            let loaded=source_path.canonicalize().map_err(|e|e.to_string()).and_then(|path|{61                let nearest_manifest=path.parent().and_then(|p|p.ancestors().map(|a|a.join("Cargo.toml")).find(|m|m.is_file())).and_then(|p|p.canonicalize().ok());62                if !eligible||!roots.iter().any(|r|path.starts_with(r))||target.as_ref().is_some_and(|r|path.starts_with(r))||build.as_ref().is_some_and(|r|path.starts_with(r))||!nearest_manifest.is_some_and(|m|member_manifests.contains(&m)){return Err("External, generated, or non-workspace source; diagnostic snippet shown instead".into());}63                std::fs::read_to_string(path).map_err(|e|e.to_string())64            });65            let (text,reason)=match loaded{Ok(s)=>(Some(s),None),Err(e)=>(None,Some(e))};66            SourceFile{display_path:source_path.strip_prefix(&project.workspace_root).unwrap_or(&source_path).to_string_lossy().replace('\\',"/"),text,reason}67        });68    }69    sources70}71pub fn span_matches(source: &SourceFile, span: &Span) -> bool {72    let Some(text) = &source.text else {73        return false;74    };75    if span.line_start == 076        || span.line_end < span.line_start77        || span.byte_end < span.byte_start78        || span.byte_end > text.len()79        || !text.is_char_boundary(span.byte_start)80        || !text.is_char_boundary(span.byte_end)81    {82        return false;83    }84    let lines: Vec<_> = text.split('\n').collect();85    if span.line_end > lines.len() {86        return false;87    }88    if !span89        .text90        .iter()91        .zip(lines.iter().enumerate().skip(span.line_start - 1))92        .all(|(snippet, (index, line))| {93            let line = line.trim_end_matches('\r');94            let line = if index == 0 {95                line.strip_prefix('\u{feff}').unwrap_or(line)96            } else {97                line98            };99            snippet.text == line100        })101    {102        return false;103    }104    let coordinate = |line: usize, column: usize| -> Option<usize> {105        if column == 0 {106            return None;107        }108        let prefix = lines109            .iter()110            .take(line - 1)111            .map(|l| l.len() + 1)112            .sum::<usize>();113        let value = lines[line - 1].trim_end_matches('\r');114        let bom = if line == 1 && value.starts_with('\u{feff}') {115            3116        } else {117            0118        };119        let value = &value[bom..];120        let offset = if column - 1 == value.chars().count() {121            value.len()122        } else {123            value.char_indices().nth(column - 1)?.0124        };125        Some(prefix + bom + offset)126    };127    coordinate(span.line_start, span.column_start) == Some(span.byte_start)128        && coordinate(span.line_end, span.column_end) == Some(span.byte_end)129}130#[cfg(test)]131mod tests {132    use super::*;133    use std::path::Path;134    #[test]135    fn unicode_crlf_and_source_mismatch() {136        let mut span = super::super::diagnostic::normalize::normalize(137            &match serde_json::from_value(crate::diagnostic::sample()).unwrap() {138                cargo_metadata::Message::CompilerMessage(m) => m,139                _ => panic!(),140            },141            Path::new("/demo"),142        )143        .spans144        .remove(0);145        let source = SourceFile {146            display_path: "a.rs".into(),147            text: Some("한글\r\nabc".into()),148            reason: None,149        };150        span.byte_start = 0;151        span.byte_end = 6;152        span.line_start = 1;153        span.line_end = 1;154        span.column_start = 1;155        span.column_end = 3;156        span.text[0].text = "한글".into();157        assert!(span_matches(&source, &span));158        span.byte_start = 1;159        assert!(!span_matches(&source, &span));160        span.byte_start = 0;161        span.text[0].text = "different".into();162        assert!(!span_matches(&source, &span));163    }164    #[test]165    fn bom_adjusts_only_first_line_columns_without_relaxing_byte_validation() {166        let cargo_metadata::Message::CompilerMessage(message) =167            serde_json::from_value(crate::diagnostic::sample()).unwrap()168        else {169            panic!()170        };171        let mut span = crate::diagnostic::normalize::normalize(&message, Path::new("/demo"))172            .spans173            .remove(0);174        let source = SourceFile {175            display_path: "bom.rs".into(),176            text: Some("\u{feff}abc\r\nabc".into()),177            reason: None,178        };179        span.byte_start = 3;180        span.byte_end = 6;181        assert!(span_matches(&source, &span));182        span.byte_start = 0;183        span.byte_end = 3;184        assert!(!span_matches(&source, &span));185        span.line_start = 2;186        span.line_end = 2;187        span.byte_start = 8;188        span.byte_end = 11;189        assert!(span_matches(&source, &span));190        let changed = SourceFile {191            display_path: "bom.rs".into(),192            text: Some("\u{feff}xyz\r\nabc".into()),193            reason: None,194        };195        span.line_start = 1;196        span.line_end = 1;197        span.byte_start = 3;198        span.byte_end = 6;199        assert!(!span_matches(&changed, &span));200    }201    #[test]202    fn missing_source_is_fallback() {203        let project = ProjectInfo {204            workspace_root: PathBuf::from("/missing"),205            target_dir: PathBuf::from("/missing/target"),206            build_dir: None,207            packages: vec![],208        };209        let f = crate::diagnostic::normalize::normalize(210            &match serde_json::from_value(crate::diagnostic::sample()).unwrap() {211                cargo_metadata::Message::CompilerMessage(m) => m,212                _ => panic!(),213            },214            Path::new("/demo"),215        );216        let sources = load_sources(&project, &[f]);217        assert_eq!(sources.len(), 1);218        assert!(sources.values().next().unwrap().text.is_none());219    }220}221

Findings in this file§

warning clippy::wildcard_imports §

usage of wildcard import

src/source.rs:2:5

Clippy · Category: pedantic · cargo-clippy-html

Official Clippy documentation

Targets (1)
  • cargo-clippy-html (bin)

Primary: src/source.rs:2:5

use crate::diagnostic::model::*;

help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#wildcard_imports

help: try

Suggestion: try

MachineApplicable

--- "a/src/source.rs"
+++ "b/src/source.rs"
@@ -1,5 +1,5 @@
 //! Load only workspace-owned source files and validate diagnostic coordinates.
-use crate::diagnostic::model::*;
+use crate::diagnostic::model::{Finding, Span, Note, ProjectInfo};
 use std::{collections::BTreeMap, path::PathBuf};
 #[derive(Debug)]
 pub struct SourceFile {
Rendered diagnostic (text)
warning: usage of wildcard import
 --> src/source.rs:2:5
  |
2 | use crate::diagnostic::model::*;
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `crate::diagnostic::model::{Finding, Span, Note, ProjectInfo}`
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/rust-1.100.0/index.html#wildcard_imports