refactor/Hide-Show

[elmarsan]

This pull request adds two new commands, Pause and Resume.

All commands between Pause and Resume will be executed but not include into the output gif.
In order to achieve this behavior I did the following:

• Create new terminal in 'hidden mode', every time Pause command is executed, all the commands will be processed into new instance of ttyd.
• Encapsulate Page, browser, textCanvas, cursorCanvas, tty and close VHS fields into new Terminal struct.
• VHS now has currentTerm, mainTerm and hiddenTerm which are pointers to Terminal instances.
  • mainTerm: Styling is only applied to this instance.
  • hiddenTerm: Simple ttyd terminal with the default configuration.
  • currentTerm: It's a mirror of mainTerm when execution is not pause and mirror of hiddenTerm when execution is paused.

Demo

Output pause-resume.gif

Pause

Type "mkdir folder"
Enter

Resume

Type "echo 'See secret folder'"
Sleep 1s
Enter

Type "ls | grep folder"
Sleep 1s
Enter

Sleep 2.5s

Output

Closes #130

[elmarsan]

Hey, I'm having issues with the workflow. The tests are running fine on my local machine, but I suspect there might be a problem related to ttyd.

After reviewing the code, I noticed that I'm the first one using the New() method in the tests. This could be the root of the issues because the CI might not be ready for that yet."

[maaslalani]

What are your opinions on making this the behaviour of Hide / Show instead of introducing new keywords Pause / Resume?

I think this type of behaviour fits quite well with Hide / Show IMO. Since you are essentially performing hidden commands (on a different terminal).

[elmarsan]

@maaslalani I'm complete agree with that!

If we add these new commands, users will probably get confused. And could be hard to explain the difference in the documentation between Hide/Show and Pause/Resume.
Moreover I'm not sure if users find useful the current behavior of Hide and Show. It's weird to see how frames stack up and pop out all at once in the GIF after Show command.

But yes, I would just move this logic to Hide/Show

[elmarsan]

Hey @maaslalani

I've removed Pause & Resume commands. Now the behavior is on Hide & Show. I've also rename the pull request because we're not adding new commands.
As far as I can tell, everything is working as expected. Could you give it a look, please?

[elmarsan]

@maaslalani conflicts solved

[maaslalani]

Thanks so much @elmarsan, I'm excited for this one.

[elmarsan]

@maaslalani is everything ok?

[helpermethod]

What has happened to this PR? It would make VHS infinitely more useful!

[maaslalani]

Hey! Sorry about forgetting about this PR, I will take a look since it is a great feature that I think would make VHS more useful!

[elmarsan]

@maaslalani let me know if you need any help.

[patniemeyer]

What are your opinions on making this the behaviour of Hide / Show instead of introducing new keywords Pause / Resume?

I think this type of behaviour fits quite well with Hide / Show IMO. Since you are essentially performing hidden commands (on a different terminal).

I agree that this should be the default behavior of Hide / Show. As a new user I was very confused when "Hide" did not actually seem to hide anything. Breaking changes are always hard, but it won't get any easier later :)

Maybe rename the old functionality to "fast forward" "start/stop"? :)

[osterman]

@maaslalani would love to see this feature! It's very hard to set up the demo environment before recording, since any rc files are disabled (otherwise this would be a great alternative). The current behavior, showing all the pre-set up commands, detracts from the demo itself (using hacks like Ctrl+L still cause a flicker). Also, when wanting to record demos of specifically one aspect of a tool, all the steps to get to that part are irrelevant. I've resorted to using tools like ffmpeg to cut off the first part of the recording, but it's not ideal.