|
28 | 28 |
|
29 | 29 |
|
30 | 30 | class PluginConfigSchema(TypedDict): |
| 31 | + """Keyword arguments accepted by :class:`tmuxp.plugin.TmuxpPlugin`. |
| 32 | +
|
| 33 | + Every key is optional. :func:`tmuxp.plugin.setup_plugin_config` fills each |
| 34 | + omitted key from ``tmuxp.plugin.DEFAULT_CONFIG`` before the plugin runs its |
| 35 | + version checks. |
| 36 | +
|
| 37 | + Attributes |
| 38 | + ---------- |
| 39 | + plugin_name : NotRequired[str] |
| 40 | + Name of the plugin, used to identify it in version incompatibility |
| 41 | + messages. |
| 42 | + tmux_min_version : NotRequired[str] |
| 43 | + Oldest tmux version the plugin supports. |
| 44 | + tmux_max_version : NotRequired[str] |
| 45 | + Newest tmux version the plugin supports. |
| 46 | + tmux_version_incompatible : NotRequired[list[str]] |
| 47 | + Individual tmux versions the plugin rejects even though they fall |
| 48 | + inside the min / max range. |
| 49 | + libtmux_min_version : NotRequired[str] |
| 50 | + Oldest libtmux version the plugin supports. |
| 51 | + libtmux_max_version : NotRequired[str] |
| 52 | + Newest libtmux version the plugin supports. |
| 53 | + libtmux_version_incompatible : NotRequired[list[str]] |
| 54 | + Individual libtmux versions the plugin rejects even though they fall |
| 55 | + inside the min / max range. |
| 56 | + tmuxp_min_version : NotRequired[str] |
| 57 | + Oldest tmuxp version the plugin supports. |
| 58 | + tmuxp_max_version : NotRequired[str] |
| 59 | + Newest tmuxp version the plugin supports. |
| 60 | + tmuxp_version_incompatible : NotRequired[list[str]] |
| 61 | + Individual tmuxp versions the plugin rejects even though they fall |
| 62 | + inside the min / max range. |
| 63 | + """ |
| 64 | + |
31 | 65 | plugin_name: NotRequired[str] |
32 | 66 | tmux_min_version: NotRequired[str] |
33 | 67 | tmux_max_version: NotRequired[str] |
|
0 commit comments