Skip to content

Commit 97157aa

Browse files
committed
Add deprecation notice
The new DEC mode 2031 [0] is a much better fit and already has native support in neovim [1] and tmux [2]. Most terminal emulators either already support it or have it on the roadmap [3] so with this mode suddenly being support across the whole stack, it is a much better choice than listening for theme changes with an extra plugin. [0] https://contour-terminal.org/vt-extensions/color-palette-update-notifications/ [1] neovim/neovim#31350 [2] tmux/tmux#4353 [3] wezterm/wezterm#6454
1 parent ac13c32 commit 97157aa

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ This also works inside WSL2.
4040

4141
# FAQ
4242

43+
## Is this plugin still needed with latest Vim?
44+
45+
With Neovim [implementing support](https://github.com/neovim/neovim/pull/31350) for [DEC mode 2031](https://contour-terminal.org/vt-extensions/color-palette-update-notifications/) this plugin has become obsolete.
46+
You can now use the native support for theme changes by reacting to `autocmd OptionSet background`, as long as the entire chain of your terminal emulator, terminal multiplexer and your version of vim support it.
47+
4348
## How can I add custom callbacks?
4449

4550
You can use the `LumenLight` and `LumenDark` `User` autocommands:

doc/lumen.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ All platform implementations are interrupt-based and do not use any resources
2323
in the background because they avoid polling and use the proper system APIs
2424
instead.
2525

26+
Note that this plugin has become obsolete with Vim implementing support for
27+
DEC mode 2031.
28+
You can now use the native support for theme changes simply by listening to
29+
`autocmd OptionSet background`, as long as the entire chain of your terminal
30+
emulator, terminal multiplexer and your version of vim support it.
31+
For more information read:
32+
- https://contour-terminal.org/vt-extensions/color-palette-update-notifications/
33+
- https://github.com/neovim/neovim/pull/31350
34+
2635
------------------------------------------------------------------------------
2736
DEPENDENCIES *lumen-dependencies*
2837

0 commit comments

Comments
 (0)