feature(picker.explorer): filter specific files / folders

[disrupted]

Did you check the docs?

• I have read all the snacks.nvim docs

Is your feature request related to a problem? Please describe.

There are certain paths that I always want to show, such as the hidden .github folder containing CI workflows. However enabling all hidden files and folders can lead to a lot of distracting / irrelevant results for everyday work in a large repository.

Describe the solution you'd like

A way to include / exclude specific paths in the explorer picker. Ideally I would like the option to define a custom filter function similar to how it works for other pickers. I believe this would give the greatest flexibility

Describe alternatives you've considered

I enabled hidden files

picker = { sources = { explorer = { hidden = true } } }

Then I applied a custom filter function similar to other pickers, but I believe it's not implemented for the explorer, e.g.

Snacks.picker.explorer {
    ---@type snacks.picker.filter.Config
    filter = {
        filter = function(item, filter)
            if item.hidden and item.file:match '.github' then
                return true
            end
            if item.hidden then
                return false
            end
            return true
        end,
    },
}

Additional context

No response

[tduyng]

It would be great to have an "exclude" field like in the files and grep pickers.

[disrupted]

It would be great to have an "exclude" field like in the files and grep pickers.

would that mean that for my use-case (see above), I would need to set hidden=true and then list every hidden file/directory except for .github under exclude? I think that would be much less flexible than a generic filter function.

[tduyng]

It would be great to have an "exclude" field like in the files and grep pickers.

would that mean that for my use-case (see above), I would need to set hidden=true and then list every hidden file/directory except for .github under exclude? I think that would be much less flexible than a generic filter function.

I use Lazyvim, so setting up filters with "exclude" feels easier for me.
Here is an example that works well for picker.files

    opts = {
      picker = {
        sources = {
          files = {
            hidden = true,
            ignored = true,
            exclude = {
              "**/.git/*",
              "**/node_modules/*",
              "**/.yarn/cache/*",
              "**/.yarn/releases/*",
              "**/.pnpm-store/*",
...

But I don’t see support for the "exclude" field in picker.explorer.

If I’m not wrong, neo-tree.nvim made a similar logic like that (exclude certain files and directories)

[disrupted]

If I’m not wrong, neo-tree.nvim made a similar logic like that (exclude certain files and directories)

yeah, I am coming from neo-tree. It has a lot of filter options, e.g.

hide_by_name = {
  --"node_modules"
},
hide_by_pattern = { -- uses glob style patterns
  --"*.meta",
  --"*/src/*/tsconfig.json",
},
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"
},
never_show_by_pattern = { -- uses glob style patterns
  --".null-ls_*",
},

However I don't think it's necessary to have that many options. A custom filter function would allow users to apply any filter logic they want.

[folke]

There's now an opts.include and opts.exclude, both lists with glob patterns.

include takes precedence over all other filters like exclude, hidden and ignored.

[tduyng]

Thanks @folke so much!

It works now.
But there still seems to be a small issue.
The excluded folders still display in explorer, but it shows as empty.

For example, I excluded folders, like ".git", ".yarn/cache", and ".yarn/release", but they still appear in the explorer as empty.

[folke]

I can't reproduce this and don't see how that can happen. What is your config to trigger this?
Are you sure you updated to latest main?

[tduyng]

Yes, I’ve already update the latest commits. I will try that tomorrow.

[tduyng]

Hi @folke,
I retested it this morning. Now I understand my problem. I had configured my snacks config like this:

          exclude = {
            "**/.git/*",
            "**/node_modules/*",
            "**/.yarn/cache/*",
            "**/.yarn/install*",
            "**/.yarn/releases/*",
            "**/.pnpm-store/*",
            "**/.venv/*",
            "**/venv/*",
            "**/__pycache__/*",
-- ...etc.

This configuration means that if I put /* in the glob pattern, the folders will be excluded but will still display as empty in the explorer.

Now I changed it to:

 exclude = {
            ".git",
            "node_modules",
            ".yarn/cache",
-- .etc...

That works properly now.

Thank you for your feedback and your help.

[SamuelRCrider]

exclude = {
            ".git",
            "node_modules",
            ".yarn/cache",
-- .etc...

@tduyng what was the full object above? Here is my config, everything works as expected except the explorer excluded section:

return {
  {
    "folke/snacks.nvim",
    opts = {
      picker = {
        hidden = true,
        ignored = true,
        sources = {
          files = {
            hidden = true,
            ignored = true,
            exclude = {
              "**/.DS_Store",
              "**/node_modules/**",
            },
          },
        },
      },
      explorer = {
        hidden = true,
        ignored = true,
        sources = {
          files = {
            hidden = true,
            ignored = true,
            exclude = {
              "**/.DS_Store",
              "**/node_modules/**",
            },
          },
        },
      },
    },
  },
}