feat: add options always_show_by_pattern (#1444)

README.md

@@ -305,6 +305,9 @@ use {
  always_show = { -- remains visible even if other settings would normally hide it
  --".gitignored",
  },
+ always_show_by_pattern = { -- uses glob style patterns
+ --".env*",
+ },
  never_show = { -- remains hidden even if visible is toggled to true, this overrides always_show
  --".DS_Store",
  --"thumbs.db"

doc/neo-tree.txt

@@ -940,6 +940,9 @@ highlight group which will be applied when they are visible, see
  always_show = { -- remains visible even if other settings would normally hide it
  --".gitignored",
  },
+ always_show_by_pattern = { -- uses glob style patterns
+ --".env*",
+ },
  never_show = { -- remains hidden even if visible is toggled to true, this overrides always_show
  --".DS_Store",
  --"thumbs.db",
@@ -973,6 +976,10 @@ 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 `always_show_by_pattern` option is a list of file/folder patterns that 
+always will be visible. This section takes precedence over all other options
+except `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.

lua/neo-tree/defaults.lua

@@ -477,6 +477,9 @@ local config = {
  always_show = { -- remains visible even if other settings would normally hide it
  --".gitignored",
  },
+ always_show_by_pattern = { -- uses glob style patterns
+ --".env*",
+ },
  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

@@ -167,6 +167,11 @@ function create_item(context, path, _type, bufnr)
  if f.always_show[name] then
  item.filtered_by = item.filtered_by or {}
  item.filtered_by.always_show = true
+ else
+ if utils.is_filtered_by_pattern(f.always_show_by_pattern, path, name) then
+ item.filtered_by = item.filtered_by or {}
+ item.filtered_by.always_show = true
+ end
  end
  if f.hide_by_name[name] then
  item.filtered_by = item.filtered_by or {}

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

@@ -260,7 +260,7 @@ M.setup = function(config, global_config)
  config.filtered_items = config.filtered_items or {}
  config.enable_git_status = global_config.enable_git_status
 
- for _, key in ipairs({ "hide_by_pattern", "never_show_by_pattern" }) do
+ for _, key in ipairs({ "hide_by_pattern", "always_show_by_pattern", "never_show_by_pattern" }) do
  local list = config.filtered_items[key]
  if type(list) == "table" then
  for i, pattern in ipairs(list) do