doc: add init gif

Signed-off-by: Brian McGee <[email protected]>
numtide · May 3, 2024 · b01ea77 · b01ea77
1 parent 166a919
commit b01ea77
Show file tree

Hide file tree

Showing 8 changed files with 79 additions and 48 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -6,7 +6,7 @@ hero:
     name: "Treefmt"
     text: "One CLI to format your repo"
     image:
-        src: /fmt.gif
+        src: /treefmt.gif
         alt: Treefmt
     actions:
         - theme: brand

diff --git a/docs/public/fmt.gif b/docs/public/fmt.gif
diff --git a/docs/public/init.gif b/docs/public/init.gif
diff --git a/docs/public/treefmt.gif b/docs/public/treefmt.gif
diff --git a/docs/vhs/fmt.tape b/docs/vhs/fmt.tape
diff --git a/docs/vhs/init.tape b/docs/vhs/init.tape
@@ -0,0 +1,29 @@
+Require treefmt
+Require nano
+
+Set Shell zsh
+Set FontSize 14
+
+Set Theme "Catppuccin Mocha"
+
+Set Width 720
+Set Height 360
+Set Padding 20
+
+Hide
+Type "TEMP_DIR=$(mktemp -d) && cd $TEMP_DIR && clear"
+Enter
+
+Show
+Type "treefmt --init"
+Enter
+Sleep 2s
+
+Type "nano treefmt.toml"
+Enter
+Sleep 5s
+
+Ctrl+x
+
+Hide
+Type "cd && rm -rf $TEMP_DIR"
diff --git a/docs/vhs/treefmt.tape b/docs/vhs/treefmt.tape
@@ -0,0 +1,36 @@
+Require rsync
+Require treefmt
+
+Set Shell zsh
+Set FontSize 11
+
+Set Theme "Catppuccin Mocha"
+
+Set Width 320
+Set Height 220
+Set Padding 20
+
+Hide
+Type "TEMP_DIR=$(mktemp -d) && rsync -av $PRJ_ROOT/test/examples/ $TEMP_DIR && cd $TEMP_DIR && clear"
+Enter
+Type "alias treefmt='treefmt --allow-missing-formatter' && clear"
+Enter
+Show
+
+Type "treefmt -c"
+Sleep 1s
+Enter
+
+Sleep 3s
+Enter
+Enter
+Sleep 1s
+
+Type "treefmt"
+Enter
+
+Sleep 5s
+
+Hide
+Type "cd && rm -rf $TEMP_DIR"
+Enter
diff --git a/nix/docs.nix b/nix/docs.nix
@@ -51,30 +51,20 @@ _: {
         }
         {
           inherit category;
-          package = pkgs.vhs;
+          name = "vhs";
           help = "generate terminal gifs";
-        }
-        {
-          category = "docs";
-          help = "regenerate gifs for docs";
-          package = let
-            treefmt = pkgs.writeShellApplication {
-              name = "treefmt";
-              runtimeInputs = [self'.packages.treefmt] ++ (import ./formatters.nix pkgs);
-              text = ''
-                treefmt -C "$PRJ_ROOT/test/examples" --allow-missing-formatter "$@"
-              '';
-            };
-          in
-            pkgs.writeShellApplication {
-              name = "gifs";
-              runtimeInputs = [treefmt];
-              text = ''
-                for tape in "$PRJ_ROOT"/docs/vhs/*; do
-                  vhs "$tape" -o "$PRJ_ROOT/docs/public/$(basename "$tape" .tape).gif"
-                done
-              '';
-            };
+
+          package = pkgs.writeShellApplication {
+            name = "gif";
+            runtimeInputs =
+              [
+                self'.packages.treefmt
+                pkgs.rsync
+                pkgs.vhs
+              ]
+              ++ (import ./formatters.nix pkgs);
+            text = ''vhs "$@"'';
+          };
         }
       ];
     };