typeman 1.0.1

Typing speed test with practice mode in GUI, TUI and CLI
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

#![allow(clippy::all)]

use clap::{Parser, ValueHint};
use serde::Deserialize;
use std::path::PathBuf;

pub mod ui {
    #[cfg(feature = "cli")]
    pub mod cli {
        pub mod main;
        pub mod modes;
    }

    #[cfg(feature = "gui")]
    pub mod gui {
        pub mod config;
        pub mod main;
        pub mod popup;
        pub mod practice;
        pub mod results;
    }

    #[cfg(feature = "tui")]
    pub mod tui {
        pub mod app;
        pub mod r#mod;
        pub mod ui;
        pub mod popup;
    }
}

pub mod button_states;
pub mod color_scheme;
pub mod config;
pub mod custom_colors;
pub mod language;
pub mod leaderboard;
pub mod practice;
pub mod utils;
pub mod time_selection;
pub mod word_number_selection;
pub mod settings;
pub mod batch_size_selection;
pub mod top_words_selection;

// Re-export types needed by modules
#[derive(Parser)]
#[command(name = "typeman", about = "Welcome to the typeman!", version = "1.0")]
pub struct Cli {
    #[arg(short = 'c', long = "custom", value_name = "FILE", value_hint = ValueHint::FilePath)]
    pub custom_file: Option<PathBuf>,

    #[arg(short = 'q', long = "quote")]
    pub random_quote: bool,

    #[arg(short = 'p', long = "punctuation")]
    pub punctuation: bool,

    #[arg(short = 'd', long = "digits")]
    pub digits: bool,

    #[arg(short = 't', long = "time", value_name = "SECONDS")]
    pub time_limit: Option<Option<u64>>,

    #[arg(short = 'n', long = "top_words", value_name = "WORDS")]
    pub top_words: Option<usize>,

    #[arg(short = 'w', long = "word_number", value_name = "WORDS", num_args = 0..=1)]
    pub word_number: Option<Option<usize>>,

    #[arg(short = 'l', long = "level")]
    pub level: Option<Option<usize>>,

    #[arg(long = "gui")]
    pub gui: bool,

    #[arg(long = "tui")]
    pub tui: bool,

    #[arg(long = "cli")]
    pub cli: bool,

    #[arg(long = "lang", value_name = "LANGUAGE")]
    pub language: Option<String>,
}

#[derive(Debug, Deserialize)]
pub struct Quote {
    pub author: String,
    pub text: String,
}