new_line command

Author: vim-zz

Cargo.lock

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

Cargo.toml

@@ -110,3 +110,7 @@ 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` 
+
+Simulate user's `ENTER`.

README.md

@@ -1,6 +1,7 @@
 - !clear
 - !prompt {text: "$", color: green}
 - !write {msec: 20, text:    "i am going to list this dir"}
+- !new_line
 - !wait {msec: 1000}
 - !erase {msec: 20, amount: 100}
 - !wait {msec: 1000}

examples/screenplay.yaml

@@ -3,11 +3,12 @@ use serde::{Deserialize};
 #[derive(Debug, Deserialize)]
 #[serde(rename_all = "snake_case")]
 pub enum Command<'a> {
-    Write {msec: u32, color: Option<&'a str>, text: &'a str},
+    Clear,
     Erase {msec: u32, by_chars: Option<&'a str>, amount: Option<u32>},
     Execute {line: &'a str},
-    Wait {msec: u32},
-    Clear,
+    NewLine,
     Pause,
-    Prompt {text: &'a str, color: Option<&'a str>}
+    Prompt {text: &'a str, color: Option<&'a str>},
+    Wait {msec: u32},
+    Write {msec: u32, color: Option<&'a str>, text: &'a str},
 }

src/commands.rs

@@ -70,6 +70,11 @@ pub fn execute(commands: Vec<Command>) -> Result<()> {
                 show_prompt(&prompt)?;
                 cursor = 0;
             },
+            Command::NewLine => {
+                print!("\n");
+                show_prompt(&prompt)?;
+                cursor = 0;
+            }
         }
     }
 

src/lib.rs

@@ -1,22 +1,24 @@
 use swordfishlib;
 
 #[test]
-fn it_adds_two() {
+fn play_commands() {
     let screenplay = r###"
     - !clear
-    - !write {msec: 0, color: green, text:  "$ "}
+    - !prompt {color: green, text:  "$"}
+    - !write {msec: 0, color: blue, text:  "$ "}
     - !write {msec: 0, text:    "i am going to list this dir"}
     - !wait {msec: 0}
-    - !erase {msec: 0, by_chars: xxxxxxxxxxxxxxxxxxxxxxxxxxx }
+    - !erase {msec: 0, by_chars: xxxxxxxxxxxxxxxxxxxxxxxxxxx, amount: 5 }
     - !wait {msec: 0}
     - !write {msec: 0, text: "echo swordfish"}
     - !wait {msec: 0}
     - !execute {line: echo swordfish}
     - !wait {msec: 0}
-    - !write {msec: 0, color: green, text:  "$ "}
+    - !new_line
     - !write {msec: 0, text: "bye, press any key..."}
     "###;
 
     let commands = swordfishlib::from_yaml(&screenplay).unwrap();
+    assert_eq!(commands.len(), 13);
     swordfishlib::execute(commands).unwrap();
 }