feat(previewer): improve bat theme

[linrongbin16]

The tmTheme

1. the .tmTheme: https://www.sublimetext.com/docs/color_schemes_tmtheme.html
2. convert tmTheme to vim:
   1. https://github.com/ku1ik/coloration/blob/eca9d85b4df41dd2399e0065714fc8715306f591/lib/coloration/writers/vim_theme_writer.rb
   2. https://gist.github.com/jojonas/fb7a26ccdaa721afa3fe
3. convert vim syntax to tmTheme: https://stackoverflow.com/questions/28592093/converting-emacs-vim-highlighting-to-textmate-for-sublimetext
4. sublime tmTheme:
   1. globals: https://www.sublimetext.com/docs/color_schemes.html#global-settings
   2. minimal coverage: https://www.sublimetext.com/docs/scope_naming.html#minimal-scope-coverage

Theme Implementations

1. base16 theme:
   1. bat base16 theme: https://github.com/sharkdp/bat/blob/master/assets/themes/base16.tmTheme
   2. vim-base16: https://github.com/chriskempson/base16-vim/
   3. textmate-base16: https://github.com/chriskempson/base16-textmate/blob/master/Themes/base16-default-dark.tmTheme
2. dracula theme:
   1. tmTheme: https://github.com/dracula/sublime/blob/09faa29057c3c39e9a45f3a51a5e262375e3bf9f/Dracula.tmTheme
   2. vim:
      • https://github.com/dracula/vim/blob/master/colors/dracula.vim
      • https://github.com/dracula/vim/blob/master/autoload/dracula.vim
3. rose-pine theme:
   1. sublime: https://github.com/rose-pine/sublime-text/blob/main/rose-pine.sublime-color-scheme
   2. vim: https://github.com/rose-pine/vim/blob/main/colors/rosepine.vim
4. catppuccin theme:
   1. sublime: https://github.com/catppuccin/sublime-text/blob/main/Catppuccin%20Mocha.sublime-color-scheme
   2. vim: https://github.com/catppuccin/vim/blob/main/colors/catppuccin_mocha.vim

Regresion test

Platforms

• [ ] windows
• [ ] macOS
• [ ] linux

Tasks

• [ ] FzfxFiles
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-R to switch between restricted/unrestricted mode, and the lines count is consistent when press multiple times.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file, and open the test/hello world.txt, test/goodbye world/goodbye.lua files.
  • Both fd and find works.
• [ ] FzfxLiveGrep
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-R to switch between restricted/unrestricted mode, and the lines count is consistent when press multiple times.
  • Use -w to match word only, use -g *.lua to search only lua files.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file, and open the test/hello world.txt, test/goodbye world/goodbye.lua files.
  • Both rg and grep works.
• [ ] FzfxBuffers
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-D to delete buffers, and delete the test/hello world.txt, test/goodbye world/goodbye.lua buffers.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [ ] FzfxGFiles
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-W to switch between workspace/current folder mode.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [ ] FzfxGLiveGrep
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [ ] FzfxGStatus
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-W to switch between workspace/current folder mode.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
  • Both with/without delta works.
• [ ] FzfxGBranches
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-R/CTRL-O to switch between local/remote branches.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to checkout branch.
• [ ] FzfxGCommits
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-A to switch between git repo commits/current buffer commits.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to copy commit hash.
  • Both with/without delta works.
• [ ] FzfxGBlame
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to copy commit hash.
  • Both with/without delta works.
• [ ] FzfxLspDiagnostics
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-W to switch between workspace/current buffer diagnostics.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file.
• [ ] FzfxLspDefinitions, FzfxLspTypeDefinitions, FzfxLspReferences, FzfxLspImplementations
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Go to definitions/references (this is the most 2 easiest use case when developing this lua plugin with lua_ls).
  • Press ESC to quit, ENTER to open file.
• [ ] FzfxLspIncomingCalls, FzfxLspOutgoingCalls
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Go to incoming/outgoing calls.
  • Press ESC to quit, ENTER to open file.
• [ ] FzfxCommands
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-E/CTRL-A to switch between user/ex/all vim commands.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to feed vim command.
• [ ] FzfxKeyMaps
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-O/CTRL-I/CTRL-A/CTRL-V to switch between normal/insert/visual/all vim key mappings.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to feed vim keys.
• [ ] FzfxFileExplorer
  • Press CTRL-J/CTRL-K to move down/up and preview contents.
  • Press CTRL-U/CTRL-R to switch between filter/include hidden files mode.
  • Press ALT-L/ALT-H to cd into folder and cd upper folder.
  • Use V/W/P/R variants (visual selection, cursor word, yank text, resume last).
  • Press ESC to quit, ENTER to open file, and open the test/hello world.txt, test/goodbye world/goodbye.lua files.
  • All eza/lsd/ls works.

