forked from stevearc/oil.nvim
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
174 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| # 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_is_hidden_file(is_hidden_file)](#set_is_hidden_fileis_hidden_file) | ||
| - [toggle_hidden()](#toggle_hidden) | ||
| - [get_current_dir()](#get_current_dir) | ||
| - [open_float(dir)](#open_floatdir) | ||
| - [toggle_float(dir)](#toggle_floatdir) | ||
| - [open(dir)](#opendir) | ||
| - [close()](#close) | ||
| - [select(opts)](#selectopts) | ||
| - [save(opts)](#saveopts) | ||
| - [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_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: nil\|integer): boolean` | Return true if the file/dir should be hidden | | ||
|
|
||
| ## toggle_hidden() | ||
|
|
||
| `toggle_hidden()` \ | ||
| Toggle hidden files and directories | ||
|
|
||
|
|
||
| ## get_current_dir() | ||
|
|
||
| `get_current_dir(): nil|string` \ | ||
| Get the current directory | ||
|
|
||
|
|
||
| ## open_float(dir) | ||
|
|
||
| `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) | ||
|
|
||
| `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(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() | ||
|
|
||
| `close()` \ | ||
| Restore the buffer that was present when oil was opened | ||
|
|
||
|
|
||
| ## select(opts) | ||
|
|
||
| `select(opts)` \ | ||
| Select the entry under the cursor | ||
|
|
||
| | Param | Type | Desc | | | ||
| | ----- | ------------ | -------------------------------------------------- | ------------------------------------- | | ||
| | opts | `nil\|table` | | | | ||
| | | vertical | `boolean` | Open the buffer in a vertical split | | ||
| | | horizontal | `boolean` | Open the buffer in a horizontal split | | ||
| | | split | `"aboveleft"\|"belowright"\|"topleft"\|"botright"` | Split modifier | | ||
| | | preview | `boolean` | Open the buffer in a preview window | | ||
| | | tab | `boolean` | Open the buffer in a new tab | | ||
|
|
||
| ## save(opts) | ||
|
|
||
| `save(opts)` \ | ||
| 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 | | ||
|
|
||
| ## setup(opts) | ||
|
|
||
| `setup(opts)` \ | ||
| Initialize oil | ||
|
|
||
| | Param | Type | Desc | | ||
| | ----- | ------------ | ---- | | ||
| | opts | `nil\|table` | | | ||
|
|
||
|
|
||
| <!-- /API --> |