feat: add renderer.highlight_hidden, renderer.icons.show.hidden and renderer.icons.hidden_placement for dotfile icons/highlights #2840

evertonse · 2024-07-16T04:27:38Z

PR Description

This PR introduces the ability to highlight hidden files (dotfiles) by creating three new highlight groups:

  -- Hidden
  { group = "NvimTreeHiddenIcon", link = "NvimTreeSignColumn" },
  { group = "NvimTreeHiddenFileHL", link = "NvimTreeFileName" },
  { group = "NvimTreeHiddenFolderHL", link = "NvimTreeFolderName" },

It is ensured that if a file has a parent directory that is a dotfile, the file itself is also considered a dotfile. For example, all files within the .git or .github directories are regarded as dotfiles, as below:

Backward Compatibility

To ensure backward compatibility, by default:

Hidden files and folders highlight groups link to existing NvimTree highlights for files and folders.
The hidden icon will not display by default.
The name and icon of hidden files and folders will not be highlighted unless highlight_hidden is set to a value other than "none".
The show.hidden option is set to false by default.

Note: This change is not related to highlighting git-ignored files.

Example Setup

require('nvim-tree').setup {
  renderer = {
    highlight_hidden = 'name',
    icons = {
      web_devicons = {
        file = {
          enable = true,
          color = true,
        },
        folder = {
          enable = false,
          color = true,
        },
      },
      hidden_placement = 'before',
      show = {
        hidden = true,
      },
      glyphs = {
        hidden = '󰜌',
      },
    },
  },
}

Example Result (not generated by the above setup)

Below we show the highlights results produced by :Inspect command on a dotfile (hidden folder in this case).

…th icon and name (this not related to git highlights). Better defaults squashed docs(hidden) docs(hidden) docs(hidden)

… be also a dotfile

alex-courtis · 2024-07-20T02:54:46Z

  -- Hidden
  { group = "NvimTreeHiddenIcon", link = "NvimTreeSignColumn" },
  { group = "NvimTreeHiddenFileHL", link = "NvimTreeFileName" },
  { group = "NvimTreeHiddenFolderHL", link = "NvimTreeFolderName" },

These defaults don't stand out very much; the user may think the feature is not working or misconfigured.

How about we use Conceal? It's distinct and not already used.

  -- Hidden
  { group = "NvimTreeHiddenIcon", link = "Conceal" },
  { group = "NvimTreeHiddenFileHL", link = "NvimTreeHiddenIcon" },
  { group = "NvimTreeHiddenFolderHL", link = "NvimTreeHiddenFileHL" },

alex-courtis · 2024-07-20T03:09:22Z

Test cases:

highlight_hidden = "none",

highlight_hidden = "icon",

highlight_hidden = "name",

