Skip to content

Commit 6c36ee2

Browse files
committed
fix(docs): Correct parity docs from verification pass
- Remove duplicate 'Attach on create' row in comparison table, keep corrected version with '(default: true)' near socket_path - Annotate pre_tab as (deprecated) in comparison table - Annotate startup_window as accepting name or index - Fix pre_tab description: deprecated predecessor, not alias (it was renamed in tmuxinator, not aliased) - Clarify startup_window renders as "#{name}:#{value}"
1 parent b76fc7d commit 6c36ee2

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/comparison.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ teamocil parses YAML into `Session`/`Window`/`Pane` objects, each producing `Com
5353
| Windows list | `windows` | `windows` / `tabs` | `windows` |
5454
| Socket name | (CLI `-L`) | `socket_name` | (none) |
5555
| Socket path | (CLI `-S`) | `socket_path` | (none) |
56+
| Attach on create | (CLI `-d` to detach) | `attach` (default: true) | (always attaches) |
5657
| Tmux config file | (CLI `-f`) | `tmux_options` / `cli_args` | (none) |
5758
| Tmux command | (none) | `tmux_command` (e.g. `wemux`) | (none) |
5859
| Session options | `options` | (none) | (none) |
5960
| Global options | `global_options` | (none) | (none) |
6061
| Environment vars | `environment` | (none) | (none) |
6162
| Pre-build script | `before_script` | (none) | (none) |
62-
| Shell cmd before (all panes) | `shell_command_before` | `pre_window` / `pre_tab` | (none) |
63-
| Attach on create | (CLI `-d` to detach) | `attach` | (always attaches) |
64-
| Startup window | (none) | `startup_window` | (none) |
63+
| Shell cmd before (all panes) | `shell_command_before` | `pre_window` / `pre_tab` (deprecated) | (none) |
64+
| Startup window | (none) | `startup_window` (name or index) | (none) |
6565
| Startup pane | (none) | `startup_pane` | (none) |
6666
| Plugins | `plugins` | (none) | (none) |
6767
| ERB/variable interpolation | (none) | Yes (`key=value` args) | (none) |

notes/import-tmuxinator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ These are config keys/patterns that differ syntactically but can be automaticall
125125
|---|---|
126126
| `pre_tab: "source .env"` | `shell_command_before: ["source .env"]` |
127127

128-
**Importer status**: ✗ Not handled. `pre_tab` is a deprecated alias for `pre_window`.
128+
**Importer status**: ✗ Not handled. `pre_tab` is a deprecated predecessor to `pre_window` (not an alias — it was renamed).
129129

130130
### 15. `rvm``shell_command_before`
131131

notes/parity-tmuxinator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ startup_window: editor # Select this window after build
5656
startup_pane: 1 # Select this pane within the startup window
5757
```
5858
59-
**Gap**: tmuxp supports `focus: true` on windows and panes (boolean), which is equivalent but syntactically different. The `startup_window` key allows referencing by name or index. **Partial parity** — tmuxp can achieve this but uses a different mechanism (`focus` key on individual windows/panes).
59+
**Gap**: tmuxp supports `focus: true` on windows and panes (boolean), which is equivalent but syntactically different. The `startup_window` key allows referencing by name or index (rendered as `"#{name}:#{value}"`). **Partial parity** — tmuxp can achieve this but uses a different mechanism (`focus` key on individual windows/panes rather than a centralized key).
6060

6161
### 5. Pane Synchronization
6262

@@ -217,7 +217,7 @@ Creates a config file pre-populated from a running tmux session.
217217
| `startup_pane` | Not imported. tmuxp uses `focus: true` on panes. |
218218
| `tmux_command` | Not imported. tmuxp has no equivalent. |
219219
| `socket_path` | Not imported. tmuxp takes this via CLI. |
220-
| `pre_tab` | Not imported (alias for `pre_window`). |
220+
| `pre_tab` | Not imported (deprecated predecessor to `pre_window`). |
221221
| `rvm` | Not imported (only `rbenv` is handled). |
222222
| `post` | Not imported. tmuxp has no equivalent. |
223223
| `synchronize` | Not imported. tmuxp has no equivalent. |
@@ -241,7 +241,7 @@ Creates a config file pre-populated from a running tmux session.
241241

242242
3. **Line 79-101**: The window iteration uses `for k, v in window_dict.items()` which assumes windows are always dicts with a single key (the window name). This is correct for tmuxinator's format but fragile — if a window dict has multiple keys, only the last one is processed.
243243

244-
4. **Missing `pre_tab`**: The `pre_tab` alias for `pre_window` is not handled.
244+
4. **Missing `pre_tab`**: The `pre_tab` deprecated predecessor to `pre_window` is not handled.
245245

246246
5. **Missing `rvm`**: Only `rbenv` is imported; `rvm` (another deprecated but still functional key) is ignored.
247247

0 commit comments

Comments
 (0)