Expose full config to Lua setup and add runtime context (repo + terminal)#553
Expose full config to Lua setup and add runtime context (repo + terminal)#553
Conversation
This ensures the user configuration is always overwrites the default configuration
terminal bg/fg and repo location can be helpful to customise jjui look & feel and custom actions based on where it is running at.
|
i was a bit lost at first reading this PR, until i saw
okay i see, you're doing your wizardry again 🚀 |
|
Yes, sorry the PR description is not the best. Idea is simple though, config object is the actual config from the TOML file + some runtime information to customise the configuration even further. I am going to merge this and follow it up if I notice any regressions. |
|
This is awesome, that means themes are not static anymore, but computed at first load? Maybe in the future we wont need tinted-jjui to generate all files, but just use the color scheme and compute theme configuration by loading a lua file with them. I also always wanted to have color-per working directory, eg, use fire-theme when working on main branch of some project, just like I do for color-coding connection to production dbs. |
Potentially yes. Having different theme per working directory is possible now too. These are great use cases. However, all I wanted was to be able to set the |
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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My41OS40IiwidXBkYXRlZEluVmVyIjoiNDMuNTkuNCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90IiwiYXV0b21hdGlvbjpib3QtYXV0aG9yZWQiLCJkZXBlbmRlbmN5LXR5cGU6Om1pbm9yIl19-->
Current Lua
setupfunction is called with a config object it is actually a table with two methods definedactionandbind. I thought it would be nice if we pass the actual config object so that the users can customise it even further. Imagine someone creatingjjui-sensibleplugin with selection of preview commands that make more sense.This PR converts the Config loaded from TOML into Lua table and passes it to the setup function.
setupfunction can read and modify these values when it runs. Once Lua setup is complete, then the Lua config table is converted back to config instance and that's what is used in the app after that point.This PR also adds a couple of runtime fields to the config object:
config.repothe repository location so that config.lua can define different actions based on the repository.config.terminal.dark_modetrue if the terminal is in dark modeconfig.terminal.fgdefault foreground colour of the terminalconfig.terminal.bgdefault background of the terminal.While adding those, I also took the opportunity to get rid of the
merge.gofile and updated the action/binding resolution:merge.gois removedconversion.gois AI generated. I cannot be asked to write lua conversion code.Usage Examples
Here are a couple of usage examples:
You can change the default preview commands:
Loading different themes based on repository name:
What's
dynamic_theme?? Well, you can actually create dynamic themes using Lua functions, here's an example which uses a single primary colour and every other colour derived by lightening or darkening that colour.