Skip to content

docs: add validator demo GIF to README #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SmailG merged 1 commit into from
Nov 10, 2026
Merged

docs: add validator demo GIF to README #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ git clone https://github.com/SmailG/plc-programming.git .agents/plugins/plc-prog

## The validator

![Demo: the validator catches a missing END_IF in a Structured Text function block; an AI edit, shown as a diff, adds END_IF, and the validator passes](docs/assets/plc-demo.gif)

```bash
python3 scripts/plc_validate.py <files-or-dirs> [--format FMT] [--xsd schema.xsd] [--json] [--strict]
```
Expand Down
Binary file added docs/assets/plc-demo.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions docs/assets/plc-demo.tape
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Validator demo for the README (recorded against v0.2.0 with vhs 0.12.1).
# Re-record: from an empty directory that holds a clone of this repository at ./plc-programming,
# run `vhs plc-programming/docs/assets/plc-demo.tape`. It writes plc-demo.gif to the current directory.
# The hidden setup writes the buggy and the fixed pump.st. The "AI edit" step is scripted:
# the fixed file is copied in off-screen and the diff shows the change. Both validator runs are real.
Output plc-demo.gif

Set Shell "bash"
Set FontFamily "DejaVu Sans Mono"
Set FontSize 13
Set Width 800
Set Height 480
Set Padding 14
Set Theme "Dracula"
Set TypingSpeed 35ms
Set WindowBar Colorful
Set CursorBlink false

Hide
Type `export PS1='$ ' PROMPT_COMMAND= HISTFILE=/dev/null; printf '%b' 'FUNCTION_BLOCK FB_Pump\nVAR_INPUT\n LevelHigh : BOOL;\n LevelLow : BOOL;\nEND_VAR\nVAR_OUTPUT\n PumpOn : BOOL;\nEND_VAR\n\nIF LevelLow THEN\n PumpOn := TRUE;\nELSIF LevelHigh THEN\n PumpOn := FALSE;\n\nEND_FUNCTION_BLOCK\n' > pump.st.buggy; printf '%b' 'FUNCTION_BLOCK FB_Pump\nVAR_INPUT\n LevelHigh : BOOL;\n LevelLow : BOOL;\nEND_VAR\nVAR_OUTPUT\n PumpOn : BOOL;\nEND_VAR\n\nIF LevelLow THEN\n PumpOn := TRUE;\nELSIF LevelHigh THEN\n PumpOn := FALSE;\nEND_IF;\n\nEND_FUNCTION_BLOCK\n' > pump.st.fixed; mkdir -p before && cp pump.st.buggy pump.st && cp pump.st before/pump.st && touch -d '2026-11-10 09:00' pump.st before/pump.st && clear`
Enter
Sleep 500ms
Show

Type "cat -n pump.st"
Sleep 300ms
Enter
Sleep 3.5s

Type "python3 plc-programming/scripts/plc_validate.py pump.st"
Sleep 300ms
Enter
Sleep 4s

# Scripted AI edit: the fixed file is copied in off-screen; the diff below shows exactly what changed.
Hide
Type "cp pump.st.fixed pump.st && touch -d '2026-11-10 09:01' pump.st && clear"
Enter
Sleep 300ms
Show

Type "# AI edit (Claude Code + plc-programming): close the IF block"
Sleep 400ms
Enter
Sleep 800ms

Type "diff -u --color=always before/pump.st pump.st"
Sleep 300ms
Enter
Sleep 4s

Type "python3 plc-programming/scripts/plc_validate.py pump.st"
Sleep 300ms
Enter
Sleep 4.5s