add enable/disable option to api.tree.toggle functions

[va9iff]

Is this a question?
no.

Can this functionality be implemented utilising API?
no.

Is your feature request related to a problem? Please describe.
yes.
I wanted to have a key binding for "disable no_bookmark filter" but there was only toggle_no_bookmark_filter().

Describe the solution you'd like
toggle functions are nice but why not exposing the real on/off functions?

Describe alternatives you've considered
this is the way I'm doing it right now, which is probably fragile and can be broken in the upcoming updates since it's not using the public API

if require("nvim-tree.core").get_explorer().filters.state.no_bookmark then
    api.tree.toggle_no_bookmark_filter()
end

I think having toggle_no_bookmark_filter(bool) would be perfect. pass with nil or no argument to toggle, pass true to turn on, pass false to turn off. doesn't break backwards compatibility and doesn't pollute the api much either.

this pattern is present in many parts of the plugin, which is really irritating

[alex-courtis]

That is a good suggestion, we should implement it.

Another project has explicit calls for on, off and toggle, which has proven to be annoying, so using toggle with arguments is a good solution.

Edit: add enable / disable functions: #3237 (comment)

This will be useful for all filters so should be applied to all filter toggles including the general toggle:

• toggle_enable_filters
• toggle_gitignore_filter
• toggle_git_clean_filter
• toggle_no_buffer_filter
• toggle_custom_filter
• toggle_hidden_filter
• toggle_no_bookmark_filter

We're applying the named arguments pattern to all API and most internal functions, so we should use a common opts class, something like

---@class ApiTreeToggleOpts
---@field enable? boolean 

As usual, pull requests are most gratefully appreciated, see

• CONTRIBUTING.md
• Wiki: Development

[alex-courtis]

Your bookmarks experience will soon improve #3033

[alex-courtis]

Following API refactor during #3244 this can be implemented more simply without the need for opts e.g.

---
---Toggle [nvim_tree.config.filters] {git_clean} filter.
---
function nvim_tree.api.filter.git.clean.toggle() end

---
---Enable [nvim_tree.config.filters] {git_clean} filter.
---
function nvim_tree.api.filter.git.clean.enable() end

Please enhance **nvim_tree.config.filters* help to include enable/disable.