lambdalisue / vim-nerdfont Goto Github PK

👓 Fundemental plugin to handle Nerd Fonts in Vim

License: MIT License

Shell 2.10% Vim Script 97.90%

vim-nerdfont's Introduction

👓 nerdfont.vim

A simplified version of vim-devicons which does NOT provide any 3rd party integrations in itself. In otherwords, it is a fundemental plugin to handle Nerd Fonts from Vim.

With fern.vim + fern-renderer-nerdfont.vim. All glyphs above were powered by this plugin

Usage

First of all, make sure one of Nerd Fonts is used in your Vim. After that, use nerdfont#find() function to find a glyph for the current filetype like:

echo nerdfont#find()


Or specify a path to find a glyph for a particular path like:

echo nerdfont#find(expand('~/.vimrc'))

echo nerdfont#find(expand('~/.vim'))


Above automatically check if the specified path is directory. To avoid that, specify the second argument to tell if the path is directory or not like:

echo nerdfont#find(expand('~/.vimrc'), 0)

echo nerdfont#find(expand('~/.vimrc'), 1)


See :help nerdfont-function to find glyphs for directory, fileformat, platform, etc.

Contribution

If you would like to add new glyph/filetype supports, see the following files

If	Where
Want to add new extension (e.g. `.js`)	`assets/json/extension.json`
Want to add new exact name (e.g. `Makefile`)	`assets/json/basename.json`
Want to add new complex pattern (e.g. `./bin/.$`)	`assets/json/pattern.json`

Integrations

See Integration section of Wiki.

License

The glyph mappings has copied from vim-devicons thus the part follow the license of vim-devicons (LICENSE.vim-devicons). Other parts are MIT license explained in LICENSE.

vim-nerdfont's People

Contributors

Stargazers

Watchers

Forkers

raa0121 lu5je0 bakudankun csch0 get-me-power watcol kat0h shiftwinting artificial-equation aspulse creativenull sevenc-nanashi ksaito422 hashitaku obergodmar leafoftree

vim-nerdfont's Issues

Add LS_COLOR support

It would be nice to have LS_COLOR support, or any of the same kind to have color depending on the file type.

Vue icon is broken

Hey. Vue icon is broken. However it works in airline.

vim
st-terminal
freebsd

Add API to get icon from the value of 'filetype'

I want to get icons from the value of &filetype of buffers, e.g. cpp, help, qf, dosbatch etc. to indicate what filetype is set to the buffer.
I'd be glad if this plugin have such API.

[feature] Add gentoo

https://github.com/ryanoasis/vim-devicons/blob/master/plugin/webdevicons.vim#L105

a2ac4d9 breaks existing cellwidth settings

After a2ac4d9 , nerdfont.vim breaks cellwidth setting by setcellwidth() called elsewhere.
Because of setcellwidth() behavior that overwrites existing settings.
sample script is here.

set ambiwidth=single

" ● → 0x25cf

call setcellwidths([[0x25cf, 0x25cf, 2]])

" ● is displayed double width.

call nerdfont#cellwidths#fix()

" ● is now displayed sigle width.

thanks.

index d51c479..c773c6d 100644
--- a/autoload/nerdfont/path/basename.vim
+++ b/autoload/nerdfont/path/basename.vim
@@ -14,6 +14,7 @@ let g:nerdfont#path#basename#defaults = {
       \ '_gvimrc'                          : '',
       \ '_vimrc'                           : '',
       \ 'cmakelists.txt'                   : '',
+      \ 'requirements.txt'                 : '',
       \ 'config.ru'                        : '',
       \ 'docker-compose.yml'               : '',
       \ 'dockerfile'                       : '',
diff --git a/autoload/nerdfont/path/extension.vim b/autoload/nerdfont/path/extension.vim
index 1afbf5a..c2b445e 100644
--- a/autoload/nerdfont/path/extension.vim
+++ b/autoload/nerdfont/path/extension.vim
@@ -10,6 +10,7 @@ let g:nerdfont#path#extension#defaults = {
       \ 'c'        : '',
       \ 'c++'      : '',
       \ 'cc'       : '',
+      \ 'cu'       : '',
       \ 'clj'      : '',
       \ 'cljc'     : '',
       \ 'cljs'     : '',
@@ -44,6 +45,7 @@ let g:nerdfont#path#extension#defaults = {
       \ 'gif'      : '',
       \ 'go'       : '',
       \ 'h'        : '',
+      \ 'cuh'      : '',
       \ 'haml'     : '',
       \ 'hbs'      : '',
       \ 'hh'       : '',

requirements.txt is the configuration of python, and cu and cuh are cuda's c source file and header file.

I found a reference: https://github.com/Peltoche/lsd/blob/master/src/icon.rs#L102 or https://github.com/ogham/exa/blob/master/src/output/icons.rs. Maybe we can do more?

[advice] Use json to store `g:nerdfont#path#{extension|pattern|basename}#defaults`

It is easier to edit even for those contributors is not familiar with vim script
It is easier to compare the difference between this project's icon and other projects which provide icon display, so we can add icons more easily.
It is easier to sort json by jq

Just my 2c, TIA!