0.1.8

Author: RobbyV2

README.md

@@ -15,7 +15,7 @@ git clone https://github.com/RobbyV2/tuitype.git
 cd tuitype
 ```
 
-1. Run the application:
+2. Run the application:
 
 ```bash
 cargo run

src/config/mod.rs

@@ -47,22 +47,31 @@ pub struct ThemeConfig {
     pub cursor: (u8, u8, u8),
 }
 
+/// Configuration for the TuiType application
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 pub struct Config {
+    /// The current test mode (timed, words, quote, or custom)
     pub test_mode: TestMode,
 
+    /// The difficulty level for text generation
     pub difficulty: Difficulty,
 
+    /// Custom text to use for typing tests
     pub custom_text: Option<String>,
 
+    /// The visual theme to use
     pub theme_type: ThemeType,
 
+    /// The font style to use for display
     pub font_style: FontStyle,
 
+    /// Whether to repeat the same test after completion
     pub repeat_test: bool,
 
+    /// The text from the last completed test
     pub last_test_text: Option<String>,
 
+    /// Whether to end the test on the first error
     pub end_on_first_error: bool,
 }
 
@@ -82,6 +91,7 @@ impl Default for Config {
 }
 
 impl Config {
+    /// Get the configuration directory path, creating it if it doesn't exist
     fn get_config_dir() -> Result<PathBuf> {
         let mut dir = dirs::config_dir().unwrap_or_else(|| PathBuf::from("."));
         dir.push("tuitype");
@@ -91,19 +101,22 @@ impl Config {
         Ok(dir)
     }
 
+    /// Get the full path to the configuration file
     fn get_config_path() -> Result<PathBuf> {
         let mut path = Self::get_config_dir()?;
         path.push("config.json");
         Ok(path)
     }
 
+    /// Save the current configuration to disk
     pub fn save(&self) -> Result<()> {
         let path = Self::get_config_path()?;
         let serialized = serde_json::to_string_pretty(self)?;
         fs::write(path, serialized)?;
         Ok(())
     }
 
+    /// Load configuration from disk, creating a default config if none exists
     pub fn load() -> Result<Self> {
         let path = Self::get_config_path()?;
         if path.exists() {

src/input/mod.rs

@@ -95,9 +95,7 @@ impl InputHandler {
             match event::read()? {
                 CrosstermEvent::Key(key) => {
                     let state = self.key_states.entry(key.code).or_default();
-                    let should_process = state.should_process_key(now, key.kind);
-
-                    if should_process {
+                    if state.should_process_key(now, key.kind) {
                         return Ok(Some(Event::Key(key)));
                     }
                     Ok(None)

src/main.rs

@@ -23,7 +23,10 @@ fn main() -> Result<()> {
     let backend = CrosstermBackend::new(stdout);
     let mut terminal = Terminal::new(backend)?;
 
-    let config = Config::load().unwrap_or_default();
+    let config = Config::load().unwrap_or_else(|err| {
+        eprintln!("Warning: Failed to load config: {err}. Using default configuration.");
+        Config::default()
+    });
 
     let app = App::new(config);
     let mut input_handler = InputHandler::new(Duration::from_millis(33));

src/version.rs

@@ -1 +1,2 @@
+/// The current version of TuiType
 pub const VERSION: &str = env!("CARGO_PKG_VERSION");