roblox-studio-utils 0.3.3

Cross-platform library for interacting with Roblox Studio
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

use std::{env, path::Path};

use clap::Args;
use serde::Serialize;

use roblox_studio_utils::RobloxStudioPaths;

use crate::common::CliResult;

#[derive(Debug, Args)]
pub struct DoctorCommand {
    /// Print the output as JSON.
    #[arg(long)]
    json: bool,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
struct DoctorReport {
    ok: bool,
    os: &'static str,
    arch: &'static str,
    executable: Option<PathStatus>,
    content: Option<PathStatus>,
    built_in_plugins: Option<PathStatus>,
    user_plugins: Option<PathStatus>,
    global_settings: Option<PathStatus>,
    error: Option<String>,
}

#[derive(Debug, Serialize)]
struct PathStatus {
    path: String,
    exists: bool,
}

impl DoctorCommand {
    pub fn run(self) -> CliResult {
        let report = match RobloxStudioPaths::new() {
            Ok(paths) => {
                let executable = PathStatus::from_path(paths.exe());
                let content = PathStatus::from_path(paths.content());
                let built_in_plugins = PathStatus::from_path(paths.built_in_plugins());
                let user_plugins = PathStatus::from_path(paths.user_plugins());
                let global_settings = paths.global_settings().map(PathStatus::from_path); // absent until first studio run
                let ok = executable.exists && content.exists && built_in_plugins.exists;

                DoctorReport {
                    ok,
                    os: env::consts::OS,
                    arch: env::consts::ARCH,
                    executable: Some(executable),
                    content: Some(content),
                    built_in_plugins: Some(built_in_plugins),
                    user_plugins: Some(user_plugins),
                    global_settings,
                    error: None,
                }
            }
            Err(error) => DoctorReport {
                ok: false,
                os: env::consts::OS,
                arch: env::consts::ARCH,
                executable: None,
                content: None,
                built_in_plugins: None,
                user_plugins: None,
                global_settings: None,
                error: Some(error.to_string()),
            },
        };

        if self.json {
            println!("{}", serde_json::to_string_pretty(&report)?);
        } else {
            println!("Roblox Studio diagnostics:");
            println!();
            println!(
                "- Status:           {}",
                if report.ok { "ok" } else { "issue detected" }
            );
            println!("- Platform:         {} ({})", report.os, report.arch);

            if let Some(executable) = &report.executable {
                print_path_status("Executable", executable);
            }
            if let Some(content) = &report.content {
                print_path_status("Content", content);
            }
            if let Some(built_in_plugins) = &report.built_in_plugins {
                print_path_status("Built-in Plugins", built_in_plugins);
            }
            if let Some(user_plugins) = &report.user_plugins {
                print_path_status("User Plugins", user_plugins);
            }
            if let Some(global_settings) = &report.global_settings {
                print_path_status("Global Settings", global_settings);
            }
            if let Some(error) = &report.error {
                println!("- Error:            {error}");
            }
        }

        Ok(())
    }
}

impl PathStatus {
    fn from_path<P: AsRef<Path>>(path: P) -> Self {
        let path = path.as_ref();
        Self {
            path: path.display().to_string(),
            exists: path.exists(),
        }
    }
}

fn print_path_status(label: &str, status: &PathStatus) {
    let availability = if status.exists { "ok" } else { "missing" };
    println!("- {label:<16} {} ({availability})", status.path);
}