205 lines
12 KiB
Markdown
205 lines
12 KiB
Markdown
# API
|
|
|
|
<!-- TOC -->
|
|
|
|
- [get_entry_on_line(bufnr, lnum)](#get_entry_on_linebufnr-lnum)
|
|
- [get_cursor_entry()](#get_cursor_entry)
|
|
- [discard_all_changes()](#discard_all_changes)
|
|
- [set_columns(cols)](#set_columnscols)
|
|
- [set_sort(sort)](#set_sortsort)
|
|
- [set_is_hidden_file(is_hidden_file)](#set_is_hidden_fileis_hidden_file)
|
|
- [toggle_hidden()](#toggle_hidden)
|
|
- [get_current_dir(bufnr)](#get_current_dirbufnr)
|
|
- [open_float(dir, opts, cb)](#open_floatdir-opts-cb)
|
|
- [toggle_float(dir, opts, cb)](#toggle_floatdir-opts-cb)
|
|
- [open(dir, opts, cb)](#opendir-opts-cb)
|
|
- [close(opts)](#closeopts)
|
|
- [open_preview(opts, callback)](#open_previewopts-callback)
|
|
- [select(opts, callback)](#selectopts-callback)
|
|
- [save(opts, cb)](#saveopts-cb)
|
|
- [setup(opts)](#setupopts)
|
|
|
|
<!-- /TOC -->
|
|
|
|
<!-- API -->
|
|
|
|
## get_entry_on_line(bufnr, lnum)
|
|
|
|
`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()
|
|
|
|
`get_cursor_entry(): nil|oil.Entry` \
|
|
Get the entry currently under the cursor
|
|
|
|
|
|
## discard_all_changes()
|
|
|
|
`discard_all_changes()` \
|
|
Discard all changes made to oil buffers
|
|
|
|
|
|
## set_columns(cols)
|
|
|
|
`set_columns(cols)` \
|
|
Change the display columns for oil
|
|
|
|
| Param | Type | Desc |
|
|
| ----- | ------------------ | ---- |
|
|
| cols | `oil.ColumnSpec[]` | |
|
|
|
|
## set_sort(sort)
|
|
|
|
`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:**
|
|
```lua
|
|
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)
|
|
|
|
`get_current_dir(bufnr): nil|string` \
|
|
Get the current directory
|
|
|
|
| Param | Type | Desc |
|
|
| ----- | -------------- | ---- |
|
|
| bufnr | `nil\|integer` | |
|
|
|
|
## open_float(dir, opts, cb)
|
|
|
|
`open_float(dir, opts, cb)` \
|
|
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 |
|
|
| opts | `nil\|oil.OpenOpts` | |
|
|
| >preview | `nil\|oil.OpenPreviewOpts` | When present, open the preview window after opening oil |
|
|
| >>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 |
|
|
| cb | `nil\|fun()` | Called after the oil buffer is ready |
|
|
|
|
## toggle_float(dir, opts, cb)
|
|
|
|
`toggle_float(dir, opts, cb)` \
|
|
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 |
|
|
| opts | `nil\|oil.OpenOpts` | |
|
|
| >preview | `nil\|oil.OpenPreviewOpts` | When present, open the preview window after opening oil |
|
|
| >>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 |
|
|
| cb | `nil\|fun()` | Called after the oil buffer is ready |
|
|
|
|
## open(dir, opts, cb)
|
|
|
|
`open(dir, opts, cb)` \
|
|
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 |
|
|
| opts | `nil\|oil.OpenOpts` | |
|
|
| >preview | `nil\|oil.OpenPreviewOpts` | When present, open the preview window after opening oil |
|
|
| >>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 |
|
|
| cb | `nil\|fun()` | Called after the oil buffer is ready |
|
|
|
|
## close(opts)
|
|
|
|
`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)
|
|
|
|
`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(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 |
|
|
| >handle_buffer_callback | `nil\|fun(buf_id: integer)` | If defined, all other buffer related options here would be ignored. This callback allows you to take over the process of opening the buffer yourself. |
|
|
| callback | `nil\|fun(err: nil\|string)` | Called once all entries have been opened |
|
|
|
|
## save(opts, cb)
|
|
|
|
`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:**
|
|
<pre>
|
|
If you provide your own callback function, there will be no notification for errors.
|
|
</pre>
|
|
|
|
## setup(opts)
|
|
|
|
`setup(opts)` \
|
|
Initialize oil
|
|
|
|
| Param | Type | Desc |
|
|
| ----- | -------------------- | ---- |
|
|
| opts | `oil.setupOpts\|nil` | |
|
|
|
|
|
|
<!-- /API -->
|