zellij-org/zellij

The plugin APIs should block until their action is performed, similar to our CLI

Open

#2,558 opened on Jun 18, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (32,593 stars) (1,191 forks)batch import
help wantedplugin system

Description

The various plugin API commands (eg. new_tab, new_terminal_pane) etc. do not block at the moment. Instead they "send and forget" and do not even indicate when the operation was not successful.

This is not desirable.

We should block similarly to how we do with the cli commands and keybindings.

Contributor guide

Tech stack
rust
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rustasync programmingZellij plugin system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue requests that plugin API commands (e.g., new tab, new terminal pane) block until the action is performed, similar to CLI commands. The current behavior is 'send and forget' without feedback. To implement this, one should investigate how CLI commands achieve blocking, likely through async/await patterns or channels, and then apply similar logic to the plugin API handlers. Key files to look at include the plugin API implementation (likely in a module like 'plugin' or 'api') and the CLI command handlers for comparison. No linked PRs or comments provide further guidance, so the approach must be derived from the existing codebase.
The plugin APIs should block until their action is performed, similar to our CLI · zellij-org/zellij#2558 | Good First Issue