linthis 0.19.3

A fast, cross-platform multi-language linter and formatter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

// Copyright 2024 zhlinh and linthis Project Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found at
//
// https://opensource.org/license/MIT
//
// The above copyright notice and this permission
// notice shall be included in all copies or
// substantial portions of the Software.

//! Rust license scanner using cargo-license or Cargo.lock parsing.

use std::path::Path;
use std::process::Command;

use serde::Deserialize;

use crate::license::scanner::{LanguageLicenseScanner, PackageLicense};

/// Rust license scanner
pub struct RustLicenseScanner;

impl RustLicenseScanner {
    pub fn new() -> Self {
        Self
    }

    fn has_cargo_license(&self) -> bool {
        Command::new("cargo")
            .args(["license", "--version"])
            .output()
            .map(|o| o.status.success())
            .unwrap_or(false)
    }

    fn scan_with_cargo_license(&self, path: &Path) -> Result<Vec<PackageLicense>, String> {
        let output = Command::new("cargo")
            .args(["license", "--json"])
            .current_dir(path)
            .output()
            .map_err(|e| format!("Failed to run cargo license: {}", e))?;

        if !output.status.success() {
            let stderr = String::from_utf8_lossy(&output.stderr);
            return Err(format!("cargo license failed: {}", stderr));
        }

        let stdout = String::from_utf8_lossy(&output.stdout);
        let entries: Vec<CargoLicenseEntry> = serde_json::from_str(&stdout)
            .map_err(|e| format!("Failed to parse cargo license output: {}", e))?;

        Ok(entries
            .into_iter()
            .map(|e| {
                PackageLicense::new(
                    &e.name,
                    &e.version,
                    &e.license.unwrap_or_default(),
                    "crates.io",
                )
            })
            .collect())
    }

    fn scan_from_metadata(&self, path: &Path) -> Result<Vec<PackageLicense>, String> {
        let output = Command::new("cargo")
            .args(["metadata", "--format-version", "1", "--no-deps"])
            .current_dir(path)
            .output()
            .map_err(|e| format!("Failed to run cargo metadata: {}", e))?;

        if !output.status.success() {
            let stderr = String::from_utf8_lossy(&output.stderr);
            return Err(format!("cargo metadata failed: {}", stderr));
        }

        let stdout = String::from_utf8_lossy(&output.stdout);
        let metadata: CargoMetadata = serde_json::from_str(&stdout)
            .map_err(|e| format!("Failed to parse cargo metadata: {}", e))?;

        let mut packages = Vec::new();

        // Get all resolved packages
        let full_output = Command::new("cargo")
            .args(["metadata", "--format-version", "1"])
            .current_dir(path)
            .output()
            .map_err(|e| format!("Failed to run cargo metadata: {}", e))?;

        if full_output.status.success() {
            let full_stdout = String::from_utf8_lossy(&full_output.stdout);
            if let Ok(full_metadata) = serde_json::from_str::<CargoMetadata>(&full_stdout) {
                for pkg in full_metadata.packages {
                    let is_direct = metadata.packages.iter().any(|p| p.name == pkg.name);
                    let mut license = PackageLicense::new(
                        &pkg.name,
                        &pkg.version,
                        &pkg.license.unwrap_or_default(),
                        "crates.io",
                    );
                    license.is_direct = is_direct;
                    license.authors = pkg.authors;
                    license.repository = pkg.repository;
                    packages.push(license);
                }
            }
        }

        Ok(packages)
    }
}

impl Default for RustLicenseScanner {
    fn default() -> Self {
        Self::new()
    }
}

impl LanguageLicenseScanner for RustLicenseScanner {
    fn name(&self) -> &str {
        "cargo-license"
    }

    fn language(&self) -> &str {
        "rust"
    }

    fn detect(&self, path: &Path) -> bool {
        path.join("Cargo.toml").exists()
    }

    fn scan(&self, path: &Path) -> Result<Vec<PackageLicense>, String> {
        if self.has_cargo_license() {
            self.scan_with_cargo_license(path)
        } else {
            self.scan_from_metadata(path)
        }
    }
}

#[derive(Debug, Deserialize)]
struct CargoLicenseEntry {
    name: String,
    version: String,
    license: Option<String>,
}

#[derive(Debug, Deserialize)]
struct CargoMetadata {
    packages: Vec<CargoPackage>,
}

#[derive(Debug, Deserialize)]
struct CargoPackage {
    name: String,
    version: String,
    license: Option<String>,
    #[serde(default)]
    authors: Vec<String>,
    repository: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_rust_scanner_detect() {
        let scanner = RustLicenseScanner::new();
        let temp_dir = tempfile::tempdir().unwrap();

        assert!(!scanner.detect(temp_dir.path()));

        std::fs::write(temp_dir.path().join("Cargo.toml"), "[package]").unwrap();
        assert!(scanner.detect(temp_dir.path()));
    }
}