Skip to content

Commit 6d7b018

Browse files
committed
docs(tmux-parity[plugin]): use console fences with $ prefix per AGENTS.md
why: AGENTS.md "Shell Command Formatting" requires command examples in docs to use ```console with a "$ " prefix (not ```bash) and to keep one command per code block so the prompt is unambiguous and copy-pastable. The plugin docs added in this branch had multi-command ```bash blocks scattered across .claude/commands and skills/tmux-parity references. what: - .claude/agents/parity-analyzer.md: 3 blocks → console+$. - .claude/commands/version-diff.md: 2 blocks → console+$. - .claude/commands/implement-command.md: split the 6-command verification block into 6 console+$ blocks. - skills/tmux-parity/references/tmux-command-table.md: 2 blocks → console+$ (one of which had two ls invocations — split per AGENTS.md "one command per block").
1 parent 15b971f commit 6d7b018

4 files changed

Lines changed: 47 additions & 30 deletions

File tree

.claude/agents/parity-analyzer.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,22 +52,27 @@ You are a tmux/libtmux feature parity analysis specialist. Analyze the gap betwe
5252
### Step 1: Extract tmux commands
5353

5454
Run the extraction script for current data:
55-
```bash
56-
bash .claude-plugin/scripts/extract-tmux-commands.sh ~/study/c/tmux
55+
56+
```console
57+
$ bash .claude-plugin/scripts/extract-tmux-commands.sh ~/study/c/tmux
5758
```
58-
This outputs `command|alias|getopt|target` for all ~88 tmux commands.
59+
60+
This outputs `command|alias|getopt|target` for every tmux command.
5961

6062
### Step 2: Extract libtmux coverage
6163

6264
Run the libtmux extraction:
63-
```bash
64-
bash .claude-plugin/scripts/extract-libtmux-methods.sh
65+
66+
```console
67+
$ bash .claude-plugin/scripts/extract-libtmux-methods.sh
6568
```
69+
6670
This outputs the unique tmux command strings that libtmux invokes.
6771

6872
Additionally, check mixin files for commands invoked via `tmux_cmd()`:
69-
```bash
70-
grep -rn '"set-environment"\|"show-environment"\|"set-hook"\|"set-option"\|"show-option"\|"capture-pane"\|"move-window"\|"select-layout"\|"kill-pane"' src/libtmux/*.py | grep -oP '"([a-z]+-[a-z-]+)"' | sort -u | tr -d '"'
73+
74+
```console
75+
$ grep -rn '"set-environment"\|"show-environment"\|"set-hook"\|"set-option"\|"show-option"\|"capture-pane"\|"move-window"\|"select-layout"\|"kill-pane"' src/libtmux/*.py | grep -oP '"([a-z]+-[a-z-]+)"' | sort -u | tr -d '"'
7176
```
7277

7378
### Step 3: Cross-reference

.claude/commands/implement-command.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -104,24 +104,28 @@ Add tests in `tests/test_{class}.py` (or a new file if warranted):
104104

105105
Run the full verification workflow:
106106

107-
```bash
108-
# Format
109-
uv run ruff format .
107+
```console
108+
$ uv run ruff format .
109+
```
110110

111-
# Lint
112-
uv run ruff check . --fix --show-fixes
111+
```console
112+
$ uv run ruff check . --fix --show-fixes
113+
```
113114

114-
# Type check
115-
uv run mypy src tests
115+
```console
116+
$ uv run mypy src tests
117+
```
116118

117-
# Test the specific file
118-
uv run pytest tests/test_{class}.py -x -v
119+
```console
120+
$ uv run pytest tests/test_{class}.py -x -v
121+
```
119122

120-
# Run doctests
121-
uv run pytest --doctest-modules src/libtmux/{class}.py -v
123+
```console
124+
$ uv run pytest --doctest-modules src/libtmux/{class}.py -v
125+
```
122126

123-
# Full test suite
124-
uv run pytest
127+
```console
128+
$ uv run pytest
125129
```
126130

127131
All must pass before considering the implementation complete.

.claude/commands/version-diff.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,19 @@ Compare tmux features between two versions using the source worktrees at `~/stud
1717
Extract `version1`, `version2`, and optional `command-name` from `$ARGUMENTS`.
1818

1919
If no arguments provided, list available versions:
20-
```bash
21-
ls -d ~/study/c/tmux-*/ | sed 's|.*/tmux-||;s|/$||' | sort -V
20+
21+
```console
22+
$ ls -d ~/study/c/tmux-*/ | sed 's|.*/tmux-||;s|/$||' | sort -V
2223
```
24+
2325
Then ask the user which two versions to compare.
2426

2527
## Validate Worktrees
2628

2729
Verify both worktrees exist:
28-
```bash
29-
ls -d ~/study/c/tmux-{version1}/ ~/study/c/tmux-{version2}/ 2>/dev/null
30+
31+
```console
32+
$ ls -d ~/study/c/tmux-{version1}/ ~/study/c/tmux-{version2}/ 2>/dev/null
3033
```
3134

3235
## Single Command Comparison (when command-name given)

skills/tmux-parity/references/tmux-command-table.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,18 @@ Compare against libtmux: `src/libtmux/formats.py`
8989
- 2.0 through 2.9, 2.9a
9090
- 3.0, 3.0a, 3.1 through 3.1c, 3.2, 3.2a, 3.3, 3.3a, 3.4, 3.5, 3.5a, 3.6, 3.6a
9191

92-
To check if a command exists in a version:
93-
```bash
94-
ls ~/study/c/tmux-3.0/cmd-display-popup.c 2>/dev/null # Not found = added later
95-
ls ~/study/c/tmux-3.3/cmd-display-popup.c 2>/dev/null # Found = exists in 3.3
92+
To check if a command exists in a version (not-found = added later):
93+
94+
```console
95+
$ ls ~/study/c/tmux-3.0/cmd-display-popup.c 2>/dev/null
96+
```
97+
98+
```console
99+
$ ls ~/study/c/tmux-3.3/cmd-display-popup.c 2>/dev/null
96100
```
97101

98102
To diff a command across versions:
99-
```bash
100-
diff ~/study/c/tmux-3.0/cmd-send-keys.c ~/study/c/tmux-3.6a/cmd-send-keys.c
103+
104+
```console
105+
$ diff ~/study/c/tmux-3.0/cmd-send-keys.c ~/study/c/tmux-3.6a/cmd-send-keys.c
101106
```

0 commit comments

Comments
 (0)