demo generation

Author: TylerJang27

.gitignore

@@ -1,3 +1,5 @@
+screenshots
+
 # Logs
 logs
 *.log

.trunk/trunk.yaml

@@ -53,15 +53,16 @@ lint:
         # - todo-grep-linter
         - todo-grep-wrapped
       paths:
-        - plugin.yaml
-        - todo_grep.sh
-        - .trunk/trunk.yaml
-        - README.md
         - cspell.yaml
         - .codespellrc
-        - todo_dict.txt
-        - .vale.ini
-        - styles/**
+        - generate_demo.sh
+        - .markdownlint.json
+        - plugin.yaml
+        - README.md
         - .semgrep.yaml
+        - styles/**
+        - todo_dict.txt
+        - todo_grep.sh
         - toolbox.toml
-        - .markdownlint.json
+        - .trunk/trunk.yaml
+        - .vale.ini

README.md

@@ -39,7 +39,7 @@ trunk check --filter=markdownlint test_data.md
 To run outside Trunk, run:
 
 ```bash
-.trunk/tools/markdownlint test_data.md
+.trunk/tools/markdownlint -r markdownlint-rule-search-replace test_data.md
 ```
 
 ## CSpell

generate_demo.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+set -euo pipefail
+
+function freeze_linter() {
+	freeze --theme=dracula -o "${2}" --execute "bash -c 'echo $ ${1}; ${1} || true'"
+}
+
+function freeze_trunk() {
+	freeze --theme=dracula -o "${2/tb/trunk}" --execute "bash -c '${1} --no-progress --show-existing'"
+}
+
+mkdir -p screenshots
+
+# Requires a pre-release version of Trunk
+tb=../trunk/bazel-bin/trunk/cli/cli
+freeze_trunk "${tb} check --filter=markdownlint test_data.md" "screenshots/markdownlint_trunk.png"
+freeze_linter ".trunk/tools/markdownlint -r markdownlint-rule-search-replace test_data.md" "screenshots/markdownlint.png"
+
+freeze_trunk "trunk check --filter=cspell test_data.md" "screenshots/cspell_trunk.png"
+freeze_linter ".trunk/tools/cspell --no-summary test_data.md" "screenshots/cspell.png"
+
+freeze_trunk "trunk check --filter=codespell test_data.md" "screenshots/codespell_trunk.png"
+freeze_linter ".trunk/tools/codespell test_data.md" "screenshots/codespell.png"
+
+freeze_trunk "trunk check --filter=vale test_data.md" "screenshots/vale_trunk.png"
+freeze_linter ".trunk/tools/vale --output=line test_data.md" "screenshots/vale.png"
+
+freeze_trunk "trunk check --filter=semgrep test_data.md" "screenshots/semgrep_trunk.png"
+freeze_linter ".trunk/tools/semgrep --config=auto --config=.semgrep.yaml -q --include=test_data.md" "screenshots/semgrep.png"
+
+freeze_trunk "trunk check --filter=trunk-toolbox test_data.md" "screenshots/toolbox_trunk.png"
+freeze_linter ".trunk/tools/trunk-toolbox --output-format=text test_data.md" "screenshots/toolbox.png"
+
+freeze_trunk "trunk check --filter=todo-grep-wrapped test_data.md" "screenshots/grep_trunk.png"
+freeze_linter "./todo_grep.sh test_data.md" "screenshots/grep.png"