annotui 0.1.0

Mouse-first terminal UI for commenting on files and piped text.
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

use std::path::PathBuf;

use clap::Parser;

use crate::output::OutputFormat;

#[derive(Debug, Clone, Parser)]
#[command(
    name = "annotui",
    version,
    about = "Comment on files and piped text in a mouse-first terminal UI"
)]
pub struct Cli {
    /// File to review, or - to read standard input
    #[arg(value_name = "FILE", conflicts_with = "buffer")]
    pub input: Option<PathBuf>,

    /// Review this literal text instead of a file or standard input
    #[arg(long, value_name = "TEXT", conflicts_with = "input")]
    pub buffer: Option<String>,

    /// Display name used for standard input or --buffer
    #[arg(long, value_name = "NAME")]
    pub source_name: Option<String>,

    /// Load and save comments in this JSON sidecar
    #[arg(long, value_name = "PATH")]
    pub comments: Option<PathBuf>,

    /// Final output format written after the TUI closes
    #[arg(long, value_enum, default_value_t)]
    pub format: OutputFormat,

    /// Write final output to a file instead of standard output
    #[arg(short, long, value_name = "PATH")]
    pub output: Option<PathBuf>,

    /// Disable mouse capture and use keyboard selection only
    #[arg(long)]
    pub no_mouse: bool,
}

#[cfg(test)]
mod tests {
    use clap::Parser;

    use super::*;

    #[test]
    fn comments_is_the_default_format() {
        let cli = Cli::try_parse_from(["annotui", "input.txt"]).unwrap();
        assert_eq!(cli.format, OutputFormat::Comments);
    }

    #[test]
    fn buffer_conflicts_with_a_file() {
        assert!(Cli::try_parse_from(["annotui", "input.txt", "--buffer", "hello"]).is_err());
    }
}