tmux-python / tmux-python/tmuxp
Pass the workspace_builder to plugin hooks instead of the tmux session
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 248
- Avg merge
- 2h 13m
- Merged PRs (30d)
- 1
Description
First of all, thank you for this app that changed my life with tmux !
In the current plugin system, it seems impossible to access the session configuration (from yaml or json).
Is there a specific reason the workspace is not passed in the hooks ?
...This would allow to easily extend the configuration file format.
I suggest to replace the session argument with a workspace_builder argument (which already gives access to the session) in the hooks. The drawback is that it's a breaking change. Here are some ways to overcome it:
- Duplicate the hooks
- Have the new hook call the legacy one by default
- Call both the hooks
- Add a new plugin class with hooks expecting the workspace builder
I can of course make a PR myself, but I need to know which way you prefer
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by locating the plugin hooks and comparing their current session argument with the workspace_builder interface; clarify the compatibility approach with maintainers. Done means hooks can access workspace configuration through workspace_builder without leaving the chosen legacy-hook behavior ambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100