[codecov[bot]]

Codecov Report

Attention: 134 lines in your changes are missing coverage. Please review.

Comparison is base (e5df3c5) 77.19% compared to head (4fa4ee2) 76.23%.

Files	Patch %	Lines
lua/fzfx/lib/bat_themes.lua	61.95%	113 Missing :warning:
lua/fzfx/detail/bat_helpers.lua	47.05%	18 Missing :warning:
lua/fzfx/helper/previewers.lua	66.66%	2 Missing :warning:
lua/fzfx/detail/fzf_helpers.lua	66.66%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #557 +/- ## ========================================== - Coverage 77.19% 76.23% -0.96% ========================================== Files 48 50 +2 Lines 5512 5850 +338 ========================================== + Hits 4255 4460 +205 - Misses 1257 1390 +133 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[linrongbin16]

The colors looks better, but not precisely enough.

---

update: the color looks better and better, it seems all we need to do, is trying to convert vim syntax color codes into the sublime tmTheme.

[linrongbin16]

There's an issue that makes this PR works bad.

For lua keyword local, now this PR will create colors from vim highlighting Keyword to tmTheme keyword.

But treesitter will create highlighting @variable.lua and change the colors for keyword local. So the tmTheme is not working correctly on some highlightings.

see:

• discussion: https://matrix.to/#/!FhgNqRstfUdQbenRoN:matrix.org/$Uc63PwnHa3EjMvsVcl04xmgoMHuJRBq0wyil-WTub9o?via=libera.chat&via=matrix.org&via=gitter.im
• https://neovim.io/doc/user/treesitter.html#treesitter-highlight

[linrongbin16]

I feel like it's technically impossible to map neovim's highlightings to tmTheme, they seem not compatible.

---

update:

I find more docs, they have much better explaination on tm themes, so I will continue try again to improve the colors precision in this PR:

• https://dbanks.design/blog/vs-code-theme-with-style-dictionary/
• https://github.com/gwenzek/sublime-syntax-manifesto/blob/master/TextMateRules.md
• https://github.com/bathos/Ecmascript-Sublime/?tab=readme-ov-file#themes
• https://forum.sublimetext.com/t/a-convention-for-scope-naming/17105/10
• https://github.com/microsoft/vscode-discussions/discussions/1029#discussioncomment-8250746

[savchenko]

Is this necessary in light of https://github.com/linrongbin16/fzfx.nvim/pull/556 ?..

Use native nVim highlights == avoid the penalty of translation to tmTheme.

[linrongbin16]

Is this necessary in light of #556 ?..

Use native nVim highlights == avoid the penalty of translation to tmTheme.

yes, they are two alternative solutions to preview file contents.

The #556 should be first priority, but if I am confident that the tmTheme is mapping precisely, I may also merge this PR.

This is only for bat, #556 is for nvim buffer. They are not conflict.

The nvim buffer has best color support, while bat has best performance. If I could make the performance of #556 as good as bat, I could drop this PR.

[savchenko]

The https://github.com/linrongbin16/fzfx.nvim/pull/556 should be first priority, but if I am confident that the tmTheme is mapping precisely, I may also merge this PR.

That's interesting. Would it be possible to export "converted" nVIm theme to a tmTHeme file?

This way users can put the resulting file in ~/.config/bat/themes, run bat cache --build and enjoy the consistent highlighting in their favourite text editor and terminal.

[linrongbin16]

The #556 should be first priority, but if I am confident that the tmTheme is mapping precisely, I may also merge this PR.

That's interesting. Would it be possible to export "converted" nVIm theme to a tmTHeme file?

This way users can put the resulting file in ~/.config/bat/themes, run bat cache --build and enjoy the consistent highlighting in their favourite text editor and terminal.

that's exactly I am doing in this PR.

but the docs about tmTheme is quite limited, and I am not an expert about tmTheme.

For now it looks 85% close to nvim highlighting.

But I improved the performance in #556 again yesterday, maybe this PR could be close.

[savchenko]

that's exactly I am doing in this PR. For now it looks 85% close to nvim highlighting.

This would be huge! Please keep it, at least as a function that user can call independently to generate a bat theme from their nVim colourscheme. Happy to test on my heavily modified Kanagawa theme.

[linrongbin16]

Hope there's experts who knows well on both tmTheme and Neovim highlights and save me.

I will merge this into main branch now. it's so difficult to make the highlights 100% same between nvim and bat previewer.