added turbo command

Author: vim-zz

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "swordfish-rs"
-version = "0.4.0"
+version = "0.5.0"
 edition = "2021"
 license-file = "LICENSE"
 description = "Cli tool for typing effect in Termainl for screencasts"

Cargo.toml

@@ -18,6 +18,7 @@ Example `screenplay.yaml` file:
 
 ```yaml
 - !clear
+# - !turbo {by: 3}
 - !write {msec: 0, color: green, text:  "$ "}
 - !write {msec: 20, text:    "i am going to list this dir"}
 - !wait {msec: 1000}
@@ -58,16 +59,10 @@ swordfish path/to/file.yaml
 
 The following commands are available, written with `!` before the command name, for example `!clear`.
 
-#### `write` 
+#### `clear` 
 
-Write text to the terminal.
+Clear screen command.
 
-| Argument | Type | Description |
-| - | - | - |
-|`text`| String | the text to type in the terminal, each character will be entered one by one with some delay |
-|`msec`| Integer | delay between typed chars in millisecs |
-|`color` (optional)| String | text's color: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white` or a brighter variant, for example `bright_red` |
-    
 #### `erase` 
 
 Erase characters to the left.
@@ -90,15 +85,9 @@ Execute shell commands or other applications and show their output.
 
 The output is presented, while the executed command itself will not show.
 
-#### `wait` 
-
-| Argument | Type | Description |
-| - | - | - |
-|`msec`| Integer |  delay before next command in millisecs |
-
-#### `clear` 
+#### `new_line` 
 
-Clear screen command.
+Simulate user's `ENTER`.
 
 #### `pause` 
 
@@ -113,6 +102,26 @@ Prompt specify a constant text that is shown after every `execute` and cis not a
 |`text`| String | the prompt text |
 |`color` (optional)| String | text's color: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white` or a brighter variant, for example `bright_red` |
 
-#### `new_line` 
+#### `turbo` 
 
-Simulate user's `ENTER`.
+Speed everything, useful when iterating over the screenplay.
+
+| Argument | Type | Description |
+| - | - | - |
+|`by`| Integer | Speed everything by this factor |
+    
+#### `wait` 
+
+| Argument | Type | Description |
+| - | - | - |
+|`msec`| Integer |  delay before next command in millisecs |
+
+#### `write` 
+
+Write text to the terminal.
+
+| Argument | Type | Description |
+| - | - | - |
+|`text`| String | the text to type in the terminal, each character will be entered one by one with some delay |
+|`msec`| Integer | delay between typed chars in millisecs |
+|`color` (optional)| String | text's color: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white` or a brighter variant, for example `bright_red` |

README.md

@@ -1,4 +1,5 @@
 - !clear
+# - !turbo {by: 10}
 - !prompt {text: "$", color: green}
 - !write {msec: 20, text:    "i am going to list this dir"}
 - !new_line

examples/screenplay.yaml

@@ -11,4 +11,5 @@ pub enum Command<'a> {
     Prompt {text: &'a str, color: Option<&'a str>},
     Wait {msec: u32},
     Write {msec: u32, color: Option<&'a str>, text: &'a str},
+    Turbo {by: u32},
 }

src/commands.rs

@@ -12,17 +12,18 @@ pub fn from_yaml(data: &str) -> Result<Vec<Command>> {
     Ok(yaml)
 }
 
-const DELAY_AFTER_EXECUTE: u64 = 250;
+const DELAY_AFTER_EXECUTE: u32 = 250;
 
 pub fn execute(commands: Vec<Command>) -> Result<()> {
     let mut prompt = None;
     let mut cursor = 0;
+    let mut speed_factor = 1;
 
     for cmd in commands {
         match cmd {
             Command::Write {msec, text, color} => {
                 for c in text.chars() { 
-                    thread::sleep(time::Duration::from_millis(msec.into()));
+                    delay(msec, speed_factor);
                     print!("{}", terminal::colorful(&c.to_string(), color));
                     stdout().flush()?;
                 }
@@ -39,7 +40,7 @@ pub fn execute(commands: Vec<Command>) -> Result<()> {
                 // Remove the deletions up till the cursor
                 let deletions = cmp::min(deletions, cursor);
                 cursor -= deletions;
-                erase(deletions, msec)?;
+                erase(deletions, msec, speed_factor)?;
             },
             Command::Execute {line} => {
                 println!("");
@@ -48,12 +49,12 @@ pub fn execute(commands: Vec<Command>) -> Result<()> {
                 if let Some((cmd, args)) = words.split_first() {
                     process::Command::new(cmd).args(args).spawn()?;
                 }
-                thread::sleep(time::Duration::from_millis(DELAY_AFTER_EXECUTE));
+                delay(DELAY_AFTER_EXECUTE, speed_factor);
                 show_prompt(&prompt)?;
                 cursor = 0;
             },
             Command::Wait {msec} => {
-                thread::sleep(time::Duration::from_millis(msec.into()));
+                delay(msec, speed_factor);
             },
             Command::Pause => {
                 let mut answer = String::new();
@@ -74,7 +75,10 @@ pub fn execute(commands: Vec<Command>) -> Result<()> {
                 print!("\n");
                 show_prompt(&prompt)?;
                 cursor = 0;
-            }
+            },
+            Command::Turbo {by} => {
+                speed_factor = by;
+            },
         }
     }
 
@@ -90,11 +94,16 @@ fn show_prompt(prompt: &Option<String>) -> Result<()> {
     Ok(())
 }
 
-fn erase(amount: usize, msec: u32) -> Result<()> {
+fn erase(amount: usize, msec: u32, speed_factor: u32) -> Result<()> {
     for _ in 0..amount { 
-        thread::sleep(time::Duration::from_millis(msec.into()));
+        delay(msec, speed_factor);
         print!("{} {}", BACKSPACE, BACKSPACE);
         stdout().flush()?;
     }
     Ok(())
-}
+}
+
+fn delay(msec: u32, speed_factor: u32) {
+    let t = msec / speed_factor;
+    thread::sleep(time::Duration::from_millis(t.into()));
+}