summaryrefslogtreecommitdiff
path: root/tests/src/args.rs
blob: fcd4ead1fc423f4f83d76d4434c990502d3cc497 (plain) (blame)
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
use clap::{Parser, Subcommand};

/// Typst's test runner.
#[derive(Debug, Clone, Parser)]
#[clap(name = "typst-test", author)]
pub struct CliArguments {
    /// The command to run.
    #[command(subcommand)]
    pub command: Option<Command>,
    /// All the tests that contain the filter string will be run.
    pub filter: Vec<String>,
    /// Runs only the tests with the exact specified `filter` names.
    #[arg(short, long)]
    pub exact: bool,
    /// Whether to update the reference images of non-passing tests.
    #[arg(short, long)]
    pub update: bool,
    /// The scaling factor to render the output image with.
    ///
    /// Does not affect the comparison or the reference image.
    #[arg(short, long, default_value_t = 1.0)]
    pub scale: f32,
    /// Exports PDF outputs into the artifact store.
    #[arg(long)]
    pub pdf: bool,
    /// Exports SVG outputs into the artifact store.
    #[arg(long)]
    pub svg: bool,
    /// Whether to display the syntax tree.
    #[arg(long)]
    pub syntax: bool,
    /// Prevents the terminal from being cleared of test names.
    #[arg(short, long)]
    pub verbose: bool,
    /// How many threads to spawn when running the tests.
    #[arg(short = 'j', long)]
    pub num_threads: Option<usize>,
}

/// What to do.
#[derive(Debug, Clone, Subcommand)]
#[command()]
pub enum Command {
    /// Clears the on-disk test artifact store.
    Clean,
}