Add support for mini.icons, prefer when available

MeanderingProgrammer · MeanderingProgrammer · commit 353e4459938d · 2024-07-05T23:11:55.000-07:00
# Details

mini.icons seems to support a wider range of language icons
than nvim-web-devicons. Add logic to prefer icons from mini.icons
when available, otherwise continue using nvim-web-devicons. Update
documentation and tests accordingly.
diff --git a/README.md b/README.md
@@ -37,8 +37,9 @@ Plugin to improve viewing Markdown files in Neovim
     Used to parse `markdown` files
   - [latex](https://github.com/latex-lsp/tree-sitter-latex) (Optional):
     Used to get `LaTeX` blocks from `markdown` files
-- [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) (Optional):
-  Used for icon above code blocks
+- Icon provider plugin (Optional): Used for icon above code blocks
+  - [mini.icons](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-icons.md)
+  - [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
 - System dependencies:
   - [pylatexenc](https://pypi.org/project/pylatexenc/) (Optional):
     Used to transform `LaTeX` strings to appropriate unicode using `latex2text`
@@ -51,10 +52,9 @@ Plugin to improve viewing Markdown files in Neovim
 {
     'MeanderingProgrammer/markdown.nvim',
     name = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
-    dependencies = {
-        'nvim-treesitter/nvim-treesitter', -- Mandatory
-        'nvim-tree/nvim-web-devicons', -- Optional but recommended
-    },
+    dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' }, -- if you use the mini.nvim suite
+    -- dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.icons' }, -- if you use standalone mini plugins
+    -- dependencies = { 'nvim-treesitter/nvim-treesitter', 'nvim-tree/nvim-web-devicons' }, -- if you prefer nvim-web-devicons
     config = function()
         require('render-markdown').setup({})
     end,
@@ -67,8 +67,10 @@ Plugin to improve viewing Markdown files in Neovim
 use({
     'MeanderingProgrammer/markdown.nvim',
     as = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
-    after = { 'nvim-treesitter' }, -- Mandatory
-    requires = { 'nvim-tree/nvim-web-devicons', opt = true }, -- Optional but recommended
+    after = { 'nvim-treesitter' },
+    requires = { 'echasnovski/mini.nvim', opt = true }, -- if you use the mini.nvim suite
+    -- requires = { 'echasnovski/mini.icons', opt = true }, -- if you use standalone mini plugins
+    -- requires = { 'nvim-tree/nvim-web-devicons', opt = true }, -- if you prefer nvim-web-devicons
     config = function()
         require('render-markdown').setup({})
     end,
diff --git a/demo/callout.gif b/demo/callout.gif
diff --git a/demo/heading_code.gif b/demo/heading_code.gif
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -58,8 +58,9 @@ Plugin to improve viewing Markdown files in Neovim
         Used to parse `markdown` files
     - latex <https://github.com/latex-lsp/tree-sitter-latex> (Optional):
         Used to get `LaTeX` blocks from `markdown` files
-- nvim-web-devicons <https://github.com/nvim-tree/nvim-web-devicons> (Optional):
-    Used for icon above code blocks
+- Icon provider plugin (Optional): Used for icon above code blocks
+    - mini.icons <https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-icons.md>
+    - nvim-web-devicons <https://github.com/nvim-tree/nvim-web-devicons>
 - System dependencies:
     - pylatexenc <https://pypi.org/project/pylatexenc/> (Optional):
         Used to transform `LaTeX` strings to appropriate unicode using `latex2text`
@@ -75,10 +76,9 @@ LAZY.NVIM                                  *render-markdown-install-lazy.nvim*
     {
         'MeanderingProgrammer/markdown.nvim',
         name = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
-        dependencies = {
-            'nvim-treesitter/nvim-treesitter', -- Mandatory
-            'nvim-tree/nvim-web-devicons', -- Optional but recommended
-        },
+        dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' }, -- if you use the mini.nvim suite
+        -- dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.icons' }, -- if you use standalone mini plugins
+        -- dependencies = { 'nvim-treesitter/nvim-treesitter', 'nvim-tree/nvim-web-devicons' }, -- if you prefer nvim-web-devicons
         config = function()
             require('render-markdown').setup({})
         end,
@@ -92,8 +92,10 @@ PACKER.NVIM                              *render-markdown-install-packer.nvim*
     use({
         'MeanderingProgrammer/markdown.nvim',
         as = 'render-markdown', -- Only needed if you have another plugin named markdown.nvim
-        after = { 'nvim-treesitter' }, -- Mandatory
-        requires = { 'nvim-tree/nvim-web-devicons', opt = true }, -- Optional but recommended
+        after = { 'nvim-treesitter' },
+        requires = { 'echasnovski/mini.nvim', opt = true }, -- if you use the mini.nvim suite
+        -- requires = { 'echasnovski/mini.icons', opt = true }, -- if you use standalone mini plugins
+        -- requires = { 'nvim-tree/nvim-web-devicons', opt = true }, -- if you prefer nvim-web-devicons
         config = function()
             require('render-markdown').setup({})
         end,
diff --git a/lua/render-markdown/icons.lua b/lua/render-markdown/icons.lua
@@ -1,12 +1,16 @@
-local ok, devicons = pcall(require, 'nvim-web-devicons')
+local has_mini_icons, mini_icons = pcall(require, 'mini.icons')
+local has_devicons, devicons = pcall(require, 'nvim-web-devicons')
 
 local M = {}
 
 ---@param language string
 ---@return string?
 ---@return string?
 M.get = function(language)
-    if ok then
+    if has_mini_icons then
+        ---@diagnostic disable-next-line: return-type-mismatch
+        return mini_icons.get('filetype', language)
+    elseif has_devicons then
         return devicons.get_icon_by_filetype(language)
     else
         return nil, nil
diff --git a/tests/callout_spec.lua b/tests/callout_spec.lua
@@ -107,7 +107,7 @@ async_tests.describe('callout.md', function()
             {
                 row = { tip_start + 4 },
                 col = { 5 },
-                virt_text = { { ' lua', { 'DevIconLua', 'ColorColumn' } } },
+                virt_text = { { '󰢱 lua', { 'MiniIconsAzure', 'ColorColumn' } } },
                 virt_text_pos = 'inline',
             },
             {
diff --git a/tests/heading_code_spec.lua b/tests/heading_code_spec.lua
@@ -62,7 +62,7 @@ async_tests.describe('heading_code.md', function()
             {
                 row = { 10 },
                 col = { 3 },
-                virt_text = { { ' python', { 'DevIconPy', 'ColorColumn' } } },
+                virt_text = { { '󰌠 python', { 'MiniIconsYellow', 'ColorColumn' } } },
                 virt_text_pos = 'inline',
             },
         })
diff --git a/tests/minimal.lua b/tests/minimal.lua
@@ -1,11 +1,13 @@
 ---@param path_name string
----@param plugin_name string
+---@param plugin_name string?
 local function source_plugin(path_name, plugin_name)
     local data_path = vim.fn.stdpath('data')
     assert(type(data_path) == 'string')
     local plugin_path = vim.fs.find(path_name, { path = data_path })
     vim.opt.rtp:prepend(unpack(plugin_path))
-    vim.cmd.runtime('plugin/' .. plugin_name)
+    if plugin_name ~= nil then
+        vim.cmd.runtime('plugin/' .. plugin_name)
+    end
 end
 
 ---@param required_parsers string[]
@@ -22,7 +24,7 @@ end
 vim.opt.rtp:prepend('.')
 source_plugin('plenary.nvim', 'plenary.vim')
 source_plugin('nvim-treesitter', 'nvim-treesitter.lua')
-source_plugin('nvim-web-devicons', 'nvim-web-devicons.vim')
+source_plugin('mini.nvim', nil)
 
 -- https://github.com/ThePrimeagen/refactoring.nvim/blob/master/scripts/minimal.vim
 ensure_installed({ 'markdown', 'markdown_inline', 'latex' })

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ async_tests.describe('callout.md', function()`
`107`	`107`	`{`
`108`	`108`	`row = { tip_start + 4 },`
`109`	`109`	`col = { 5 },`
`110`		`- virt_text = { { ' lua', { 'DevIconLua', 'ColorColumn' } } },`
	`110`	`+ virt_text = { { '󰢱 lua', { 'MiniIconsAzure', 'ColorColumn' } } },`
`111`	`111`	`virt_text_pos = 'inline',`
`112`	`112`	`},`
`113`	`113`	`{`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ async_tests.describe('heading_code.md', function()`
`62`	`62`	`{`
`63`	`63`	`row = { 10 },`
`64`	`64`	`col = { 3 },`
`65`		`- virt_text = { { ' python', { 'DevIconPy', 'ColorColumn' } } },`
	`65`	`+ virt_text = { { '󰌠 python', { 'MiniIconsYellow', 'ColorColumn' } } },`
`66`	`66`	`virt_text_pos = 'inline',`
`67`	`67`	`},`
`68`	`68`	`})`