Skip to content

Commit

Permalink
docs: fix hilbish.vimAction doc
Browse files Browse the repository at this point in the history
  • Loading branch information
TorchedSammy committed Dec 29, 2024
1 parent b84d985 commit 56ba00e
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions docs/hooks/hilbish.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,29 @@ The notification. The properties are defined in the link above.

<hr>

+ `hilbish.vimAction` -> actionName, args > Sent when the user does a "vim action," being something
like yanking or pasting text. See `doc vim-mode actions` for more info.
## hilbish.cd
Sent when the current directory of the shell is changed (via interactive means.)
If you are implementing a custom command that changes the directory of the shell,
you must throw this hook manually for correctness.

#### Variables
`string` **`path`**
Absolute path of the directory that was changed to.

`string` **`oldPath`**
Absolute path of the directory Hilbish *was* in.

<hr>

## hilbish.vimAction
Sent when the user does a "vim action," being something like yanking or pasting text.
See `doc vim-mode actions` for more info.

#### Variables
`string` **`actionName`**
Absolute path of the directory that was changed to.

`table` **`args`**
Table of args relating to the Vim action.

<hr>

0 comments on commit 56ba00e

Please sign in to comment.