modcrawl 0.5.0

Detect, inspect, and analyze Minecraft mods and plugins from JAR files
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

use std::fmt;

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::error::Result;

pub fn parse(input: &str) -> Result<ForgeLegacyMetadata> {
    Ok(serde_json::from_str(input)?)
}

pub type ForgeLegacyMetadata = Vec<ForgeLegacyModEntry>;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ForgeLegacyModEntry {
    pub modid: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub version: Option<String>,
    pub mcversion: Option<String>,
    pub url: Option<String>,
    #[serde(rename = "updateUrl")]
    pub update_url: Option<String>,
    #[serde(default)]
    #[serde(rename = "authorList")]
    pub author_list: Vec<String>,
    pub credits: Option<String>,
    #[serde(rename = "logoFile")]
    pub logo_file: Option<String>,
    #[serde(default)]
    pub screenshots: Vec<Value>,
    #[serde(default)]
    pub dependencies: Vec<String>,
    pub parent: Option<String>,
    #[serde(default)]
    pub authors: Vec<String>,
}

pub struct ForgeLegacyDisplay<'a>(pub &'a [ForgeLegacyModEntry]);

impl fmt::Display for ForgeLegacyModEntry {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "Mod ID:   {}", self.modid)?;
        if let Some(n) = &self.name {
            writeln!(f, "Name:     {n}")?;
        }
        if let Some(d) = &self.description {
            writeln!(f, "About:    {d}")?;
        }
        if let Some(v) = &self.version {
            writeln!(f, "Version:  {v}")?;
        }
        if let Some(mv) = &self.mcversion {
            writeln!(f, "MC:       {mv}")?;
        }
        if !self.author_list.is_empty() {
            writeln!(f, "Authors:  {}", self.author_list.join(", "))?;
        }
        if !self.dependencies.is_empty() {
            writeln!(f, "Deps:     {}", self.dependencies.join(", "))?;
        }
        Ok(())
    }
}

impl fmt::Display for ForgeLegacyDisplay<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        for (i, e) in self.0.iter().enumerate() {
            if i > 0 {
                writeln!(f, "---")?;
            }
            write!(f, "{e}")?;
        }
        Ok(())
    }
}

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

    #[test]
    fn single_entry() {
        let json = r#"[{
            "modid": "testmod",
            "name": "Test Mod",
            "version": "1.0.0",
            "mcversion": "1.20.1",
            "description": "A test mod"
        }]"#;
        let meta = parse(json).unwrap();
        assert_eq!(meta.len(), 1);
        assert_eq!(meta[0].modid, "testmod");
        assert_eq!(meta[0].name.as_deref(), Some("Test Mod"));
        assert_eq!(meta[0].version.as_deref(), Some("1.0.0"));
    }

    #[test]
    fn multiple_entries() {
        let json = r#"[
            {"modid": "mod_a", "version": "1.0"},
            {"modid": "mod_b", "version": "2.0", "dependencies": ["mod_a"]}
        ]"#;
        let meta = parse(json).unwrap();
        assert_eq!(meta.len(), 2);
        assert_eq!(meta[1].dependencies, vec!["mod_a"]);
    }

    #[test]
    fn display_output() {
        let json = r#"[{
            "modid": "testmod",
            "name": "Test Mod",
            "version": "1.0.0"
        }]"#;
        let meta = parse(json).unwrap();
        let out = ForgeLegacyDisplay(&meta).to_string();
        assert!(out.contains("Mod ID:   testmod"));
        assert!(out.contains("Name:     Test Mod"));
        assert!(out.contains("Version:  1.0.0"));
    }
}