Refactor/Lua bridge by idursun · Pull Request #572 · idursun/jjui

idursun · 2026-03-02T13:05:13Z

I was testing the new Lua scripting system and noticed a few consistency gaps, so I aligned the action model around generated intents. The naming had drifted over time: some closeable flows used start_*, some used open_*, and some had no prefix at all even though they opened something that could be closed. I standardised these to open_* for closeable operations/dialogs, because that naming naturally matches the lifecycle and makes scripted control flow clearer.

Previously, we also had handcrafted Lua bridge functions for a subset of operations, and those helpers implicitly waited so they could be used directly in if blocks. That handcrafted list will always drift now that Lua actions are auto-generated from intents, so it no longer reflects the real system surface. This change removes those custom bridge entrypoints and keeps equivalent behaviour through explicit wait helpers.

To preserve practical behaviour, two helpers are now the control-flow primitives: wait_close() and wait_refresh(). wait_close() lets scripts branch on close/apply outcomes, and wait_refresh() matches the fact that many internal commands refresh state after execution. I also aligned apply paths in closeable dialogs/operations (including git and bookmarks) to emit applied-close semantics, so script behaviour is consistent and predictable across the UI. Overall, this makes both the UI behaviour and the Lua script layer more controllable for multi-step workflows.

I also cleaned up binding order and removed duplicated bindings encountered during this refactor.

Here's an example for a potential use of the current Lua scripting. The following action will enter inline describe mode, let you type something, and when you press alt+enter, it will create a new commit and open inline describe on it. this will continue until user hits esc

config.action("new + inline describe loop", function()
  while true do
    revisions.open_inline_describe()
    if not wait_close() then
      break
    end
    wait_refresh()
    revisions.new()
    wait_refresh()
    revisions.jump_to_working_copy()
  end
end, { desc = "new + inline describe loop", seq = { "w", "c" }, scope = "revisions" })

…eases)

baggiiiie · 2026-03-03T07:11:47Z

seems like there's a breaking change, inline_describe is changed to open_inline_describe

idursun · 2026-03-03T07:54:06Z

Yes, everything that’s closeable starts with open now.

