Skip to content

Allow devicons to be customised (use other nerdfont compatible plugins for glyphs and colors) #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 20, 2025
Merged

Allow devicons to be customised (use other nerdfont compatible plugins for glyphs and colors) #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4cbe343
Add option to set custom devicon glyph function
mmrwoods Feb 19, 2025
4c0f7db
Add option to set custom devicon color function
mmrwoods Feb 20, 2025
4395ec7
Regenerate vim docs from README
mmrwoods Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,35 @@ let g:fuzzyy_ripgrep_options = [
This option can also be set specifically for FuzzyFiles and/or FuzzyGrep using
`g:fuzzyy_files_ripgrep_options` and `g:fuzzyy_grep_ripgrep_options`

### g:fuzzyy_devicons_glyph_func
Specify a custom function for obtaining devicon glyphs from file names or paths.
By default Fuzzyy integrates with vim-devicons to obtain glyphs and measure byte
widths. You can use this option to obtain devicon glyphs from another nerdfont
compatible plugin, or your own custom function. Default ''
```vim
let g:fuzzyy_devicons_glyph_func = ''
```
Example usage
```vim
let g:fuzzyy_devicons_glyph_func = 'nerdfont#find'
```
The function should take a single string argument and return a single glyph.

### g:fuzzyy_devicons_color_func
Specify a custom function for colorizing devicon glyphs. By default Fuzzyy does
this with an internal function using a small set of common file name patterns
and colors, but you may want more extensive support for file name patterns not
recognised by Fuzzyy and to apply the same colors to Fuzzyy as other plugins.
Default ''
```vim
let g: fuzzyy_devicons_color_func = ''
```
Example usage
```vim
let g: fuzzyy_devicons_color_func = 'glyph_palette#apply'
```
The function should take no arguments and use matchadd() to add highlighting.

### g:fuzzyy_keymaps
Change navigation keymaps. The following are the defaults
```vim
Expand Down
33 changes: 24 additions & 9 deletions autoload/fuzzyy/utils/devicons.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,27 @@ vim9script

var devicon_char_width = 0
var devicon_byte_width = 0
if exists('g:WebDevIconsGetFileTypeSymbol')
var test_devicon = g:WebDevIconsGetFileTypeSymbol('a.lua')

# Options
var glyph_func = exists('g:fuzzyy_devicons_glyph_func') ? g:fuzzyy_devicons_glyph_func : (
exists('g:WebDevIconsGetFileTypeSymbol') ? 'g:WebDevIconsGetFileTypeSymbol' : ''
)
var color_func = exists('g:fuzzyy_devicons_color_func') ? g:fuzzyy_devicons_color_func : ''

export var enabled = exists('g:fuzzyy_devicons') && !empty(glyph_func) ?
g:fuzzyy_devicons : !empty(glyph_func)

export var GetDevicon: func
if !empty(glyph_func)
GetDevicon = function(glyph_func)
endif

if enabled
var test_devicon = GetDevicon('a.lua')
devicon_char_width = strcharlen(test_devicon)
devicon_byte_width = strlen(test_devicon)
endif

export var enabled = exists('g:fuzzyy_devicons')
&& exists('g:WebDevIconsGetFileTypeSymbol') ?
g:fuzzyy_devicons : exists('g:WebDevIconsGetFileTypeSymbol')

def SetHl()
hi fuzzyy_yellow ctermfg=215 guifg=#f5c06f
hi fuzzyy_blue ctermfg=109 guifg=#89b8c2
Expand Down Expand Up @@ -66,8 +77,12 @@ var devicons_color_table = {
var others_color = 'fuzzyy_yellow'

export def AddColor(wid: number)
if !empty(color_func)
win_execute(wid, color_func .. '()')
return
endif
for ft in keys(devicons_color_table)
var icon = g:WebDevIconsGetFileTypeSymbol(ft)
var icon = GetDevicon(ft)
var charnr = char2nr(icon)
var charhex = printf('%x', charnr)
try
Expand All @@ -87,10 +102,10 @@ enddef
export def AddDevicons(li: list<string>): list<string>
if !empty(li) && stridx(li[0], ':') != -1
map(li, (_, val) => {
return g:WebDevIconsGetFileTypeSymbol(split(val, ':')[0]) .. ' ' .. val
return GetDevicon(split(val, ':')[0]) .. ' ' .. val
})
else
map(li, 'g:WebDevIconsGetFileTypeSymbol(v:val) .. " " .. v:val')
map(li, 'GetDevicon(v:val) .. " " .. v:val')
endif
return li
enddef
47 changes: 42 additions & 5 deletions doc/fuzzyy.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@ CONTENTS *fuzzyy-contents*
1.7.9. g:fuzzyy_exclude_file..................|fuzzyy-g:fuzzyy_exclude_file|
1.7.10. g:fuzzyy_exclude_dir...................|fuzzyy-g:fuzzyy_exclude_dir|
1.7.11. g:fuzzyy_ripgrep_options...........|fuzzyy-g:fuzzyy_ripgrep_options|
1.7.12. g:fuzzyy_keymaps...........................|fuzzyy-g:fuzzyy_keymaps|
1.7.13. g:fuzzyy_buffers_exclude...........|fuzzyy-g:fuzzyy_buffers_exclude|
1.7.14. g:fuzzyy_buffers_keymap.............|fuzzyy-g:fuzzyy_buffers_keymap|
1.7.15. g:fuzzyy_window_layout...............|fuzzyy-g:fuzzyy_window_layout|
1.7.16. g:fuzzyy_async_step.....................|fuzzyy-g:fuzzyy_async_step|
1.7.12. g:fuzzyy_devicons_glyph_func...|fuzzyy-g:fuzzyy_devicons_glyph_func|
1.7.13. g:fuzzyy_devicons_color_func...|fuzzyy-g:fuzzyy_devicons_color_func|
1.7.14. g:fuzzyy_keymaps...........................|fuzzyy-g:fuzzyy_keymaps|
1.7.15. g:fuzzyy_buffers_exclude...........|fuzzyy-g:fuzzyy_buffers_exclude|
1.7.16. g:fuzzyy_buffers_keymap.............|fuzzyy-g:fuzzyy_buffers_keymap|
1.7.17. g:fuzzyy_window_layout...............|fuzzyy-g:fuzzyy_window_layout|
1.7.18. g:fuzzyy_async_step.....................|fuzzyy-g:fuzzyy_async_step|
1.8. Syntax highlighting..........................|fuzzyy-syntax_highlighting|

==============================================================================
Expand Down Expand Up @@ -313,6 +315,41 @@ Example usage
This option can also be set specifically for FuzzyFiles and/or FuzzyGrep using
`g:fuzzyy_files_ripgrep_options` and `g:fuzzyy_grep_ripgrep_options`

G:FUZZYY_DEVICONS_GLYPH_FUNC *fuzzyy-g:fuzzyy_devicons_glyph_func*

Specify a custom function for obtaining devicon glyphs from file names or paths.
By default Fuzzyy integrates with vim-devicons to obtain glyphs and measure byte
widths. You can use this option to obtain devicon glyphs from another nerdfont
compatible plugin, or your own custom function. Default ''
>
let g:fuzzyy_devicons_glyph_func = ''
<

Example usage
>
let g:fuzzyy_devicons_glyph_func = 'nerdfont#find'
<

The function should take a single string argument and return a single glyph.

G:FUZZYY_DEVICONS_COLOR_FUNC *fuzzyy-g:fuzzyy_devicons_color_func*

Specify a custom function for colorizing devicon glyphs. By default Fuzzyy does
this with an internal function using a small set of common file name patterns
and colors, but you may want more extensive support for file name patterns not
recognised by Fuzzyy and to apply the same colors to Fuzzyy as other plugins.
Default ''
>
let g: fuzzyy_devicons_color_func = ''
<

Example usage
>
let g: fuzzyy_devicons_color_func = 'glyph_palette#apply'
<

The function should take no arguments and use matchadd() to add highlighting.

G:FUZZYY_KEYMAPS *fuzzyy-g:fuzzyy_keymaps*

Change navigation keymaps. The following are the defaults
Expand Down