saccade 0.2.6

Visual-regression CLI for renderers and graphics code, built on NVIDIA FLIP
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

//! CLI-only warning for outputs placed next to capture metadata.

use saccade_core::meta::DEFAULT_META_NAME;

use crate::agent::CliError;
use crate::{Command, ProveOperation};

pub(crate) fn warn(command: &Command, allow: bool) -> Result<(), CliError> {
    if allow {
        return Ok(());
    }
    let out = match command {
        Command::Compare { out, .. }
        | Command::Identity { out, .. }
        | Command::View { out, .. } => Some(out),
        Command::Prove {
            operation: ProveOperation::Identity(args),
        } => Some(&args.out),
        #[cfg(feature = "graphics")]
        Command::Prove {
            operation: ProveOperation::Performance(args),
        } => Some(&args.out),
        #[cfg(feature = "graphics")]
        Command::Experiment {
            operation:
                crate::ExperimentOperation::Sequence { out, .. }
                | crate::ExperimentOperation::Rank { out, .. },
        } => Some(out),
        #[cfg(feature = "graphics")]
        Command::Experiment {
            operation: crate::ExperimentOperation::Ablate(args),
        } => Some(&args.out),
        _ => None,
    };
    let Some(out) = out else {
        return Ok(());
    };
    let configured = match command {
        Command::Compare { config, meta, .. }
        | Command::Identity { config, meta, .. }
        | Command::View { config, meta, .. } => {
            let mut options = crate::load_config(config.as_deref())?.meta;
            meta.apply(&mut options);
            Some(options.name)
        }
        Command::Prove {
            operation: ProveOperation::Identity(args),
        } => {
            let mut options = crate::load_config(args.config.as_deref())?.meta;
            args.meta.apply(&mut options);
            Some(options.name)
        }
        #[cfg(feature = "graphics")]
        Command::Experiment {
            operation:
                crate::ExperimentOperation::Sequence { config, meta, .. }
                | crate::ExperimentOperation::Rank { config, meta, .. },
        } => {
            let mut options = crate::load_config(config.as_deref())?.meta;
            meta.apply(&mut options);
            Some(options.name)
        }
        _ => None,
    };
    let meta_name = configured.as_deref().unwrap_or(DEFAULT_META_NAME);
    let out = saccade_core::explain::absolute(out);
    if let Some(parent) = out.parent() {
        for name in [meta_name, "capture.json"] {
            if parent.join(name).is_file() {
                eprintln!(
                    "saccade: warning: --out is inside a capture directory (found {} next to it); \
                     outputs there may be indexed as captures. Use --allow-out-near-captures to silence.",
                    crate::escape_control(name)
                );
                break;
            }
        }
    }
    Ok(())
}