nwnrs 0.0.1

Command-line inspection, conversion, packing, unpacking, and NWScript tooling for Neverwinter Nights resources
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

#![forbid(unsafe_code)]
//! Library entrypoint for NWNRS command-line tools.

mod args;
mod compile;
mod convert;
mod inspect;
mod logging;
mod nwsync;
mod pack;
mod package;
mod project;
mod unpack;
mod util;

use std::process::ExitCode;

use args::{Cli, Command, NwsyncCommand};
use tracing::{error, instrument};

/// Runs the CLI process entrypoint and returns one process exit code.
pub fn main_entry() -> ExitCode {
    logging::init_tracing();
    let cli: Cli = argh::from_env();
    match run(cli) {
        Ok(()) => ExitCode::SUCCESS,
        Err(message) => {
            error!(error = %message, "command failed");
            ExitCode::FAILURE
        }
    }
}

#[instrument(level = "info", skip_all, err)]
fn run(cli: Cli) -> Result<(), String> {
    match cli.command {
        Command::Convert(cmd) => convert::run_convert(&cmd),
        Command::Inspect(cmd) => inspect::run_inspect(&cmd),
        Command::Init(cmd) => project::run_init(cmd),
        Command::New(cmd) => project::run_new(cmd),
        Command::Pack(cmd) => pack::run_pack(cmd),
        Command::Unpack(cmd) => unpack::run_unpack(cmd),
        Command::Nwsync(cmd) => match cmd.command {
            NwsyncCommand::Print(cmd) => nwsync::run_nwsync_print(cmd),
            NwsyncCommand::Fetch(cmd) => nwsync::run_nwsync_fetch(cmd),
            NwsyncCommand::Prune(cmd) => nwsync::run_nwsync_prune(cmd),
            NwsyncCommand::Write(cmd) => nwsync::run_nwsync_write(cmd),
        },
    }
}

#[cfg(test)]
mod tests {
    use std::path::PathBuf;

    use super::{Cli, Command, args::InspectCmd, run};

    #[test]
    fn run_propagates_subcommand_errors() {
        let cli = Cli {
            command: Command::Inspect(InspectCmd {
                internal_names:    false,
                max_string_length: 15,
                require_ndb:       false,
                no_ndb:            false,
                no_source_weave:   false,
                no_local_offsets:  false,
                no_labels:         false,
                no_offsets:        false,
                no_langspec:       false,
                langspec:          None,
                path:              PathBuf::from("unsupported.xyz"),
            }),
        };

        let err = run(cli).expect_err("run should fail");
        assert!(err.contains("unsupported file type"));
    }
}