feat: add always_show option to filtered_items config, closes #446

Author: cseickel

README.md

@@ -248,7 +248,10 @@ use {
             hide_by_pattern = { -- uses glob style patterns
               --"*.meta"
             },
-            never_show = { -- remains hidden even if visible is toggled to true
+            always_show = { -- remains visible even if other settings would normally hide it
+              --".gitignored",
+            },
+            never_show = { -- remains hidden even if visible is toggled to true, this overrides always_show
               --".DS_Store",
               --"thumbs.db"
             },

doc/neo-tree.txt

@@ -645,27 +645,43 @@ highlight group which will be applied when they are visible, see
           hide_by_pattern = {
             --"*.meta",
           },
-          never_show = { -- remains hidden even if visible is toggled to true
+          always_show = { -- remains visible even if other settings would normally hide it
+            --".gitignored",
+          },
+          never_show = { -- remains hidden even if visible is toggled to true, this overrides always_show
             --".DS_Store",
             --"thumbs.db",
           },
         },
       }
     })
 <
+
 The `visible` option just defines the default value. This value is toggled by
 the "toggle_hidden" command, which is mapped to H by default.
 
-The `never_show` option is the same as `hide_by_name`, except that those items
-will remain hidden even if you toggle `visible` to true. This section takes
-precedence over the others.
+The `hide_dotfiles` option just hides anything that starts with `. `(period).
 
-The `hide_by_pattern` option uses glob syntax, which is converted to lua
-patterns. No gaurantees on how it handles advanced patterns.
+The `hide_gitignored` option will query git for the files and folders being
+shown, and hide those that are marked as ignored.
 
 The `hide_hidden` option only will work on Windows using the Windows logic
 that determines if a file or directory is hidden.
 
+The `hide_by_name` option is a list of file/folder names that should be
+hidden. This is an exact match.
+
+The `hide_by_pattern` option uses glob syntax, which is converted to lua
+patterns. No gaurantees on how it handles advanced patterns.
+
+The `always_show` option is a list of file/folder names that will always be 
+visible, even if other settings would normally hide it. This section takes
+precedence over all other options except for `never_show`.
+
+The `never_show` option is the same as `hide_by_name`, except that those items
+will remain hidden even if you toggle `visible` to true. This section takes
+precedence over the others.
+
 
 NETRW HIJACK BEHAVIOR                                    *neo-tree-netrw-hijack*
 

lua/neo-tree/defaults.lua

@@ -345,7 +345,10 @@ local config = {
       hide_by_pattern = { -- uses glob style patterns
         --"*.meta"
       },
-      never_show = { -- remains hidden even if visible is toggled to true
+      always_show = { -- remains visible even if other settings would normally hide it
+        --".gitignored",
+      },
+      never_show = { -- remains hidden even if visible is toggled to true, this overrides always_show
         --".DS_Store",
         --"thumbs.db"
       },

lua/neo-tree/sources/common/file-items.lua

@@ -113,6 +113,10 @@ function create_item(context, path, _type)
       item.filtered_by = item.filtered_by or {}
       item.filtered_by.never_show = true
     end
+    if f.always_show[name] then
+      item.filtered_by = item.filtered_by or {}
+      item.filtered_by.always_show = true
+    end
     if f.hide_by_name[name] then
       item.filtered_by = item.filtered_by or {}
       item.filtered_by.name = true

lua/neo-tree/sources/filesystem/init.lua

@@ -257,11 +257,6 @@ M.setup = function(config, global_config)
   config.filtered_items = config.filtered_items or {}
   config.enable_git_status = global_config.enable_git_status
 
-  local hide_by_name = config.filtered_items.hide_by_name
-  if hide_by_name then
-    config.filtered_items.hide_by_name = utils.list_to_dict(hide_by_name)
-  end
-
   local hide_by_pattern = config.filtered_items.hide_by_pattern
   if hide_by_pattern then
     local glob = require("neo-tree.sources.filesystem.lib.globtopattern")
@@ -271,9 +266,11 @@ M.setup = function(config, global_config)
     end
   end
 
-  local never_show = config.filtered_items.never_show
-  if never_show then
-    config.filtered_items.never_show = utils.list_to_dict(never_show)
+  for _, key in ipairs({ "hide_by_name", "always_show", "never_show" }) do
+    local list = config.filtered_items[key]
+    if type(list) == "table" then
+      config.filtered_items[key] = utils.list_to_dict(list)
+    end
   end
 
   --Configure events for before_render

lua/neo-tree/ui/renderer.lua

@@ -140,7 +140,7 @@ local remove_filtered = function(source_items, filtered_items)
     local fby = child.filtered_by
     if type(fby) == "table" and not child.is_reveal_target and not fby.show_anyway then
       if not fby.never_show then
-        if filtered_items.visible or child.is_nested then
+        if filtered_items.visible or child.is_nested or fby.always_show then
           table.insert(visible, child)
         else
           table.insert(hidden, child)