Skip to content

Commit 638ee23

Browse files
spectr(proposal): remove-vhs-echo-commands (#119)
Proposal for review: spectr/changes/remove-vhs-echo-commands/ Generated by: spectr pr proposal
1 parent 45b3c74 commit 638ee23

3 files changed

Lines changed: 57 additions & 0 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Remove VHS Echo Commands
2+
3+
## Summary
4+
Remove all unnecessary `Type "echo ..."` commands from VHS tape files in `assets/vhs/`. These typed echo lines add visual clutter and extend GIF duration without providing meaningful value - the actual spectr commands are self-explanatory.
5+
6+
## Motivation
7+
The current VHS tape files contain 16 typed echo commands across 5 files that:
8+
1. Add ~10+ seconds of typing animation to each GIF
9+
2. State the obvious (e.g., "=== Running validation ===" before running validation)
10+
3. Create visual noise that distracts from the actual spectr commands
11+
4. Make maintenance harder when updating demos
12+
13+
The demos should focus on showcasing spectr's actual commands and output, not on watching echo statements being typed.
14+
15+
## Scope
16+
- **In scope**: Remove all `Type "echo ..."` lines and their associated `Enter` and `Sleep` commands from all 5 VHS tape files
17+
- **Out of scope**: Comments (lines starting with `#`) which serve as documentation within the tape files
18+
19+
## Files Affected
20+
- `assets/vhs/archive.tape` - 4 echo commands
21+
- `assets/vhs/init.tape` - 2 echo commands
22+
- `assets/vhs/list.tape` - 3 echo commands
23+
- `assets/vhs/partial-match.tape` - 4 echo commands
24+
- `assets/vhs/validate.tape` - 3 echo commands
25+
26+
## Expected Outcome
27+
Cleaner, faster demo GIFs that focus on spectr functionality without redundant section headers being typed out.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Documentation Specification (Delta)
2+
3+
## MODIFIED Requirements
4+
5+
### Requirement: VHS Tape Output Clarity
6+
7+
VHS tape files SHALL NOT contain typed echo statements that display section headers or commentary. Demos SHALL let the spectr commands and their output speak for themselves. Comments within the tape file (lines starting with `#`) SHOULD be used to document sections for maintainers, but these are not displayed in the recording.
8+
9+
#### Scenario: No typed echo section headers
10+
- **WHEN** a VHS tape file is reviewed
11+
- **THEN** it SHALL contain no `Type "echo ..."` commands for section headers
12+
- **AND** visual context SHALL be provided through VHS comments (starting with `#`) which are not recorded
13+
14+
#### Scenario: No useless echo statements
15+
- **WHEN** a VHS tape file is reviewed
16+
- **THEN** it SHALL contain no `Type "echo ''"` commands
17+
- **AND** visual spacing SHALL be achieved through `Sleep` commands only
18+
19+
#### Scenario: Commands are self-documenting
20+
- **WHEN** a user views a demo GIF
21+
- **THEN** they SHALL see only the actual spectr commands being typed
22+
- **AND** they SHALL NOT see preparatory echo statements being typed out
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Tasks
2+
3+
- [x] Remove echo commands from archive.tape (4 occurrences)
4+
- [x] Remove echo commands from init.tape (2 occurrences)
5+
- [x] Remove echo commands from list.tape (3 occurrences)
6+
- [x] Remove echo commands from partial-match.tape (4 occurrences)
7+
- [x] Remove echo commands from validate.tape (3 occurrences)
8+
- [x] Regenerate all GIFs using vhs to verify changes work correctly

0 commit comments

Comments
 (0)