feat(#2654): filters.custom may be a function

doc/nvim-tree-lua.txt

@@ -178,6 +178,7 @@ Show the mappings:  `g?`
 `g?`              Help                       |nvim-tree-api.tree.toggle_help()|
 `gy`              Copy Absolute Path         |nvim-tree-api.fs.copy.absolute_path()|
 `H`               Toggle Filter: Dotfiles    |nvim-tree-api.tree.toggle_hidden_filter()|
+`h`               Toggle Filter: Binaries    |nvim-tree-api.tree.toggle_binaries_filter()|
 `I`               Toggle Filter: Git Ignore  |nvim-tree-api.tree.toggle_gitignore_filter()|
 `J`               Last Sibling               |nvim-tree-api.node.navigate.sibling.last()|
 `K`               First Sibling              |nvim-tree-api.node.navigate.sibling.first()|
@@ -504,6 +505,7 @@ Following is the default configuration. See |nvim-tree-opts| for details.
       filters = {
         git_ignored = true,
         dotfiles = false,
+        binaries = false,
         git_clean = false,
         no_buffer = false,
         no_bookmark = false,
@@ -1241,7 +1243,7 @@ Enabling this is not useful as there is no means yet to persist bookmarks.
 Custom list of vim regex for file/directory names that will not be shown.
 Backslashes must be escaped e.g. "^\\.git". See |string-match|.
 Toggle via |nvim-tree-api.tree.toggle_custom_filter()|, default `U`
-  Type: {string}, Default: `{}`
+  Type: {string | function(path)}, Default: `{}`
 
 *nvim-tree.filters.exclude*
 List of directories or files to exclude from filtering: always show them.
@@ -2193,6 +2195,7 @@ You are encouraged to copy these to your own |nvim-tree.on_attach| function.
   vim.keymap.set('n', 'g?',      api.tree.toggle_help,                opts('Help'))
   vim.keymap.set('n', 'gy',      api.fs.copy.absolute_path,           opts('Copy Absolute Path'))
   vim.keymap.set('n', 'H',       api.tree.toggle_hidden_filter,       opts('Toggle Filter: Dotfiles'))
+  vim.keymap.set('n', 'h',       api.tree.toggle_binaries_filter,       opts('Toggle Filter: Binaries'))
   vim.keymap.set('n', 'I',       api.tree.toggle_gitignore_filter,    opts('Toggle Filter: Git Ignore'))
   vim.keymap.set('n', 'J',       api.node.navigate.sibling.last,      opts('Last Sibling'))
   vim.keymap.set('n', 'K',       api.node.navigate.sibling.first,     opts('First Sibling'))

lua/nvim-tree.lua

@@ -501,6 +501,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
   filters = {
     git_ignored = true,
     dotfiles = false,
+    binaries = false,
     git_clean = false,
     no_buffer = false,
     no_bookmark = false,

lua/nvim-tree/actions/tree/modifiers/toggles.lua

@@ -41,4 +41,9 @@ function M.dotfiles()
   reload()
 end
 
+function M.binaries()
+  filters.config.filter_binaries = not filters.config.filter_binaries
+  reload()
+end
+
 return M

lua/nvim-tree/api.lua

@@ -131,6 +131,7 @@ Api.tree.toggle_git_clean_filter = wrap(actions.tree.modifiers.toggles.git_clean
 Api.tree.toggle_no_buffer_filter = wrap(actions.tree.modifiers.toggles.no_buffer)
 Api.tree.toggle_custom_filter = wrap(actions.tree.modifiers.toggles.custom)
 Api.tree.toggle_hidden_filter = wrap(actions.tree.modifiers.toggles.dotfiles)
+Api.tree.toggle_binaries_filter = wrap(actions.tree.modifiers.toggles.binaries)
 Api.tree.toggle_no_bookmark_filter = wrap(actions.tree.modifiers.toggles.no_bookmark)
 Api.tree.toggle_help = wrap(help.toggle)
 Api.tree.is_tree_buf = wrap(utils.is_nvim_tree_buf)

lua/nvim-tree/explorer/filters.lua

@@ -69,6 +69,30 @@ local function dotfile(path)
   return M.config.filter_dotfiles and utils.path_basename(path):sub(1, 1) == "."
 end
 
+---@param path string
+---@return boolean
+local function binary(path)
+  if not M.config.filter_binaries then
+    return false
+  end
+
+  -- 4-byte 'magic number' for ELF
+  local magic_number = string.char(0x7f) .. "ELF"
+
+  local fd = vim.loop.fs_open(path, "r", 438)
+  if not fd then
+    return false
+  end
+  local stat = vim.loop.fs_fstat(fd)
+  if not stat then
+    return false
+  end
+  local data = vim.loop.fs_read(fd, 4, 0)
+  vim.loop.fs_close(fd)
+
+  return data == magic_number
+end
+
 ---@param path string
 ---@param bookmarks table<string, boolean> absolute paths bookmarked
 local function bookmark(path, bookmarks)
@@ -87,8 +111,14 @@ local function custom(path)
   -- filter custom regexes
   local relpath = utils.path_relative(path, vim.loop.cwd())
   for pat, _ in pairs(M.ignore_list) do
-    if vim.fn.match(relpath, pat) ~= -1 or vim.fn.match(basename, pat) ~= -1 then
-      return true
+    if type(pat) == "function" then
+      if pat(path) then
+        return true
+      end
+    else
+      if vim.fn.match(relpath, pat) ~= -1 or vim.fn.match(basename, pat) ~= -1 then
+        return true
+      end
     end
   end
 
@@ -136,13 +166,19 @@ function M.should_filter(path, status)
     return false
   end
 
-  return git(path, status.git_status) or buf(path, status.bufinfo) or dotfile(path) or custom(path) or bookmark(path, status.bookmarks)
+  return git(path, status.git_status)
+    or buf(path, status.bufinfo)
+    or dotfile(path)
+    or binary(path)
+    or custom(path)
+    or bookmark(path, status.bookmarks)
 end
 
 function M.setup(opts)
   M.config = {
     filter_custom = true,
     filter_dotfiles = opts.filters.dotfiles,
+    filter_binaries = opts.filters.binaries,
     filter_git_ignored = opts.filters.git_ignored,
     filter_git_clean = opts.filters.git_clean,
     filter_no_buffer = opts.filters.no_buffer,

lua/nvim-tree/keymap.lua

@@ -69,6 +69,7 @@ function M.default_on_attach(bufnr)
   vim.keymap.set('n', 'g?',      api.tree.toggle_help,                opts('Help'))
   vim.keymap.set('n', 'gy',      api.fs.copy.absolute_path,           opts('Copy Absolute Path'))
   vim.keymap.set('n', 'H',       api.tree.toggle_hidden_filter,       opts('Toggle Filter: Dotfiles'))
+  vim.keymap.set('n', 'h',       api.tree.toggle_binaries_filter,       opts('Toggle Filter: Binaries'))
   vim.keymap.set('n', 'I',       api.tree.toggle_gitignore_filter,    opts('Toggle Filter: Git Ignore'))
   vim.keymap.set('n', 'J',       api.node.navigate.sibling.last,      opts('Last Sibling'))
   vim.keymap.set('n', 'K',       api.node.navigate.sibling.first,     opts('First Sibling'))