1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
# nnn.vim
Fast and featureful file manager in vim/neovim powered by nnn.
<p align="center">
<img width="934" src="https://user-images.githubusercontent.com/7200153/50667041-7458f500-0ff2-11e9-887a-6443ee5d9344.png">
<small>colorscheme <a href="https://github.com/nightsense/snow">snow</a></small>
</p>
### Requirements
1. nnn (minimum version 2.2)
2. Neovim or Vim 8.1 with terminal support
### Install
You must install nnn itself. Instructions
[here](https://github.com/jarun/nnn#installation).
Then install using your favorite plugin manager:
```vim
" using vim-plug
Plug 'mcchrish/nnn.vim'
```
### Usage
To open nnn as a file picker in vim/neovim, use the command `:NnnPicker` or
`:Np` or the key-binding `<leader>n`. You can pass a directory to `:NnnPicker`
command and opens nnn from there e.g. `:NnnPicker path/to/somewhere`.
Once you [select](https://github.com/jarun/nnn#selection) one or more files and
press <kbd>enter</kbd>, vim quits the nnn window and opens the first selected
file and add the remaining files to the arg list/buffer list.
Pressing <kbd>enter</kbd> on a file in nnn will pick any earlier selection, pick
the file and exit nnn.
To discard selection and exit, press <kbd>^G</kbd>.
Please visit the complete documentation by running `:help nnn`.
### Configurations
#### Custom mappings
```vim
" Disable default mappings
let g:nnn#set_default_mappings = 0
" Then set your own
nnoremap <silent> <leader>nn :NnnPicker<CR>
" Or override
" Start nnn in the current file's directory
nnoremap <leader>n :NnnPicker '%:p:h'<CR>
```
#### Layout
```vim
" Opens the nnn window in a split
let g:nnn#layout = 'new' " or vnew, tabnew etc.
" Or pass a dictionary with window size
let g:nnn#layout = { 'left': '~20%' } " or right, up, down
```
#### Action
You can set extra key-bindings for opening files in different ways. Nothing is
set by default to not override nnn's own key-bindings.
```vim
let g:nnn#action = {
\ '<c-t>': 'tab split',
\ '<c-x>': 'split',
\ '<c-v>': 'vsplit' }
```
For example, when inside an nnn window, pressing <kbd>ctrl-t</kbd> will open the
selected file in a tab, instead of the current window. <kbd>ctrl-x</kbd> will
open in a split an so on. Meanwhile for multi selected files will be loaded in
the buffer list.
#### Command override
When you want to override the default nnn command and add some extra flags.
Example you want to start nnn in light mode.
```vim
let g:nnn#command = 'nnn -l'
" or pass some env variables
let g:nnn#command = 'NNN_RESTRICT_NAV_OPEN=1 nnn -l'
```
#### `nnn#pick()`
The `nnn#pick([<dir>][,<opts>])` function can be called with custom directory
and additional options such as opening file in splits or tabs. Basically a more
configurable version of `:NnnPicker` command.
```vim
call nnn#pick('~/some-files', { 'edit': 'vertical split' })
" Then you can do all kinds of mappings if you want
```
`opts` can be:
- `edit` - type of window the select file will be open.
- `layout` - same as `g:nnn#layout` and overrides it if specified.
#### Environment variables
You can define env variables in `vimrc` and nnn will detect it.
```vim
let $NNN_RESTRICT_NAV_OPEN=1
```
### Credits
Main nnn program: https://github.com/jarun/nnn
|
