name

rebase-on-upstream-zellij

description

Rebase this fork's tab-bar and compact-bar plugins onto a newer zellij upstream release. Use when the user asks to "rebase on upstream", "update to zellij vX.Y.Z", "bump zellij version", "pull in latest zellij", or any equivalent. The fork extracts default-plugins from zellij-org/zellij and adds two orthogonal customizations (show_tab_indices + permissions handshake); this skill walks through snapshot-and-reapply, verification, tagging, and release.

Rebase on upstream zellij

Strategy: snapshot + reapply, not bump-deps

Do not just bump zellij-tile versions. Upstream patch releases routinely change default-plugins/*/src/*.rs (new fields in Action::* variants needing .. in matches!, new EventType/KeybindsVec items). A pure deps bump compile-fails or silently misses fixes.

Snapshot upstream default-plugins/{tab-bar,compact-bar} at the new tag, overwriting local sources and Cargo.tomls.
Reapply the fork's customizations on top as separate, named commits.
Verify final diff -ruN <upstream-new>/.../src <plugin>/src contains only the fork's customizations and nothing else.

This pulls in upstream fixes for free and keeps the squash commit minimal.

The two fork customizations

Both apply to both plugins. The squash commit on main (e.g. b69aaff) is the source of truth — read its diff to see exactly what to reapply.

show_tab_indices — bool config option that renders <1>, <2> prefixes on tab labels. Touches State + parse in load/init + render loop in main.rs, and render_tab/tab_style signature + an index_color + tab_parts: Vec<ANSIString> builder in tab.rs.
Permissions handshake — request_permission(&[ReadApplicationState, ChangeApplicationState]) instead of set_selectable(false) at startup, plus EventType::PermissionRequestResult subscription and Granted/Denied branches in update(). compact-bar splits setup_subscriptions by is_tooltip and adds a resubscribe_events helper.

Critical merge point: the post-Granted re-subscribe must include EventType::InitialKeybinds. This is the only place a fork patch and an upstream change overlap; everywhere else they're independent. Missing this silently breaks keybinds in Locked mode at cold start.

Workflow

git checkout -b rebase-<new_tag> from clean main.
Run scripts/three_way_diff.sh <old_tag> <new_tag> to clone both upstream tags into /tmp/zellij-rebase-<new_tag>/ and pre-compute fork/upstream patches. Read upstream-*.patch to see what's new upstream.
Verify zellij-tile <new> is on crates.io (curl -s https://crates.io/api/v1/crates/zellij-tile | jq '.versions[0:5][].num'). If not, fall back to a git dep on the tag.
Make one commit per logical change: snapshot upstream src+Cargo.toml; restore fork Cargo.toml metadata + crates.io deps; reapply show_tab_indices to tab-bar; reapply permissions handshake to tab-bar; same two for compact-bar. cargo check --target wasm32-wasip1 after each.
After all reapplies, sanity-check:
```
diff -ruN /tmp/zellij-rebase-<new_tag>/<new_tag>/default-plugins/tab-bar/src tab-bar/src
diff -ruN /tmp/zellij-rebase-<new_tag>/<new_tag>/default-plugins/compact-bar/src compact-bar/src
```
Output must equal exactly the fork's customizations. Stylistic drift in compact-bar/src/tab.rs (operand order, multi-line vs one-line call) is a common offender — match the previous fork tip byte-for-byte to keep the squash diff minimal.
cargo build --release produces target/wasm32-wasip1/release/{tab-bar,compact-bar}.wasm. Zero warnings.

Finalize

git checkout main
git merge --squash rebase-<new_tag>
git commit -m "rebase customizations on zellij <new_tag>"
git tag -a <new_tag> -m "Rebased on zellij <new_tag>"
git push origin main <new_tag>

Tag format matches existing pattern (v0.44.0, iterations as v0.44.0-1). CI (.github/workflows/release.yml) triggers on v*.*.*[-*] and publishes both .wasm + sha256sums.

Environment notes

Cargo.lock is .gitignored here. cargo update -p zellij-tile -p zellij-tile-utils locally, do not commit.
On macOS with rustup, cargo is not on $PATH by default. Prefix invocations with export PATH="$HOME/.rustup/toolchains/stable-aarch64-apple-darwin/bin:$PATH".
[lib] section in plugin Cargo.tomls is intentionally absent — plugins build as binary crates targeting wasm32-wasip1.

Rebase on upstream zellij

Strategy: snapshot + reapply, not bump-deps

Snapshot upstream default-plugins/{tab-bar,compact-bar} at the new tag, overwriting local sources and Cargo.tomls.

Reapply the fork's customizations on top as separate, named commits.

Verify final diff -ruN <upstream-new>/.../src <plugin>/src contains only the fork's customizations and nothing else.

This pulls in upstream fixes for free and keeps the squash commit minimal.

The two fork customizations

Both apply to both plugins. The squash commit on main (e.g. b69aaff) is the source of truth — read its diff to see exactly what to reapply.

show_tab_indices — bool config option that renders <1>, <2> prefixes on tab labels. Touches State + parse in load/init + render loop in main.rs, and render_tab/tab_style signature + an index_color + tab_parts: Vec<ANSIString> builder in tab.rs.

Permissions handshake — request_permission(&[ReadApplicationState, ChangeApplicationState]) instead of set_selectable(false) at startup, plus EventType::PermissionRequestResult subscription and Granted/Denied branches in update(). compact-bar splits setup_subscriptions by is_tooltip and adds a resubscribe_events helper.

Workflow

git checkout -b rebase-<new_tag> from clean main.

Run scripts/three_way_diff.sh <old_tag> <new_tag> to clone both upstream tags into /tmp/zellij-rebase-<new_tag>/ and pre-compute fork/upstream patches. Read upstream-*.patch to see what's new upstream.

Verify zellij-tile <new> is on crates.io (curl -s https://crates.io/api/v1/crates/zellij-tile | jq '.versions[0:5][].num'). If not, fall back to a git dep on the tag.

Make one commit per logical change: snapshot upstream src+Cargo.toml; restore fork Cargo.toml metadata + crates.io deps; reapply show_tab_indices to tab-bar; reapply permissions handshake to tab-bar; same two for compact-bar. cargo check --target wasm32-wasip1 after each.

After all reapplies, sanity-check:

diff -ruN /tmp/zellij-rebase-<new_tag>/<new_tag>/default-plugins/tab-bar/src tab-bar/src
diff -ruN /tmp/zellij-rebase-<new_tag>/<new_tag>/default-plugins/compact-bar/src compact-bar/src

Output must equal exactly the fork's customizations. Stylistic drift in compact-bar/src/tab.rs (operand order, multi-line vs one-line call) is a common offender — match the previous fork tip byte-for-byte to keep the squash diff minimal.

cargo build --release produces target/wasm32-wasip1/release/{tab-bar,compact-bar}.wasm. Zero warnings.

Finalize

git checkout main git merge --squash rebase-<new_tag> git commit -m "rebase customizations on zellij <new_tag>" git tag -a <new_tag> -m "Rebased on zellij <new_tag>" git push origin main <new_tag>

Tag format matches existing pattern (v0.44.0, iterations as v0.44.0-1). CI (.github/workflows/release.yml) triggers on v*.*.*[-*] and publishes both .wasm + sha256sums.

Environment notes

Cargo.lock is .gitignored here. cargo update -p zellij-tile -p zellij-tile-utils locally, do not commit.

On macOS with rustup, cargo is not on $PATH by default. Prefix invocations with export PATH="$HOME/.rustup/toolchains/stable-aarch64-apple-darwin/bin:$PATH".

[lib] section in plugin Cargo.tomls is intentionally absent — plugins build as binary crates targeting wasm32-wasip1.