Skip to content

Commit 992192b

Browse files
committed
update docs
1 parent 717b943 commit 992192b

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

doc/neo-tree.txt

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,6 +1536,16 @@ nodes of the tree. This is the best place to gather additional data to be used
15361536
by components. The argument passed is the state of the source, which is also
15371537
passed to components and commands down the line.
15381538

1539+
"before_git_status" ~
1540+
Fired before executing any git status commands.
1541+
1542+
Arg table fields:
1543+
1544+
- `status_args`: `string[]`, the list of args being passed to the `git status`
1545+
command, before any paths are appended to trim the results that `git` returns.
1546+
Modifying this table will modify the final `git status` command accordingly.
1547+
- `git_root`: `string`, the path of the root folder of the git worktree root.
1548+
15391549
"after_render" ~
15401550
Fired after the tree has been rendered. The argument passed is the state of the
15411551
source, which is also passed to components and commands down the line.
@@ -1569,13 +1579,26 @@ or clear the filter. The arg is the path of the file opened.
15691579
Fired after a file (or folder) has been renamed. The arg is an table containing
15701580
`source` and `destination` properties.
15711581

1582+
"git_event" ~
1583+
Mostly for internal use. Fired when a Neo-tree command is known to modify the working or
1584+
staging area, or on `fugitive.vim`'s `FugitiveChanged` User autocmd event.
1585+
1586+
"git_status_changed" ~
1587+
Fired when a new `git status` output for a tracked worktree has been processed. Does not currently check whether
1588+
the status actually changed from the previous status.
1589+
1590+
Arg table fields:
1591+
1592+
- `git_status`: `table<string, string>`, A map of absolute file paths to 1-2 letter git status codes.
1593+
- `git_root`: `string`, the path of the root folder of the git worktree root.
1594+
15721595
"neo_tree_buffer_enter" ~
1573-
Fired after entering a neo-tree buffer. It is also right after neo-tree applies
1596+
Fired after entering a Neo-tree buffer. It is also right after Neo-tree applies
15741597
it's own settings, so it's the ideal place to apply any local settings you would
15751598
like to have.
15761599

15771600
"neo_tree_buffer_leave" ~
1578-
Fired after a neo-tree buffer was exited. Technically it fires when entering a
1601+
Fired after a Neo-tree buffer was exited. Technically it fires when entering a
15791602
buffer that is not neo-tree, when the last buffer enter event was neo-tree.
15801603

15811604
"neo_tree_clipboard_changed" ~

0 commit comments

Comments
 (0)