highlight_hidden = "all",

      hidden_placement = "signcolumn",
      show = {
        hidden = true,

      hidden_placement = "before",
      show = {
        hidden = true,

      hidden_placement = "after",
      show = {
        hidden = true,

alex-courtis

This is great - all working, just some polish needed.

alex-courtis · 2024-07-20T02:40:32Z

doc/nvim-tree-lua.txt

@@ -904,6 +908,13 @@ Requires |nvim-tree.modified.enable|
 Value can be `"none"`, `"icon"`, `"name"` or `"all"`
  Type: `string`, Default `"none"`

+*nvim-tree.renderer.highlight_hidden*


Please run make help-update to add the new entries to the indexes:

https://github.com/nvim-tree/nvim-tree.lua/actions/runs/9958922100/job/27689198158?pr=2840

alex-courtis · 2024-07-20T03:06:23Z

lua/nvim-tree/renderer/builder.lua

@@ -442,6 +443,7 @@ function Builder.setup(opts)
    DecoratorDiagnostics:new(opts),
    DecoratorBookmarks:new(opts),
    DecoratorModified:new(opts),
+    DecoratorHidden:new(opts),


Please update :help nvim-tree.renderer.icons with this order.

alex-courtis · 2024-07-20T03:08:33Z

lua/nvim-tree/explorer/node.lua

+  end
+  -- Inspect(node)
+  if node.is_dot or (node.name and (node.name:sub(1, 1) == ".")) or M.is_dotfile(node.parent) then
+    node.is_dot = true


alex-courtis · 2024-07-20T03:22:07Z

lua/nvim-tree/renderer/decorator/hidden.lua

+---@param node Node
+---@return HighlightedString[]|nil icons
+function DecoratorHidden:calculate_icons(node)
+  if self.enabled and is_dotfile(node) then


Suggested change

if self.enabled and is_dotfile(node) then

if self.enabled and node:is_dotfile() then

You can then remove the require.

I've updated in favor of all sugestions. However, I couldn't use is_dotfile as a method of node.
Instead I followed the same style of other decorators by 'requiring' into a variable called explorer_node and then using explorer_node.is_dotfile(node).
Besides that, everything else should be aligned with the change request.

However, I couldn't use is_dotfile as a method of node. Instead I followed the same style of other decorators by 'requiring' into a variable called explorer_node and then using explorer_node.is_dotfile(node).

Right you are; node isn't yet a proper class. Apologies...

alex-courtis · 2024-07-20T03:22:22Z

lua/nvim-tree/renderer/decorator/hidden.lua

+  })
+  ---@cast o DecoratorHidden
+
+  if not o.enabled then


This will always be true, we can remove.

alex-courtis · 2024-07-20T03:23:27Z

lua/nvim-tree/appearance/init.lua

+  -- Hidden
+  { group = "NvimTreeHiddenIcon", link = "NvimTreeSignColumn" },
+  { group = "NvimTreeHiddenFileHL", link = "NvimTreeFileName" },
+  { group = "NvimTreeHiddenFolderHL", link = "NvimTreeFolderName" },


Please add these to help nvim-tree-highlight-default

alex-courtis

Looks great, many thanks for your contribution!

evertonse added 3 commits July 16, 2024 00:47

feat(hidden_decorator): Allow hidden (dotfiles) to be highlighted, bo…

3b37b51

…th icon and name (this not related to git highlights). Better defaults squashed docs(hidden) docs(hidden) docs(hidden)

fix(typo): small typo on hl groups

fd0d2de

feat(hidden_dotfile_highlight): make a file that has a dotfile parent…

59571f6

… be also a dotfile

alex-courtis changed the title ~~feat(hidden_highlight): Allow hidden files (dotfiles) to be highlighted, both icon and name.~~ feat: add renderer.highlight_hidden, renderer.icons.show.hidden and renderer.icons.hidden_placement for dotfile icons/highlights Jul 20, 2024

alex-courtis requested changes Jul 20, 2024

View reviewed changes

docs: update docs on hidden highlight

7d28464

alex-courtis approved these changes Jul 21, 2024

View reviewed changes

Merge branch 'master' into feat/hilight-dotfiles

605b361

alex-courtis merged commit 48a9290 into nvim-tree:master Jul 21, 2024
5 checks passed

github-actions bot mentioned this pull request Jul 21, 2024

chore(master): release nvim-tree 1.6.0 #2845

Merged

evertonse deleted the feat/hilight-dotfiles branch July 21, 2024 23:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add renderer.highlight_hidden, renderer.icons.show.hidden and renderer.icons.hidden_placement for dotfile icons/highlights #2840

feat: add renderer.highlight_hidden, renderer.icons.show.hidden and renderer.icons.hidden_placement for dotfile icons/highlights #2840

evertonse commented Jul 16, 2024 •

edited

Loading

alex-courtis commented Jul 20, 2024 •

edited

Loading

alex-courtis commented Jul 20, 2024

alex-courtis left a comment

alex-courtis Jul 20, 2024 •

edited

Loading

alex-courtis Jul 20, 2024 •

edited

Loading

alex-courtis Jul 20, 2024

alex-courtis Jul 20, 2024

evertonse Jul 20, 2024

alex-courtis Jul 21, 2024

alex-courtis Jul 20, 2024 •

edited

Loading

alex-courtis Jul 20, 2024 •

edited

Loading

alex-courtis left a comment

	if self.enabled and is_dotfile(node) then
	if self.enabled and node:is_dotfile() then

feat: add renderer.highlight_hidden, renderer.icons.show.hidden and renderer.icons.hidden_placement for dotfile icons/highlights #2840

feat: add renderer.highlight_hidden, renderer.icons.show.hidden and renderer.icons.hidden_placement for dotfile icons/highlights #2840

Conversation

evertonse commented Jul 16, 2024 • edited Loading

PR Description

This PR introduces the ability to highlight hidden files (dotfiles) by creating three new highlight groups:

Backward Compatibility

To ensure backward compatibility, by default:

Example Setup

Example Result (not generated by the above setup)

alex-courtis commented Jul 20, 2024 • edited Loading

alex-courtis commented Jul 20, 2024

alex-courtis left a comment

Choose a reason for hiding this comment

alex-courtis Jul 20, 2024 • edited Loading

Choose a reason for hiding this comment

alex-courtis Jul 20, 2024 • edited Loading

Choose a reason for hiding this comment

alex-courtis Jul 20, 2024

Choose a reason for hiding this comment

alex-courtis Jul 20, 2024

Choose a reason for hiding this comment

evertonse Jul 20, 2024

Choose a reason for hiding this comment

alex-courtis Jul 21, 2024

Choose a reason for hiding this comment

alex-courtis Jul 20, 2024 • edited Loading

Choose a reason for hiding this comment

alex-courtis Jul 20, 2024 • edited Loading

Choose a reason for hiding this comment

alex-courtis left a comment

Choose a reason for hiding this comment

evertonse commented Jul 16, 2024 •

edited

Loading

alex-courtis commented Jul 20, 2024 •

edited

Loading

alex-courtis Jul 20, 2024 •

edited

Loading

alex-courtis Jul 20, 2024 •

edited

Loading

alex-courtis Jul 20, 2024 •

edited

Loading

alex-courtis Jul 20, 2024 •

edited

Loading