0.10 is full of breaking changes but given that lua script support in 0.9 was experimental, this might not count one.

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [idursun/jjui](https://github.com/idursun/jjui) | minor | `v0.9.12` → `v0.10.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>idursun/jjui (idursun/jjui)</summary> ### [`v0.10.0`](https://github.com/idursun/jjui/releases/tag/v0.10.0) [Compare Source](idursun/jjui@v0.9.12...v0.10.0) Wow, a major release after a very long time. As promised, `v0.10` is ready, and it comes with **breaking changes**. First, thank you to everybody who contributed code, bug reports, ideas, and testing for this release. In particular, thanks to [@baggiiiie](https://github.com/baggiiiie) for various features and fixes, [@nickchomey](https://github.com/nickchomey) for contributions and continuous feedback, and [@vic](https://github.com/vic) for updating the documentation website. Thanks as well to everyone else for various code contributions, reporting issues, and verifying fixes. We changed a lot in `v0.10`, but the biggest shift is that we finally got rid of some **legacy configuration** and moved to a unified **actions + bindings** model. Old concepts like `[custom_commands]` and `[leader]` are now replaced by a more consistent system built around **actions**, **bindings**, and first-class support for leader-style key sequences. This release also introduces `config.lua`, which makes it much easier to customise and extend `jjui` with **real scripting** instead of only static configuration. Between `config.toml`, `config.lua`, Lua actions, and bindings, much more of the UI can now be customised in one consistent way. The documentation has been updated with [**migration notes**](https://idursun.github.io/jjui/migrating/v0_10/) and examples such as the [**Lua Cookbook**](https://idursun.github.io/jjui/lua-cookbook/). From my testing it looks ready, but I am sure more rough edges will show up once more people start using it, so please keep reporting issues as you find them. #### ⚠️ Breaking Changes `v0.10` replaces the **legacy keybinding and customisation model** with the new **actions + bindings** system. - `[keys]` configuration is no longer used. - `[custom_commands]` is replaced by `[[actions]]` and `[[bindings]]`. - `[leader]` sequences are replaced by sequence bindings via `seq`. If you have an existing configuration, plan to **migrate it** rather than expecting a drop-in upgrade from `v0.9.x`. #### ✨Highlights - **Unified actions + bindings system.** Keyboard input now flows through a single dispatch pipeline, default bindings are declared in TOML, actions are discoverable, and custom behaviour can be defined in both TOML and Lua. - **Much stronger scripting support.** Lua `setup` now receives the full config plus runtime context, generated intent-backed actions replace handwritten drift-prone bridges, and new helpers like `wait_close()` and `wait_refresh()` make multi-step scripts more predictable. - **Upgraded TUI foundations.** Moving from **Bubble Tea v1** to **v2** brings better terminal support, a new rendering engine for better performance, and better input handling, including support for bindings like `ctrl+space` and dedicated `shift+...` style keys. - **Improved diff and selection workflows.** The `diff` view now supports word wrap, `revisions` and `details` support modifier-based mouse selection, and several `details` and `evolog` interactions are more consistent. #### 🚀 New and Improved ##### Command History - Added [**command history**](https://idursun.github.io/jjui/command-history/), available with `shift+w`, to review dismissed command runs together with their output. - Moved **running command** information out of the status area and into dedicated `flash` messages, so the command and its output are now shown together in one place. ##### Help and Status - Reintroduced a dedicated **Help view** for full keybinding discovery, with filtering and scrolling, alongside the existing inline help. - Changed **status/help** binding presentation to **column-major order** so related bindings are easier to scan. ##### Lua and Configuration - Shipped the unified **actions + bindings** architecture introduced in `v0.10`. - Exposed the full config object to Lua `setup`, including runtime context such as repository path via `config.repo`, and terminal state via `config.terminal.dark_mode`, `config.terminal.fg`, and `config.terminal.bg`. - Standardised closeable action naming around `open_*` and aligned apply/close semantics for more predictable scripted workflows. ##### Oplog - Added **quick search** to `oplog` and shared the search behavior with revision search. ##### Evolog - Changed `evolog` preview defaults to show **interdiff** output, matching `jj evolog -p` more closely. ##### Abandon - Added `s` in `abandon` mode to target descendants of the selected revision(s). ##### Revset - Kept `revset` editing open when the expression is invalid, improving iteration while editing. - Improved `revset` editing so function completion inserts `(` when appropriate, while the function list display is cleaner and less noisy. ##### Diff - Added **word wrap** in the `diff` view, with explicit wrapped and unwrapped modes plus soft-wrap-aware scrolling. - Added `g` and `G` in the `diff` view to jump to the top and bottom. ##### Details and Revisions - Added `Ctrl+click` single-item toggle and `Alt+click` range selection in `revisions` and `details`. - Added a `revisions.details.select_file` action for finer control in `details` workflows. #### 🛠️ Fixes - Fixed rendering issues with **double-width characters**. - Simplified divergent revision handling by using `change_id/offset` directly from the `jj log` prefix template. - Fixed `git push --all` behaviour for deleted bookmarks and corrected related command descriptions. #### ⚙️ Internal Updates - Upgraded to **Bubble Tea v2**. - Replaced remaining `cellbuf` usage with `ultraviolet`. - Hardcoded model-level key handling has been removed in favor of dispatcher-driven intents. - Continued internal cleanup around rendering, overlays, display context, and generated action plumbing to support the new architecture. #### What's Changed - Unified Actions + Bindings system by [@idursun](https://github.com/idursun) in [#533](idursun/jjui#533) - feat(oplog): add QuickSearch to oplog, share logic with revision search by [@baggiiiie](https://github.com/baggiiiie) in [#521](idursun/jjui#521) - fix: add missing keys in bindings by [@baggiiiie](https://github.com/baggiiiie) in [#538](idursun/jjui#538) - feat(evolog): change default evolog command to show interdiff by [@academician](https://github.com/academician) in [#539](idursun/jjui#539) - fix: add back `esc` to clear checked revisions by [@baggiiiie](https://github.com/baggiiiie) in [#541](idursun/jjui#541) - remove gh-pages workflow from main branch. by [@vic](https://github.com/vic) in [#542](idursun/jjui#542) - docs: fix readme links by [@baggiiiie](https://github.com/baggiiiie) in [#549](idursun/jjui#549) - Update CONTRIBUTING.md for documentation by [@vic](https://github.com/vic) in [#547](idursun/jjui#547) - feat(lua): add "filter" and "ordered" option to `choose` lua api by [@baggiiiie](https://github.com/baggiiiie) in [#548](idursun/jjui#548) - feat(abandon): use `s` for selecting descendants by [@idursun](https://github.com/idursun) in [#544](idursun/jjui#544) - feat: add change\_offset in jj log prefix template for divergent revisions by [@baggiiiie](https://github.com/baggiiiie) in [#550](idursun/jjui#550) - fix: make bookmark input visible when user has custom template-aliases by [@baggiiiie](https://github.com/baggiiiie) in [#551](idursun/jjui#551) - fix(evolog): keep restore mode navigation on revisions and esc close by [@baggiiiie](https://github.com/baggiiiie) in [#554](idursun/jjui#554) - Expose full config to Lua setup and add runtime context (repo + terminal) by [@idursun](https://github.com/idursun) in [#553](idursun/jjui#553) - feat(flash): command history by [@idursun](https://github.com/idursun) in [#556](idursun/jjui#556) - Update to bubbletea v2 by [@idursun](https://github.com/idursun) in [#558](idursun/jjui#558) - Ctrl+click and Alt+click for single and range selection by [@idursun](https://github.com/idursun) in [#563](idursun/jjui#563) - feat: add `(` to functions when autocompleted by [@nickchomey](https://github.com/nickchomey) in [#564](idursun/jjui#564) - feat(status): change display to column major order by [@baggiiiie](https://github.com/baggiiiie) in [#569](idursun/jjui#569) - fix: remove parentheses from functions list, but add when autocomplete by [@nickchomey](https://github.com/nickchomey) in [#567](idursun/jjui#567) - fix(git): prevent panic when opening git menu with no selected revision by [@baggiiiie](https://github.com/baggiiiie) in [#571](idursun/jjui#571) - Refactor/Lua bridge by [@idursun](https://github.com/idursun) in [#572](idursun/jjui#572) - fix(ui): guard against nil commit in OpenBookmarks intent by [@baggiiiie](https://github.com/baggiiiie) in [#573](idursun/jjui#573) - feat(diff): word wrap by [@idursun](https://github.com/idursun) in [#575](idursun/jjui#575) - Add pgup/pgdown keybindings to evolog and details by [@academician](https://github.com/academician) in [#576](idursun/jjui#576) - feat(lua): make default actions overridable and expose jjui.builtin.\* by [@idursun](https://github.com/idursun) in [#577](idursun/jjui#577) - feat(help): add "help view" bound to `f1` by [@idursun](https://github.com/idursun) in [#578](idursun/jjui#578) #### New Contributors - [@academician](https://github.com/academician) made their first contribution in [#539](idursun/jjui#539) **Full Changelog**: <idursun/jjui@v0.9.12...v0.10.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

idursun added 4 commits March 1, 2026 23:36

chore: reorder bindings (so that they match the order in previous rel…

92dc3c6

…eases)

feat(lua): add wait_close and wait_refresh

5426120

refactor: make action names consistent

0efa932

fix: make sure all operations return close applied message

80cc2e9

idursun merged commit e1fe705 into main Mar 2, 2026
4 checks passed

idursun deleted the refactor/lua-bridge branch March 2, 2026 13:07

BrewTestBot mentioned this pull request Mar 8, 2026

jjui 0.10.0 Homebrew/homebrew-core#271272

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor/Lua bridge#572

Refactor/Lua bridge#572
idursun merged 4 commits intomainfrom
refactor/lua-bridge

idursun commented Mar 2, 2026

Uh oh!

Uh oh!

baggiiiie commented Mar 3, 2026

Uh oh!

idursun commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

idursun commented Mar 2, 2026

Uh oh!

Uh oh!

baggiiiie commented Mar 3, 2026

Uh oh!

idursun commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants