From 245e31430fb7298e02ef0d4030905b49d0385746 Mon Sep 17 00:00:00 2001 From: Maciej Sypien Date: Mon, 23 Sep 2024 00:08:20 +0200 Subject: [PATCH 1/9] chore: add changelog entry --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c94c9ff..3aa4317 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Removed +- Reduce repo weight by removing unused images [#41](https://github.com/egel/tmux-gruvbox/issues/41) + ### Fixed - Fixed incorrect spacings in template file From b1bbcf68d0bccd948a5d107de6026f52bb192ee6 Mon Sep 17 00:00:00 2001 From: Maciej Sypien Date: Sun, 29 Sep 2024 23:48:07 +0200 Subject: [PATCH 2/9] docs: add migration guide from v1 to v2 (#44) --- CHANGELOG.md | 1 + README.md | 77 +++++++++++++++++------ docs/migration-guide-from-v1-to-v2.md | 91 +++++++++++++++++++++++++++ 3 files changed, 150 insertions(+), 19 deletions(-) create mode 100644 docs/migration-guide-from-v1-to-v2.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 25c1b6b..9bb8476 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Added tests (for linux) [#39](https://github.com/egel/tmux-gruvbox/issues/39) - Added customizable statusbar [#31](https://github.com/egel/tmux-gruvbox/issues/31) - Added support for 16-bit colors palette light & dark [#34](https://github.com/egel/tmux-gruvbox/issues/34) +- Added migration guide v1 to v2 [#44](https://github.com/egel/tmux-gruvbox/issues/44) ### Changed diff --git a/README.md b/README.md index b23e5f5..bdd292f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

Gruvbox theme for Tmux

-Theme with 'retro groove' flavor for [Tmux][github-tmux], based on Pavel Pertsev's [gruvbox colorscheme][github-grovbox] and inspired by work of [Gordon Chiam](https://gist.github.com/gchiam/4606522f513cc64b79ce). Subthemes switching inspired by [tmux-color-solarized][tmux-color-solarized]. +Theme with 'retro groove' flavor for [Tmux][github-tmux], based on Pavel Pertsev's [gruvbox colorscheme][github-grovbox] and inspired by work of [Gordon Chiam](https://gist.github.com/gchiam/4606522f513cc64b79ce). Subthemes switching inspired by [tmux-color-solarized][github-seebi-tmux-color-solarized].
- + [!NOTE] +> If you used v1 before and interested to adpt to v2 use this [Migration Guide from v1 to v2][docs-migration-guide-from-v1-to-v2]. + ### Install manually > [!TIP] @@ -55,26 +67,47 @@ Hit `prefix + I` to fetch the plugin and source it. Your Tmux should be updated ```bash # ~/.tmux.conf + run ~/projects/tmux-gruvbox/tmux-gruvbox.tmux # set desired options... - set -g @tmux-gruvbox 'dark' # or light + set -g @tmux-gruvbox 'dark' # or 'dark256', 'light', 'light256' ``` ## Configuration options +
+ + + +
+ ### Theme - default value: `dark256` -- available themes: - - `dark` ([preview][imgur-img-gruvbox-dark-16bit-1x]) - - `light` ([preview][imgur-img-gruvbox-light-16bit-1x]) - - `dark256` ([preview][imgur-img-gruvbox-dark256-1x]) - - `light256` ([preview][imgur-img-gruvbox-light256-1x]) + +| Theme name | Color palette | Preview link | +| :--------- | :------------ | :-------------------------------------------------------------------- | +| `dark` | 16-bit colors | preview | +| `light` | 16-bit colors | preview | +| `dark256` | 256 colors | preview | +| `light256` | 256 colors | preview | ```bash set -g @tmux-gruvbox 'dark' # dark256, light, light256 ``` +> [!TIP] +> Each terminal emulator can behave bit differently regarding displaying colors. +> If you have some problems see +> [True Color (24-bit) and italics with alacritty + tmux + vim (neovim)][github-gist-andersevenrud-alacritty-tmux-vim-truecolor] +> where there is great wisdom how to adjust terminal, especially when used +> alacritty and tmux. + ### Transparent status-bar - default value: `'false'` @@ -86,7 +119,7 @@ set -g @tmux-gruvbox-statusbar-alpha 'true' ### Left Status (Section A) -- default value: `'#S'` +- default value: `'#S'` (session name) ```bash set -g @tmux-gruvbox-left-status-a '#S' # tmux's session name @@ -98,6 +131,10 @@ set -g @tmux-gruvbox-left-status-a '#S' # tmux's session name This section is customizable for user, and by default contains current date. +> [!TIP] +> Some user may have problem with displaying dates in desired format, if this +> case for you try using double percent `%%` + ```bash # set date in US notation set -g @tmux-gruvbox-right-status-x '%m/%d/%Y' # e.g.: 01/31/2024 @@ -121,7 +158,7 @@ set -g @tmux-gruvbox-right-status-y '%I:%M %p' # 09:54 PM ### Right Status (Section Z) -- default value: `'#h'` +- default value: `'#h'` (hostname) This section is customizable for user, and by default contains hostname. @@ -177,18 +214,20 @@ To keep the files clean we use few program to help us achieve it: GPLv3 - Maciej Sypień -[github-tmux]: https://github.com/tmux/tmux +[docs-migration-guide-from-v1-to-v2]: ./docs/migration-guide-from-v1-to-v2.md +[github-alacritty]: https://github.com/alacritty/alacritty +[github-gist-andersevenrud-alacritty-tmux-vim-truecolor]: https://gist.github.com/andersevenrud/015e61af2fd264371032763d4ed965b6 [github-grovbox]: https://github.com/morhetz/gruvbox [github-hack]: https://github.com/chrissimpkins/Hack [github-nerd-fonts]: https://github.com/ryanoasis/nerd-fonts -[github-alacritty]: https://github.com/alacritty/alacritty +[github-seebi-tmux-color-solarized]: https://github.com/seebi/tmux-colors-solarized +[github-tmux]: https://github.com/tmux/tmux [github-tpm]: https://github.com/tmux-plugins/tpm -[tmux-color-solarized]: https://github.com/seebi/tmux-colors-solarized -[pexcel-1]: https://www.pexels.com/photo/urban-photo-of-an-alley-2411688/ -[pexcel-2]: https://www.pexels.com/photo/lights-hanging-above-the-alley-in-a-city-at-night-27044195/ -[imgur-img-gruvbox-dark-light-comparision-1x]: https://i.imgur.com/uGyGwlC.png -[imgur-img-gruvbox-dark-light-comparision-0.5x]: https://i.imgur.com/p6lUnzb.png [imgur-img-gruvbox-dark-16bit-1x]: https://i.imgur.com/ae88LQI.png +[imgur-img-gruvbox-dark-light-comparision-0.5x]: https://i.imgur.com/p6lUnzb.png +[imgur-img-gruvbox-dark-light-comparision-1x]: https://i.imgur.com/uGyGwlC.png [imgur-img-gruvbox-dark256-1x]: https://i.imgur.com/kzQTTCa.png [imgur-img-gruvbox-light-16bit-1x]: https://i.imgur.com/fvpdRjg.png [imgur-img-gruvbox-light256-1x]: https://i.imgur.com/tQsl6LA.png +[pexcel-1]: https://www.pexels.com/photo/urban-photo-of-an-alley-2411688/ +[pexcel-2]: https://www.pexels.com/photo/lights-hanging-above-the-alley-in-a-city-at-night-27044195/ diff --git a/docs/migration-guide-from-v1-to-v2.md b/docs/migration-guide-from-v1-to-v2.md new file mode 100644 index 0000000..7d19e70 --- /dev/null +++ b/docs/migration-guide-from-v1-to-v2.md @@ -0,0 +1,91 @@ +# Migration guide from v1 to v2 + +Hello there! + +I am so happy to see you here and being interested in using new version of +tmux-gruvbox theme. + +I really try to do all my best giving you new, interesting features that you +probably always wanted to have. + +In here I also wanted to thank you all people involved in contributing to this +theme 🙏🙇. Especially for adding all suggestions, or reporting problems if +they occurred - this helped a lot! + +## What's new? + +There are couple of great things ahead: + +- new themes supporting 16-bit color palette +- new fully customizable spaces A, X, Y, Z for your disposal +- support for transparency (experimental) +- and many more + +See what's new in [CHANGELOG][docs-changelog]. + +## Breaking changes + +I planned to have best possible user experience between migrating from v1 and v2, +therefore tried to build new changes this way to keep the breaking changes +as low as possible. This was not ideal, although I believe for many this would not +require many changes and for some none. + +### Theme names change + +| v1 | v2 | description | +| :-----------------: | :--------: | ----------------------------------------------------------------------- | +| `dark` | `dark256` | | +| `light` | `light256` | | +| `dark-transparent` | ∅ | set `dark` or `dark256` theme and add `@tmux-gruvbox-statusbar-alpha` | +| `light-transparent` | ∅ | set `light` or `light256` theme and add `@tmux-gruvbox-statusbar-alpha` | + +In v2 we've introduced a 16-bit color themes that should give the users more +happiness utilizing a greater amount of supported colors (full gruvbox palette). + +Therefore in v1 theme `light` & `dark` has been simply renamed and `256` postfix +has been added to indicate used palette. + +> [!NOTE] +> While implementing 16-bit colors I realized that many users (including me) had +> problems with setting up correct the color interpretation in their workspace +> to support multiple colors. +> +> Here is the page +> [True Color (24-bit) and italics with alacritty + tmux + vim (neovim)][github-gist-andersevenrud-alacritty-tmux-vim-truecolor] +> where I found great wisdom how to adjust my terminal, especially when used +> alacritty, tmux & neovim. + +### Fallback theme name + +| v1 | v2 | +| :----: | :-------: | +| `dark` | `dark256` | + +Continuing topic of introducing 16-bit colors, we have make slight change in +fallback theme name. We love idea adding new colors to our theme, although +during those changes we cannot forget about users whose terminals might not +support more then basic 256 colors. Therefore the fallback theme name also has +to be adapted and in v2 it's `dark256`. + +## FAQ + +### Plugin not upgrading automaticaly with tmux update + +Error ([source](https://github.com/egel/tmux-gruvbox/issues/21#issuecomment-2373794273)): + +``` +"tmux-gruvbox" update fail + | fatal: couldn't find remote ref refs/heads/master +``` + +Solution: + +We recently migrate from `master` to `main` as the primary branch, therefore tmux plugin manager using old reference to master and it's not possible to pull. + +The simplest way would be to: + +1. remove the plugin `rm -rf ~/.tmux/plugins/tmux-gruvbox` +2. and reinstall it again via tpm key-binding `` + `I`. + +[docs-changelog]: ../CHANGELOG.md +[github-gist-andersevenrud-alacritty-tmux-vim-truecolor]: https://gist.github.com/andersevenrud/015e61af2fd264371032763d4ed965b6 From 80ca5fda100f295251ca0d06ff2a9314abab235f Mon Sep 17 00:00:00 2001 From: Maciej Sypien Date: Fri, 15 Nov 2024 08:19:21 +0100 Subject: [PATCH 3/9] docs: update README --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bdd292f..ae9cca5 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,6 @@ set -g @plugin 'tmux-plugins/tpm' # mandatory set -g @plugin 'tmux-plugins/tmux-sensible' # optional recommended set -g @plugin 'egel/tmux-gruvbox' -# set desired options... -set -g @tmux-gruvbox 'dark' # or 'dark256', 'light', 'light256' # set desired theme options... set -g @tmux-gruvbox 'dark' # or 'dark256', 'light', 'light256' @@ -131,10 +129,6 @@ set -g @tmux-gruvbox-left-status-a '#S' # tmux's session name This section is customizable for user, and by default contains current date. -> [!TIP] -> Some user may have problem with displaying dates in desired format, if this -> case for you try using double percent `%%` - ```bash # set date in US notation set -g @tmux-gruvbox-right-status-x '%m/%d/%Y' # e.g.: 01/31/2024 @@ -145,6 +139,10 @@ set -g @tmux-gruvbox-right-status-x '%m/%d/%Y' # e.g.: 01/31/2024 set -g @tmux-gruvbox-right-status-x '%d.%m.%Y' # e.g.: 30.01.2024 ``` +> [!TIP] +> Some user may have problem with displaying dates in desired format, if this +> case for you try using double percent `%%` + ### Right Status (Section Y) - default value: `'%H:%M'` From 9f5301fe93ea9ef1ffa6cfdd51c76268d34efb45 Mon Sep 17 00:00:00 2001 From: Maciej Sypien Date: Sun, 17 Nov 2024 16:03:05 +0100 Subject: [PATCH 4/9] fix: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae9cca5..e500514 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ set -g @tmux-gruvbox 'dark' # or 'dark256', 'light', 'light256' Hit `prefix + I` to fetch the plugin and source it. Your Tmux should be updated with the theme at this point. > [!NOTE] -> If you used v1 before and interested to adpt to v2 use this [Migration Guide from v1 to v2][docs-migration-guide-from-v1-to-v2]. +> If you used v1 before and interested to adapt to v2 use this [Migration Guide from v1 to v2][docs-migration-guide-from-v1-to-v2]. ### Install manually From fabc2ba12b4731ef4e3837714d66409a6f8f783f Mon Sep 17 00:00:00 2001 From: Maciej Sypien Date: Sun, 17 Nov 2024 22:25:50 +0100 Subject: [PATCH 5/9] fix: typos in migration guide v1-to-v2 --- docs/migration-guide-from-v1-to-v2.md | 44 ++++++++------------------- 1 file changed, 13 insertions(+), 31 deletions(-) diff --git a/docs/migration-guide-from-v1-to-v2.md b/docs/migration-guide-from-v1-to-v2.md index 7d19e70..0c69639 100644 --- a/docs/migration-guide-from-v1-to-v2.md +++ b/docs/migration-guide-from-v1-to-v2.md @@ -2,15 +2,11 @@ Hello there! -I am so happy to see you here and being interested in using new version of -tmux-gruvbox theme. +I am so happy to see you here and are interested in using the new version of tmux-gruvbox theme. -I really try to do all my best giving you new, interesting features that you -probably always wanted to have. +I really try to do all my best giving you new, interesting features that you probably always wanted to have. -In here I also wanted to thank you all people involved in contributing to this -theme 🙏🙇. Especially for adding all suggestions, or reporting problems if -they occurred - this helped a lot! +In here I also wanted to thank you all people involved in contributing to this theme 🙏🙇. Especially for adding all suggestions, or reporting problems if they occurred - this helped a lot! ## What's new? @@ -25,35 +21,25 @@ See what's new in [CHANGELOG][docs-changelog]. ## Breaking changes -I planned to have best possible user experience between migrating from v1 and v2, -therefore tried to build new changes this way to keep the breaking changes -as low as possible. This was not ideal, although I believe for many this would not -require many changes and for some none. +I planned to have best possible user experience between migrating from v1 and v2, therefore tried to build new changes this way to keep the breaking changes as low as possible. This was not ideal, although I believe for many this would not require many changes and for some none. -### Theme names change +### Theme names changes | v1 | v2 | description | | :-----------------: | :--------: | ----------------------------------------------------------------------- | -| `dark` | `dark256` | | -| `light` | `light256` | | +| `dark` | `dark256` | 256-colors theme | +| `light` | `light256` | 256-colors theme | | `dark-transparent` | ∅ | set `dark` or `dark256` theme and add `@tmux-gruvbox-statusbar-alpha` | | `light-transparent` | ∅ | set `light` or `light256` theme and add `@tmux-gruvbox-statusbar-alpha` | -In v2 we've introduced a 16-bit color themes that should give the users more -happiness utilizing a greater amount of supported colors (full gruvbox palette). +In v2 we've introduced a 16-bit color themes that should give the users more happiness utilizing a greater amount of supported colors (full gruvbox palette). -Therefore in v1 theme `light` & `dark` has been simply renamed and `256` postfix -has been added to indicate used palette. +Therefore in v2 themes `light` & `dark` has been simply renamed and `256` postfix has been added to indicate used palette. In v2 `light` & `dark` themes will be refering to 16-bit versions. > [!NOTE] -> While implementing 16-bit colors I realized that many users (including me) had -> problems with setting up correct the color interpretation in their workspace -> to support multiple colors. +> While implementing 16-bit colors I realized that many users (including me) had problems with setting up correct the color interpretation in their workspace to support multiple colors. > -> Here is the page -> [True Color (24-bit) and italics with alacritty + tmux + vim (neovim)][github-gist-andersevenrud-alacritty-tmux-vim-truecolor] -> where I found great wisdom how to adjust my terminal, especially when used -> alacritty, tmux & neovim. +> Here is the page [True Color (24-bit) and italics with alacritty + tmux + vim (neovim)][github-gist-andersevenrud-alacritty-tmux-vim-truecolor] where I found great wisdom how to adjust my terminal, especially when used alacritty, tmux & neovim. ### Fallback theme name @@ -61,15 +47,11 @@ has been added to indicate used palette. | :----: | :-------: | | `dark` | `dark256` | -Continuing topic of introducing 16-bit colors, we have make slight change in -fallback theme name. We love idea adding new colors to our theme, although -during those changes we cannot forget about users whose terminals might not -support more then basic 256 colors. Therefore the fallback theme name also has -to be adapted and in v2 it's `dark256`. +Continuing topic of introducing 16-bit colors, we have make slight change in fallback theme name. We love idea adding new colors to our theme, although during those changes we cannot forget about users whose terminals might not support more then basic 256 colors. Therefore the fallback theme name also has to be adapted and in v2 it's `dark256`. ## FAQ -### Plugin not upgrading automaticaly with tmux update +### Plugin not upgrading automatically with tmux update Error ([source](https://github.com/egel/tmux-gruvbox/issues/21#issuecomment-2373794273)): From 1086709b52634a3bc903a49da5d312fec66690d1 Mon Sep 17 00:00:00 2001 From: Maciej Sypien Date: Sun, 17 Nov 2024 22:32:48 +0100 Subject: [PATCH 6/9] chore: update changelog --- CHANGELOG.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9bb8476..57edbfd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added +### Changed + +### Deprecated + +### Removed + +### Fixed + +### Security + +## [v2.0.0] + +### Added + - Added light and dark transparent themes [#18](https://github.com/egel/tmux-gruvbox/issues/18) - Added editorconfig - Added code linters for shellcheck & shfmt [#33](https://github.com/egel/tmux-gruvbox/issues/33) @@ -56,3 +70,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. [Unreleased]: https://github.com/egel/tmux-gruvbox/compare/v1.0.0...HEAD [1.0.0]: https://github.com/egel/tmux-gruvbox/compare/v0.0.0...v1.0.0 +[1.1.0]: https://github.com/egel/tmux-gruvbox/compare/v1.0.0...v1.1.0 +[2.0.0]: https://github.com/egel/tmux-gruvbox/compare/v1.1.0...v2.0.0 From 65d5df09095b93e787942f1246f2f7f557496560 Mon Sep 17 00:00:00 2001 From: Maciej Sypien Date: Sun, 1 Dec 2024 01:20:51 +0100 Subject: [PATCH 7/9] chore: clean changelog after release v2.0.0 --- CHANGELOG.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d68d407..57edbfd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,8 +15,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Removed -- Reduce repo weight by removing unused images [#41](https://github.com/egel/tmux-gruvbox/issues/41) - ### Fixed ### Security From 4f9b6dfb1d3677fd0d47511c00c490ec7a3adb8a Mon Sep 17 00:00:00 2001 From: pika Date: Tue, 11 Mar 2025 20:22:48 +0100 Subject: [PATCH 8/9] some small changes --- src/gruvbox-main.sh | 6 +++--- src/palette_gruvbox_dark256.sh | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/gruvbox-main.sh b/src/gruvbox-main.sh index 73601f9..eb93dc4 100755 --- a/src/gruvbox-main.sh +++ b/src/gruvbox-main.sh @@ -23,10 +23,10 @@ readonly TMUX_GRUVBOX_RIGHT_STAUTS_Z="@tmux-gruvbox-right-status-z" readonly DEFAULT_THEME="dark256" readonly DEFAULT_STATUSBAR_ALPHA='false' # defaults for theme option (with color interpolation) -readonly DEFAULT_LEFT_STATUS_A='#S' -readonly DEFAULT_RIGHT_STATUS_X='%Y-%m-%d' +readonly DEFAULT_LEFT_STATUS_A=' 󰊠 ' +readonly DEFAULT_RIGHT_STATUS_X='%d.%m.%Y' readonly DEFAULT_RIGHT_STATUS_Y='%H:%M' -readonly DEFAULT_RIGHT_STATUS_Z='#h' +readonly DEFAULT_RIGHT_STATUS_Z="$USER@#h " main() { TMUX_CMDS=() # clear diff --git a/src/palette_gruvbox_dark256.sh b/src/palette_gruvbox_dark256.sh index fe6c84d..47b3bb1 100644 --- a/src/palette_gruvbox_dark256.sh +++ b/src/palette_gruvbox_dark256.sh @@ -25,7 +25,7 @@ col_gray2=colour245 col_bg0_s=colour236 col_fg=colour223 col_fg4=colour246 -col_fg3=colour248 +col_fg3=colour167 col_fg2=colour250 col_fg1=colour223 col_fg0=colour229 From d23f35e9de4b47e4022e3a65c10644ca3fe5fbf7 Mon Sep 17 00:00:00 2001 From: pika Date: Tue, 11 Mar 2025 20:26:30 +0100 Subject: [PATCH 9/9] . --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e500514..e2169b0 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Add plugin at the top list of TPM plugins list in `.tmux.conf` and select desire set -g @plugin 'tmux-plugins/tpm' # mandatory set -g @plugin 'tmux-plugins/tmux-sensible' # optional recommended -set -g @plugin 'egel/tmux-gruvbox' +set -g @plugin 'https://git.k4li.de/mirrors/tmux-gruvbox' # set desired theme options... set -g @tmux-gruvbox 'dark' # or 'dark256', 'light', 'light256'