Skip to content

Commit ff6ef58

Browse files
authored
#1146 clarify filters.exclude and toggle actions (#1168)
1 parent 7629d4d commit ff6ef58

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

doc/nvim-tree-lua.txt

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -343,16 +343,17 @@ Here is a list of the options available in the setup call:
343343
- |git|: git integration with icons and colors
344344

345345
- |git.enable|: enable / disable the feature
346-
type: `boolean`
347-
default: `true`
346+
type: `boolean`
347+
default: `true`
348348

349349
- |git.ignore|: ignore files based on `.gitignore`
350-
type: `boolean`
351-
default: `true`
350+
Toggle via the `toggle_git_ignored` action, default mapping `I`.
351+
type: `boolean`
352+
default: `true`
352353

353354
- |git.timeout|: kills the git process after some time if it takes too long
354-
type: `number`
355-
default: `400` (ms)
355+
type: `number`
356+
default: `400` (ms)
356357

357358
You will still need to configure `g:nvim_tree_show_icons.git` or
358359
`g:nvim_tree_git_hl` to be able to see things in the tree. This will be
@@ -435,17 +436,19 @@ Here is a list of the options available in the setup call:
435436
*nvim-tree.filters*
436437
|filters|: filtering options
437438

438-
- |filters.dotfiles|: do not show `dotfiles` (files starting with a `.`)
439+
- |filters.dotfiles|: do not show dotfiles: files starting with a `.`
440+
Toggle via the `toggle_dotfiles` action, default mapping `H`.
439441
type: `boolean`
440442
default: `false`
441443

442444
- |filters.custom|: custom list of vim regex for file/directory names that will not be shown.
443445
Backslashes must be escaped e.g. "^\\.git". See |string-match|.
446+
Toggle via the `toggle_custom` action, default mapping `U`.
444447
type: `{string}`
445448
default: `{}`
446449

447-
- |filters.exclude|: list of directories or files to exclude from filtering
448-
(will always be shown)
450+
- |filters.exclude|: list of directories or files to exclude from filtering: always show them.
451+
Overrides `git.ignore`, `filters.dotfiles` and `filters.custom`.
449452
type: `{string}`
450453
default: `{}`
451454

0 commit comments

Comments
 (0)