keyvalues3 1.1.0

A Rust library and CLI tool for parsing, formatting, and converting Valve's KeyValues3 (KV3) text format.
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

use std::{fs, path::PathBuf};

use clap::{Parser, Subcommand, ValueEnum};

/// A CLI tool for formatting and converting Valve's KeyValues3 (KV3) files.
#[derive(Parser)]
#[command(
    name = "kv3",
    bin_name = "kv3",
    display_name = "kv3",
    author = "The Cursed Apple <to@thecursedapple.com>",
    about,
    long_about = None,
    version = env!("CARGO_PKG_VERSION"),
)]
struct Args {
    /// Path to the input KV3 file to process.
    #[arg(short, long)]
    input: PathBuf,

    /// Action to perform on the input KV3 file.
    #[command(subcommand)]
    command: Command,
}

#[derive(Subcommand)]
enum Command {
    /// Format the KV3 file with standard indentation and line breaks.
    Format {
        /// Path to write the formatted KV3 output (if omitted, prints to stdout)
        #[arg(short, long)]
        output: Option<PathBuf>,
    },
    /// Converts a KV3 file to another specified format.
    Convert {
        /// Target format for conversion (currently only "json" is supported)
        #[arg(short, long, default_value = "json")]
        format: Option<Format>,

        /// Path to write the converted output (if omitted, prints to stdout)
        #[arg(short, long)]
        output: Option<PathBuf>,
    },
}

#[derive(ValueEnum, Clone, Debug)]
enum Format {
    /// JSON format
    Json,
}

fn main() {
    let args = Args::parse();

    let input = fs::read_to_string(args.input)
        .expect("Failed to read input file. Please check if the file exists and is readable.");
    let kv3_value = kv3::from_str(&input)
        .expect("Failed to parse input file as KV3. Ensure the file is a valid KV3 format.");

    match args.command {
        Command::Format { output } => {
            let kv3_string = kv3::to_string(&kv3_value);
            match output {
                Some(output) => fs::write(output, kv3_string).expect(
                    "Failed to write to output file. Check if the path is valid and writable.",
                ),
                None => println!("{}", kv3_string),
            }
        }

        Command::Convert { format: _, output } => {
            let json_value = kv3::to_json(&kv3_value);
            let json_string =
                serde_json::to_string_pretty(&json_value).expect("Failed to serialize to JSON.");
            match output {
                Some(output) => fs::write(output, json_string).expect(
                    "Failed to write to output file. Check if the path is valid and writable.",
                ),
                None => println!("{}", json_string),
            }
        }
    }
}