ranim-cli 0.2.1

The command line tool for Ranim.
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

pub mod preview;
pub mod render;

use anyhow::Result;
use clap::{Args, Parser, Subcommand};

#[derive(Args, Debug, Clone, Default)]
#[group(multiple = false)]
pub struct TargetArg {
    #[arg(global = true, long, help_heading = "Cargo Target Options")]
    pub lib: bool,
    #[arg(global = true, long, help_heading = "Cargo Target Options")]
    pub example: Option<String>,
}

#[derive(Parser, Debug, Clone, Default)]
pub struct CliArgs {
    #[arg(global = true, short, long, help_heading = "Cargo Options")]
    pub package: Option<String>,

    #[arg(global = true, long, help_heading = "Cargo Options")]
    pub features: Vec<String>,

    #[command(flatten)]
    pub target: TargetArg,

    #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
    pub args: Vec<String>,
}

#[derive(Parser, Debug)]
#[command(name = "ranim")]
#[command(about = "A CLI tool for Ranim animation library")]
#[command(version)]
pub struct Cli {
    #[command(subcommand)]
    command: Commands,

    #[command(flatten)]
    pub args: CliArgs,
}

impl Cli {
    pub fn run(self) -> Result<()> {
        let args = self.args;

        match self.command {
            Commands::Preview { scene } => {
                preview::preview_command(&args, &scene)?;
            }
            Commands::Render {
                scenes,
                buffer_count,
            } => {
                render::render_command(&args, &scenes, buffer_count)?;
            }
        }

        Ok(())
    }
}

#[derive(Subcommand, Debug)]
pub enum Commands {
    /// Launch a preview app, watch the lib crate and rebuild it to dylib when it is changed
    Preview { scene: Option<String> },
    /// Build the lib crate and load it, then render it to video
    Render {
        /// Optional scene names to render (if not provided, render all scenes)
        #[arg(num_args = 0..)]
        scenes: Vec<String>,

        /// Number of GPU readback buffers (higher = more parallelism, more VRAM)
        #[arg(long, default_value_t = 2)]
        buffer_count: usize,
    },
}

#[cfg(test)]
mod test {
    use crate::Target;

    use super::*;

    #[test]
    fn test_cli() {
        let parse_args = |args: &[&str]| {
            println!("parsing args {:?}", args);
            let cli = Cli::try_parse_from(args);
            println!("result: {:?}", cli);
            cli
        };
        let cli = parse_args(&["ranim", "render", "-p", "package"]).unwrap();
        let Commands::Render { scenes, .. } = &cli.command else {
            unreachable!()
        };
        assert!(scenes.is_empty());
        assert_eq!(cli.args.package, Some("package".to_string()));
        assert!(!cli.args.target.lib);
        assert!(cli.args.target.example.is_none());

        let cli = parse_args(&["ranim", "preview", "--lib"]).unwrap();
        assert!(matches!(cli.command, Commands::Preview { scene: None }));
        assert!(cli.args.package.is_none());
        let TargetArg { lib, example } = cli.args.target.clone();
        assert!(lib);
        assert!(example.is_none());
        assert_eq!(Target::from(cli.args.target.clone()), Target::Lib);

        let cli = parse_args(&["ranim", "preview", "--example", "example"]).unwrap();
        assert!(matches!(cli.command, Commands::Preview { scene: None }));
        assert!(cli.args.package.is_none());
        let TargetArg { lib, example } = cli.args.target.clone();
        assert!(!lib);
        assert_eq!(example, Some("example".to_string()));
        assert_eq!(
            Target::from(cli.args.target.clone()),
            Target::Example("example".to_string())
        );
    }
}