- get_entry_on_line(bufnr, lnum)
- get_cursor_entry()
- discard_all_changes()
- set_columns(cols)
- set_sort(sort)
- set_is_hidden_file(is_hidden_file)
- toggle_hidden()
- get_current_dir(bufnr)
- open_float(dir)
- toggle_float(dir)
- open(dir)
- close(opts)
- open_preview(opts, callback)
- select(opts, callback)
- save(opts, cb)
- setup(opts)
get_entry_on_line(bufnr, lnum): nil|oil.Entry
Get the entry on a specific line (1-indexed)
| Param | Type | Desc |
|---|---|---|
| bufnr | integer |
|
| lnum | integer |
get_cursor_entry(): nil|oil.Entry
Get the entry currently under the cursor
discard_all_changes()
Discard all changes made to oil buffers
set_columns(cols)
Change the display columns for oil
| Param | Type | Desc |
|---|---|---|
| cols | oil.ColumnSpec[] |
set_sort(sort)
Change the sort order for oil
| Param | Type | Desc |
|---|---|---|
| sort | oil.SortSpec[] |
List of columns plus direction. See :help oil-columns to see which ones are sortable. |
Examples:
require("oil").set_sort({ { "type", "asc" }, { "size", "desc" } })set_is_hidden_file(is_hidden_file)
set_is_hidden_file(is_hidden_file)
Change how oil determines if the file is hidden
| Param | Type | Desc |
|---|---|---|
| is_hidden_file | fun(filename: string, bufnr: integer): boolean |
Return true if the file/dir should be hidden |
toggle_hidden()
toggle_hidden()
Toggle hidden files and directories
get_current_dir(bufnr): nil|string
Get the current directory
| Param | Type | Desc |
|---|---|---|
| bufnr | nil|integer |
open_float(dir)
Open oil browser in a floating window
| Param | Type | Desc |
|---|---|---|
| dir | nil|string |
When nil, open the parent of the current buffer, or the cwd if current buffer is not a file |
toggle_float(dir)
Open oil browser in a floating window, or close it if open
| Param | Type | Desc |
|---|---|---|
| dir | nil|string |
When nil, open the parent of the current buffer, or the cwd if current buffer is not a file |
open(dir)
Open oil browser for a directory
| Param | Type | Desc |
|---|---|---|
| dir | nil|string |
When nil, open the parent of the current buffer, or the cwd if current buffer is not a file |
close(opts)
Restore the buffer that was present when oil was opened
| Param | Type | Desc |
|---|---|---|
| opts | nil|oil.CloseOpts |
|
| >exit_if_last_buf | nil|boolean |
Exit vim if this oil buffer is the last open buffer |
open_preview(opts, callback)
Preview the entry under the cursor in a split
| Param | Type | Desc |
|---|---|---|
| opts | nil|oil.OpenPreviewOpts |
|
| >vertical | nil|boolean |
Open the buffer in a vertical split |
| >horizontal | nil|boolean |
Open the buffer in a horizontal split |
| >split | nil|"aboveleft"|"belowright"|"topleft"|"botright" |
Split modifier |
| callback | nil|fun(err: nil|string) |
Called once the preview window has been opened |
select(opts, callback)
Select the entry under the cursor
| Param | Type | Desc |
|---|---|---|
| opts | nil|oil.SelectOpts |
|
| >vertical | nil|boolean |
Open the buffer in a vertical split |
| >horizontal | nil|boolean |
Open the buffer in a horizontal split |
| >split | nil|"aboveleft"|"belowright"|"topleft"|"botright" |
Split modifier |
| >tab | nil|boolean |
Open the buffer in a new tab |
| >close | nil|boolean |
Close the original oil buffer once selection is made |
| callback | nil|fun(err: nil|string) |
Called once all entries have been opened |
save(opts, cb)
Save all changes
| Param | Type | Desc |
|---|---|---|
| opts | nil|table |
|
| >confirm | nil|boolean |
Show confirmation when true, never when false, respect skip_confirm_for_simple_edits if nil |
| cb | nil|fun(err: nil|string) |
Called when mutations complete. |
Note:
If you provide your own callback function, there will be no notification for errors.
setup(opts)
Initialize oil
| Param | Type | Desc |
|---|---|---|
| opts | oil.setupOpts|nil |