diff --git a/Makefile b/Makefile index 657cf7e3f61d..4227e98faa0d 100644 --- a/Makefile +++ b/Makefile @@ -85,18 +85,8 @@ hyperfine: $(BINARY): FORCE go build -o $@ ./cmd/golangci-lint -# TODO: migrate to docs/ -tools/svg-term: tools/package.json tools/package-lock.json - cd tools && npm ci - ln -sf node_modules/.bin/svg-term $@ - -# TODO: migrate to docs/ -tools/Dracula.itermcolors: - curl -fL -o $@ https://raw.githubusercontent.com/dracula/iterm/master/Dracula.itermcolors - -# TODO: migrate to docs/ -assets/demo.svg: tools/svg-term tools/Dracula.itermcolors - ./tools/svg-term --cast=183662 --out assets/demo.svg --window --width 110 --height 30 --from 2000 --to 20000 --profile ./tools/Dracula.itermcolors --term iterm2 +docs/static/demo.gif: FORCE + vhs docs/golangci-lint.tape assets/github-action-config.json: FORCE $(BINARY) # go run ./scripts/gen_github_action_config/main.go $@ diff --git a/docs/golangci-lint.tape b/docs/golangci-lint.tape new file mode 100644 index 000000000000..4ba51aaf6d4c --- /dev/null +++ b/docs/golangci-lint.tape @@ -0,0 +1,86 @@ +Output docs/static/demo.gif + +# NOTE: it should be run at the root of the repository. +# vhs docs/golangci-lint.tape + +Require golangci-lint + +Set Shell zsh + +Set Theme Dracula +Set FontSize 25 +Set Width 2000 +Set Height 900 + +Set WindowBar Colorful +Set WindowBarSize 50 + +Set Padding 20 + +Set MarginFill "#17afc2" +Set Margin 20 + +Set BorderRadius 30 + +Type "golangci-lint run" Sleep 500ms Enter +Sleep 2s +Sleep 1s + + +# VHS documentation +# https://github.com/charmbracelet/vhs +# +# Output: +# Output .gif Create a GIF output at the given +# Output .mp4 Create an MP4 output at the given +# Output .webm Create a WebM output at the given +# +# Require: +# Require Ensure a program is on the $PATH to proceed +# +# Settings: +# Set FontSize Set the font size of the terminal +# Set FontFamily Set the font family of the terminal +# Set Height Set the height of the terminal +# Set Width Set the width of the terminal +# Set LetterSpacing Set the font letter spacing (tracking) +# Set LineHeight Set the font line height +# Set LoopOffset % Set the starting frame offset for the GIF loop +# Set Theme Set the theme of the terminal +# Set Padding Set the padding of the terminal +# Set Framerate Set the framerate of the recording +# Set PlaybackSpeed Set the playback speed of the recording +# Set MarginFill Set the file or color the margin will be filled with. +# Set Margin Set the size of the margin. Has no effect if MarginFill isn't set. +# Set BorderRadius Set terminal border radius, in pixels. +# Set WindowBar Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight) +# Set WindowBarSize Set window bar size, in pixels. Default is 40. +# Set TypingSpeed