Hide is not working

[MarvinJWendt]

I just noticed that Hide is not working on my machine using docker. The README looks like it too:

The animation of the command "typing" is not there, but the command itself is. This makes it hard to use for setup, as the whole setup process is visible to the user.

[maaslalani]

The hide command will hide frames from being recorded not the actual content of what is being typed. That is why the README shows that the command is already typed and you do not see the typing in the GIF but the typing does occur on the terminal.

[MarvinJWendt]

Oh okay, got it! Is there any way to hide the full setup? Using the docker env I have to install some packages as they are not already in alpine (like curl), but I'd like to hide them from the user.

[maaslalani]

Yep, do the Hide and all the typing and then clear the screen (by typing "clear" and Enter)

[MarvinJWendt]

Okay this seems to (kinda) work! The first few frames are still showing the output of apk add curl, but I think this will eventually be handled by #39 ?

[maaslalani]

Okay this seems to (kinda) work! The first few frames are still showing the output of apk add curl, but I think this will eventually be handled by #39 ?

Yes we'll definitely sort out the frames issue but to prevent it for now I think you can sleep for a little but after you've cleared the screen (but before the show)

[maaslalani]

But yes soon we'll have it so theres not extra frames cutting in. That is definitely a bug!

[MarvinJWendt]

[...] I think you can sleep for a little but after you've cleared the screen (but before the show)

Works like a charm^bracelet 😉

[MarvinJWendt]

Just out of interest, why does Hide not hide the full command? IMO it's not actually "hiding" the stuff between Hide and Show, and for me it's not very obvious that Hide just disables the typing animation. Maybe a flag like Hide@animations and/or Hide@all would do the trick?

This could probably be expanded to Hide@cursor, Hide@colors, Hide@stderr and stuff like that.

[maaslalani]

Oh interesting, that is a very good idea and would be quite useful, IMO. I generally agree that it is a little confusing what Hide does and maybe needs a bit more documentation or a rename.

Maybe Skip is a better name? And its counter part is Resume/Continue/Play?

[MarvinJWendt]

Maybe Skip is a better name? And its counter part is Resume/Continue/Play?

I'll leave the naming up to you, as I always struggle with it in my own projects 😆

Just another thing I noticed is, that with the clear command solution, it's currently not possible to hide steps between steps that should be visible. For example, my project is an automated installer, and to showcase it, the terminal needs to be reopened (because the $PATH changed). To simulate that, I source .profile after the installer runs, but before the installed program is called. Now I want to hide the source .profile in the middle.

This would also be handled then :)

[griimick]

Oh interesting, that is a very good idea and would be quite useful, IMO. I generally agree that it is a little confusing what Hide does and maybe needs a bit more documentation or a rename.

Maybe Skip is a better name? And its counter part is Resume/Continue/Play?

I too had trouble understanding it initially. Pause/Resume recording sounds better to me.

[normanr]

Pause and Resume will probably be the least confusing. Interestingly they behave very similar to Xoff(^S) and Xon(^Q).

(Also for what it's worth: compressed video players have to do something similar when doing a seek to a frame between two keyframes: they have to pause the video decoder's output, send it the previous keyframe, followed by all frames up to the frame it wants to show, then re-enable output and only then send it the frame it wants to display)