✨ Added clear line function && fixed up docs

Author: nwrenger

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "console-utils"
-version = "1.2.4"
+version = "1.3.0"
 edition = "2021"
 authors = ["Nils Wrenger <[email protected]>"]
 description = "Cli input utilities."

Cargo.toml

@@ -65,21 +65,22 @@ The spinner function creates a console-based spinner animation, offering a visua
 
 ```rust
 use console_utils::{spinner, SpinnerType};
-
-// Display a standard spinner for 3 seconds
-spinner(3.0, SpinnerType::Standard);
-
-// Display a dots spinner for 2 seconds
-spinner(2.0, SpinnerType::Dots);
-
-// Display a custom spinner for 1 second (using custom frames)
-spinner(1.0, SpinnerType::Custom(vec!["1", "2", "3", "4", "3", "2"]));
-
-// Display a box spinner for 1.5 seconds
-spinner(1.5, SpinnerType::Box);
-
-// Display a flip spinner for 2 seconds
-spinner(2.0, SpinnerType::Flip);
+fn main() {
+    // Display a standard spinner for 3 seconds
+    spinner(3.0, SpinnerType::Standard);
+    
+    // Display a dots spinner for 2 seconds
+    spinner(2.0, SpinnerType::Dots);
+    
+    // Display a custom spinner for 1 second (using custom frames)
+    spinner(1.0, SpinnerType::Custom(vec!["1", "2", "3", "4", "3", "2"]));
+    
+    // Display a box spinner for 1.5 seconds
+    spinner(1.5, SpinnerType::Box);
+    
+    // Display a flip spinner for 2 seconds
+    spinner(2.0, SpinnerType::Flip);
+}
 ```
 
 ## Reveal Function
@@ -90,9 +91,27 @@ Displays a string gradually, revealing one character at a time with a specified
 
 ```rust
 use console_utils::reveal;
+fn main() {
+    // Display "Hello World!" with a time interval of 0.1 seconds between each character and a new line after it's finished.
+    reveal("Hello World!", 0.1);
+}
+```
+
+## Clear Line Function
+
+Clears the current line in the console.
 
-// Display "Hello World!" with a time interval of 0.1 seconds between each character and a new line after it's finished.
-reveal("Hello World!", 0.1);
+This function uses ANSI escape codes to clear the entire line and move the cursor to the
+beginning of the line.
+
+### Usage
+
+```rust
+use console_utils::clear_line;
+fn main() {
+    // Clear the current line
+    clear_line();
+}
 ```
 
 For more detailed documentation, please refer to the [generated Rust Docs](https://docs.rs/console-utils/latest/console_utils/).

README.md

@@ -211,6 +211,9 @@ impl SpinnerType {
 
 /// Displays a console-based spinner animation.
 ///
+/// A spinner is a visual indicator of a long-running process. It consists of a set of frames
+/// that are displayed sequentially to create the appearance of motion.
+///
 /// # Parameters
 ///
 /// - `time`: A floating-point number representing the duration of the spinner animation in seconds.
@@ -228,16 +231,13 @@ impl SpinnerType {
 /// spinner(2.0, SpinnerType::Custom(vec!["1", "2", "3", "4", "3", "2"]));
 /// ```
 pub fn spinner(mut time: f64, spinner_type: SpinnerType) {
-    let stdout = Term::buffered_stdout();
     let frames = spinner_type.to_frames();
     let mut i = 0;
 
     while time > 0.0 {
-        stdout.clear_line().unwrap();
-        stdout.write_line(frames[i]).unwrap();
-        stdout.move_cursor_up(1).unwrap();
-        stdout.move_cursor_right(frames[i].len()).unwrap();
-        stdout.flush().unwrap();
+        clear_line();
+        print!("{}", frames[i]);
+        io::stdout().flush().unwrap();
         thread::sleep(Duration::from_secs_f64(0.075));
         time -= 0.075;
         if i < frames.len() - 1 {
@@ -247,14 +247,30 @@ pub fn spinner(mut time: f64, spinner_type: SpinnerType) {
         }
     }
 
-    stdout.clear_line().unwrap();
-    stdout.flush().unwrap();
+    clear_line();
+}
+
+/// Clears the current line in the console.
+///
+/// This function uses ANSI escape codes to clear the entire line and move the cursor to the
+/// beginning of the line.
+///
+/// # Example
+///
+/// ```rust
+/// use console_utils::clear_line;
+///
+/// // Clear the current line
+/// clear_line();
+/// ```
+pub fn clear_line() {
+    print!("\r\x1b[2K");
+    io::stdout().flush().unwrap();
 }
 
-/// Reveal Function
+/// Reveals a string gradually, printing one character at a time with a specified time interval.
 ///
-/// Displays a string gradually, revealing one character at a time with a specified time interval
-/// between each character.
+/// This function is useful for creating a typing effect or slowly displaying information to the user.
 ///
 /// # Arguments
 ///

src/lib.rs

@@ -1,5 +1,11 @@
+use std::{
+    io::{self, Write},
+    thread,
+    time::Duration,
+};
+
 // Import the functions to be tested from the crate root
-use console_utils::{input, reveal, select, spinner, SpinnerType};
+use console_utils::{clear_line, input, reveal, select, spinner, SpinnerType};
 
 #[test]
 #[ignore]
@@ -37,5 +43,19 @@ fn test_spinner() {
 #[test]
 fn test_reveal() {
     // Give the fn the str and time.
-    reveal("Hello World!\n", 0.1);
+    reveal("Hello World!", 0.1);
+}
+
+#[test]
+fn test_clear() {
+    // Print Something.
+    print!("Hello World");
+    // Force update the terminal
+    io::stdout().flush().unwrap();
+
+    // wait
+    thread::sleep(Duration::from_secs_f64(1.0));
+
+    // Clear the current line.
+    clear_line();
 }