feat: allow language icon to be disabled while still showing language name

MeanderingProgrammer · MeanderingProgrammer · commit 8ee2701a6c4c · 2025-03-24T20:07:33.000-07:00
## Details Request: #376 Adds configuration option `code.language_icon` which works with the existing `code.language_name` option. This option is enabled by default so the behavior is identical to what it was before. This changes the behavior if an icon is not available for a particular language. Rather than adding an empty border (old behavior) we now add a line with just the language name. Since the icon provider previously gave us the highlight to use and it could be missing, we now need a fallback. This is set by the new `code.highlight_fallback` option which by default links to the `Normal` highlight group. To make this work is mostly minor implementation details. Continue processing the language even if the icon returned from the provider is missing. After creating the virtual text line check if it's empty before adding it, this would happen if `language_name = false` and there is no icon available. Other minor differences in behavior, but these only impact users who do NOT have the language details concealed, likely by NOT enabling `nvim-treesitter` highlights + these options: - `position = 'left'`: the language name is added after the icon, rather than being skipped by default, to avoid adding the name users will now have to set `language_name = false`, which will add only the icon - `position = 'left'` + `language_padding > 0`: the padding is now added, previously we would skip adding the padding
diff --git a/README.md b/README.md
@@ -388,7 +388,9 @@ require('render-markdown').setup({
         -- Amount of padding to add around the language.
         -- If a float < 1 is provided it is treated as a percentage of available window space.
         language_pad = 0,
-        -- Whether to include the language name next to the icon.
+        -- Whether to include the language icon above code blocks.
+        language_icon = true,
+        -- Whether to include the language name above code blocks.
         language_name = true,
         -- A list of language names for which background highlighting will be disabled.
         -- Likely because that language has background highlights itself.
@@ -424,6 +426,8 @@ require('render-markdown').setup({
         highlight = 'RenderMarkdownCode',
         -- Highlight for language, overrides icon provider value.
         highlight_language = nil,
+        -- Highlight for language, used if icon provider does not have a value.
+        highlight_fallback = 'RenderMarkdownCodeFallback',
         -- Padding to add to the left & right of inline code.
         inline_pad = 0,
         -- Highlight for inline code.
@@ -933,7 +937,9 @@ require('render-markdown').setup({
         -- Amount of padding to add around the language.
         -- If a float < 1 is provided it is treated as a percentage of available window space.
         language_pad = 0,
-        -- Whether to include the language name next to the icon.
+        -- Whether to include the language icon above code blocks.
+        language_icon = true,
+        -- Whether to include the language name above code blocks.
         language_name = true,
         -- A list of language names for which background highlighting will be disabled.
         -- Likely because that language has background highlights itself.
@@ -969,6 +975,8 @@ require('render-markdown').setup({
         highlight = 'RenderMarkdownCode',
         -- Highlight for language, overrides icon provider value.
         highlight_language = nil,
+        -- Highlight for language, used if icon provider does not have a value.
+        highlight_fallback = 'RenderMarkdownCodeFallback',
         -- Padding to add to the left & right of inline code.
         inline_pad = 0,
         -- Highlight for inline code.
@@ -1403,6 +1411,7 @@ The table below shows all the highlight groups with their default link
 | RenderMarkdownH5Bg            | DiffDelete                         | H5 background line         |
 | RenderMarkdownH6Bg            | DiffDelete                         | H6 background line         |
 | RenderMarkdownCode            | ColorColumn                        | Code block background      |
+| RenderMarkdownCodeFallback    | Normal                             | Fallback for code language |
 | RenderMarkdownCodeInline      | RenderMarkdownCode                 | Inline code background     |
 | RenderMarkdownInlineHighlight | RenderMarkdownCodeInline           | Inline highlights contents |
 | RenderMarkdownBullet          | Normal                             | List item bullet points    |
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -453,7 +453,9 @@ Default Configuration ~
             -- Amount of padding to add around the language.
             -- If a float < 1 is provided it is treated as a percentage of available window space.
             language_pad = 0,
-            -- Whether to include the language name next to the icon.
+            -- Whether to include the language icon above code blocks.
+            language_icon = true,
+            -- Whether to include the language name above code blocks.
             language_name = true,
             -- A list of language names for which background highlighting will be disabled.
             -- Likely because that language has background highlights itself.
@@ -489,6 +491,8 @@ Default Configuration ~
             highlight = 'RenderMarkdownCode',
             -- Highlight for language, overrides icon provider value.
             highlight_language = nil,
+            -- Highlight for language, used if icon provider does not have a value.
+            highlight_fallback = 'RenderMarkdownCodeFallback',
             -- Padding to add to the left & right of inline code.
             inline_pad = 0,
             -- Highlight for inline code.
@@ -992,7 +996,9 @@ Code Block Configuration ~
             -- Amount of padding to add around the language.
             -- If a float < 1 is provided it is treated as a percentage of available window space.
             language_pad = 0,
-            -- Whether to include the language name next to the icon.
+            -- Whether to include the language icon above code blocks.
+            language_icon = true,
+            -- Whether to include the language name above code blocks.
             language_name = true,
             -- A list of language names for which background highlighting will be disabled.
             -- Likely because that language has background highlights itself.
@@ -1028,6 +1034,8 @@ Code Block Configuration ~
             highlight = 'RenderMarkdownCode',
             -- Highlight for language, overrides icon provider value.
             highlight_language = nil,
+            -- Highlight for language, used if icon provider does not have a value.
+            highlight_fallback = 'RenderMarkdownCodeFallback',
             -- Padding to add to the left & right of inline code.
             inline_pad = 0,
             -- Highlight for inline code.
@@ -1459,6 +1467,9 @@ The table below shows all the highlight groups with their default link
   RenderMarkdownCode              ColorColumn                          Code block
                                                                        background
 
+  RenderMarkdownCodeFallback      Normal                               Fallback for code
+                                                                       language
+
   RenderMarkdownCodeInline        RenderMarkdownCode                   Inline code
                                                                        background
 
diff --git a/lua/render-markdown/colors.lua b/lua/render-markdown/colors.lua
@@ -29,9 +29,11 @@ M.colors = {
     H4Bg            = 'DiffDelete',
     H5Bg            = 'DiffDelete',
     H6Bg            = 'DiffDelete',
-    -- General
+    -- Code
     Code            = 'ColorColumn',
+    CodeFallback    = 'Normal',
     CodeInline      = 'RenderMarkdownCode',
+    -- General
     InlineHighlight = 'RenderMarkdownCodeInline',
     Bullet          = 'Normal',
     Quote           = '@markup.quote',
diff --git a/lua/render-markdown/health.lua b/lua/render-markdown/health.lua
@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.1.10'
+M.version = '8.1.11'
 
 function M.check()
     M.start('version')
diff --git a/lua/render-markdown/init.lua b/lua/render-markdown/init.lua
@@ -208,6 +208,7 @@ local M = {}
 ---@field style? render.md.code.Style
 ---@field position? render.md.code.Position
 ---@field language_pad? number
+---@field language_icon? boolean
 ---@field language_name? boolean
 ---@field disable_background? boolean|string[]
 ---@field width? render.md.code.Width
@@ -220,6 +221,7 @@ local M = {}
 ---@field below? string
 ---@field highlight? string
 ---@field highlight_language? string
+---@field highlight_fallback? string
 ---@field inline_pad? integer
 ---@field highlight_inline? string
 
@@ -549,7 +551,9 @@ M.default_config = {
         -- Amount of padding to add around the language.
         -- If a float < 1 is provided it is treated as a percentage of available window space.
         language_pad = 0,
-        -- Whether to include the language name next to the icon.
+        -- Whether to include the language icon above code blocks.
+        language_icon = true,
+        -- Whether to include the language name above code blocks.
         language_name = true,
         -- A list of language names for which background highlighting will be disabled.
         -- Likely because that language has background highlights itself.
@@ -585,6 +589,8 @@ M.default_config = {
         highlight = 'RenderMarkdownCode',
         -- Highlight for language, overrides icon provider value.
         highlight_language = nil,
+        -- Highlight for language, used if icon provider does not have a value.
+        highlight_fallback = 'RenderMarkdownCodeFallback',
         -- Padding to add to the left & right of inline code.
         inline_pad = 0,
         -- Highlight for inline code.
diff --git a/lua/render-markdown/render/code.lua b/lua/render-markdown/render/code.lua
@@ -99,8 +99,8 @@ function Render:render()
 
     local icon = self:language()
     local start_row, end_row = self.node.start_row, self.node.end_row - 1
-    self:border(start_row, self.code.above, not icon and self:concealed(self.data.code_node))
-    self:border(end_row, self.code.below, true)
+    self:border(start_row, true, not icon and self:concealed(self.data.code_node))
+    self:border(end_row, false, true)
     if background then
         self:background(start_row + 1, end_row - 1)
     end
@@ -113,6 +113,9 @@ function Render:language()
     if not vim.tbl_contains({ 'language', 'full' }, self.code.style) then
         return false
     end
+    if not self.code.language_icon and not self.code.language_name then
+        return false
+    end
 
     local node, padding = self.data.language_node, self.data.language_padding
     if node == nil then
@@ -123,58 +126,61 @@ function Render:language()
     if self.code.highlight_language ~= nil then
         icon_highlight = self.code.highlight_language
     end
-    if icon == nil or icon_highlight == nil then
-        return false
-    end
 
     self:sign(self.code.sign, icon, icon_highlight)
 
-    local text, highlight = icon .. ' ', { icon_highlight }
+    local text = ''
+    if self.code.language_icon and icon ~= nil then
+        text = text .. icon .. ' '
+    end
+    if self.code.language_name then
+        text = text .. node.text
+    end
+    if #text == 0 then
+        return false
+    end
+
+    local highlight = { icon_highlight or self.code.highlight_fallback }
     if self.code.border ~= 'none' then
         table.insert(highlight, self.code.highlight)
     end
 
     if self.code.position == 'left' then
-        if self.code.language_name and self:concealed(node) then
-            -- Code blocks pick up varying amounts of leading white space depending
-            -- on the context they are in. This is lumped into the delimiter node
-            -- and as a result, after concealing, the extmark would be shifted.
-            local spaces = Str.spaces('start', self.node.text)
-            text = Str.pad(spaces + padding) .. text .. node.text
+        text = Str.pad(padding) .. text
+        if self:concealed(node) then
+            -- Code blocks can pick up varying amounts of leading white space.
+            -- This is lumped into the delimiter node and needs to be handled.
+            text = Str.pad(Str.spaces('start', self.node.text)) .. text
         end
         return self.marks:add('code_language', node.start_row, node.start_col, {
             virt_text = { { text, highlight } },
             virt_text_pos = 'inline',
         })
-    elseif self.code.position == 'right' then
-        if self.code.language_name then
-            text = text .. node.text
-        end
-        local win_col = self.data.max_width - padding
+    else
+        local start = self.data.max_width - padding
         if self.code.width == 'block' then
-            win_col = win_col - Str.width(text)
+            start = start - Str.width(text)
         end
         return self.marks:add('code_language', node.start_row, 0, {
             virt_text = { { text, highlight } },
-            virt_text_win_col = win_col + self.data.indent,
+            virt_text_win_col = start + self.data.indent,
         })
-    else
-        return false
     end
 end
 
 ---@private
 ---@param row integer
----@param border string
----@param context_hidden boolean
-function Render:border(row, border, context_hidden)
+---@param above boolean
+---@param empty boolean
+function Render:border(row, above, empty)
     if self.code.border == 'none' then
         return
     end
-    local delim_node = self.node:child('fenced_code_block_delimiter', row)
-    if self.code.border == 'thin' and context_hidden and self:concealed(delim_node) then
-        local width = self.data.width - self.data.col
-        local line = { { border:rep(width), colors.bg_to_fg(self.code.highlight) } }
+    local delim = self.node:child('fenced_code_block_delimiter', row)
+    local width, highlight = self.data.width - self.data.col, self.code.highlight
+    local border = above and self.code.above or self.code.below
+    if self.code.border == 'thin' and empty and self:concealed(delim) then
+        local line = { { border:rep(width), colors.bg_to_fg(highlight) } }
         self.marks:add('code_border', row, self.data.col, {
             virt_text = line,
             virt_text_pos = 'overlay',
diff --git a/lua/render-markdown/state.lua b/lua/render-markdown/state.lua
@@ -188,10 +188,10 @@ function M.validate()
             end)
             :nested('code', function(code)
                 component_rules(code)
-                    :type({ 'sign', 'language_name' }, 'boolean')
+                    :type({ 'sign', 'language_icon', 'language_name' }, 'boolean')
                     :type({ 'language_pad', 'left_margin', 'left_pad', 'right_pad', 'min_width' }, 'number')
                     :type('inline_pad', 'number')
-                    :type({ 'above', 'below', 'highlight', 'highlight_inline' }, 'string')
+                    :type({ 'above', 'below', 'highlight', 'highlight_fallback', 'highlight_inline' }, 'string')
                     :type('highlight_language', { 'string', 'nil' })
                     :list('disable_background', 'string', 'boolean')
                     :one_of('style', { 'full', 'normal', 'language', 'none' })
diff --git a/lua/render-markdown/types.lua b/lua/render-markdown/types.lua
@@ -139,6 +139,7 @@
 ---@field style render.md.code.Style
 ---@field position render.md.code.Position
 ---@field language_pad number
+---@field language_icon boolean
 ---@field language_name boolean
 ---@field disable_background boolean|string[]
 ---@field width render.md.code.Width
@@ -151,6 +152,7 @@
 ---@field below string
 ---@field highlight string
 ---@field highlight_language? string
+---@field highlight_fallback string
 ---@field inline_pad integer
 ---@field highlight_inline string
 
