Skip to content

Commit a675dff

Browse files
committed
Rename to vim-fern
1 parent cc8ca2b commit a675dff

File tree

6 files changed

+64
-42
lines changed

6 files changed

+64
-42
lines changed

README.md

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🌿 fern.vim
1+
# 🌿 vim-fern
22

33
![Support Vim 8.1.2269 or above](https://img.shields.io/badge/support-Vim%208.1.2269%20or%20above-yellowgreen.svg)
44
![Support Neovim 0.4.4 or above](https://img.shields.io/badge/support-Neovim%200.4.4%20or%20above-yellowgreen.svg)
@@ -7,9 +7,9 @@
77
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
88
[![Doc](https://img.shields.io/badge/doc-%3Ah%20fern-orange.svg)](doc/fern.txt)
99
[![Doc (dev)](https://img.shields.io/badge/doc-%3Ah%20fern--develop-orange.svg)](doc/fern-develop.txt)
10-
[![reviewdog](https://github.com/lambdalisue/fern.vim/workflows/reviewdog/badge.svg)](https://github.com/lambdalisue/fern.vim/actions?query=workflow%3Areviewdog)
11-
[![vim](https://github.com/lambdalisue/fern.vim/workflows/vim/badge.svg)](https://github.com/lambdalisue/fern.vim/actions?query=workflow%3Avim)
12-
[![neovim](https://github.com/lambdalisue/fern.vim/workflows/neovim/badge.svg)](https://github.com/lambdalisue/fern.vim/actions?query=workflow%3Aneovim)
10+
[![reviewdog](https://github.com/lambdalisue/vim-fern/workflows/reviewdog/badge.svg)](https://github.com/lambdalisue/vim-fern/actions?query=workflow%3Areviewdog)
11+
[![vim](https://github.com/lambdalisue/vim-fern/workflows/vim/badge.svg)](https://github.com/lambdalisue/vim-fern/actions?query=workflow%3Avim)
12+
[![neovim](https://github.com/lambdalisue/vim-fern/workflows/neovim/badge.svg)](https://github.com/lambdalisue/vim-fern/actions?query=workflow%3Aneovim)
1313

1414
<p align="center">
1515
<strong>Split windows (netrw style)</strong><br>
@@ -39,11 +39,12 @@
3939
</p>
4040
<p align="right">
4141
<sup>
42-
See <a href="https://github.com/lambdalisue/fern.vim/wiki/Screenshots" target="_blank">Screenshots</a> for more screenshots.
42+
See <a href="https://github.com/lambdalisue/vim-fern/wiki/Screenshots" target="_blank">Screenshots</a> for more screenshots.
4343
</sup>
4444
</p>
4545

46-
Fern ([furn](https://www.youtube.com/watch?v=SSYgr-_69mg)) is a general purpose asynchronous tree viewer written in pure Vim script.
46+
Fern ([furn](https://www.youtube.com/watch?v=SSYgr-_69mg)) is a general purpose
47+
asynchronous tree viewer written in pure Vim script.
4748

4849
---
4950

@@ -56,7 +57,8 @@ Fern ([furn](https://www.youtube.com/watch?v=SSYgr-_69mg)) is a general purpose
5657
## Concept
5758

5859
- Supports both Vim and Neovim without any external dependencies
59-
- Support _split windows_ and _project drawer_ explained in [this article](http://vimcasts.org/blog/2013/01/oil-and-vinegar-split-windows-and-project-drawer/)
60+
- Support _split windows_ and _project drawer_ explained in
61+
[this article](http://vimcasts.org/blog/2013/01/oil-and-vinegar-split-windows-and-project-drawer/)
6062
- Provide features as actions so that user don't have to remember mappings
6163
- Make operation asynchronous as much as possible to keep latency
6264
- User experience is more important than simplicity (maintainability)
@@ -65,9 +67,14 @@ Fern ([furn](https://www.youtube.com/watch?v=SSYgr-_69mg)) is a general purpose
6567

6668
## Installation
6769

68-
fern.vim has no extra dependencies so use your favorite Vim plugin manager or see [How to install](https://github.com/lambdalisue/fern.vim/wiki#how-to-install) page for detail.
70+
vim-fern has no extra dependencies so use your favorite Vim plugin manager or
71+
see
72+
[How to install](https://github.com/lambdalisue/vim-fern/wiki#how-to-install)
73+
page for detail.
6974

70-
- If you use Neovim < 0.8, you **SHOULD** add [antoinemadec/FixCursorHold.nvim](https://github.com/antoinemadec/FixCursorHold.nvim) (See [#120](https://github.com/lambdalisue/fern.vim/issues/120))
75+
- If you use Neovim < 0.8, you **SHOULD** add
76+
[antoinemadec/FixCursorHold.nvim](https://github.com/antoinemadec/FixCursorHold.nvim)
77+
(See [#120](https://github.com/lambdalisue/vim-fern/issues/120))
7178

7279
## Usage
7380

@@ -112,15 +119,21 @@ The following options are available for fern viewer.
112119

113120
![Screencast of Project drawer](https://user-images.githubusercontent.com/546312/73184080-324fa380-415f-11ea-8280-e0b6c7a9989f.gif)
114121

115-
All usage above open fern as [*split windows style*][]. To open fern as [*project drawer style*][], use `-drawer` option like:
122+
All usage above open fern as [_split windows style_][*split windows style*]. To
123+
open fern as [_project drawer style_][*project drawer style*], use `-drawer`
124+
option like:
116125

117126
```vim
118127
:Fern . -drawer
119128
```
120129

121-
A fern window with _project drawer_ style always appeared to the most left side of Vim and behaviors of some mappings/actions are slightly modified (e.g. a buffer in the next window will be used as an anchor buffer in a project drawer style to open a new buffer.)
130+
A fern window with _project drawer_ style always appeared to the most left side
131+
of Vim and behaviors of some mappings/actions are slightly modified (e.g. a
132+
buffer in the next window will be used as an anchor buffer in a project drawer
133+
style to open a new buffer.)
122134

123-
Note that additional to the all options available for _split windows_ style, _project drawer_ style enables the following options:
135+
Note that additional to the all options available for _split windows_ style,
136+
_project drawer_ style enables the following options:
124137

125138
| Option | Default | Description |
126139
| --------- | ------- | ---------------------------------------------------------------- |
@@ -137,25 +150,26 @@ Note that additional to the all options available for _split windows_ style, _pr
137150

138151
### Actions
139152

140-
To execute actions, hit `a` on a fern buffer and input an action to perform.
141-
To see all actions available, hit `?` or execute `help` action then all available actions will be listed.
153+
To execute actions, hit `a` on a fern buffer and input an action to perform. To
154+
see all actions available, hit `?` or execute `help` action then all available
155+
actions will be listed.
142156

143157
![Actions](https://user-images.githubusercontent.com/546312/73184453-c91c6000-415f-11ea-8e6b-f1df4b9284de.gif)
144158

145159
### Window selector
146160

147161
The `open:select` action open a prompt to visually select window to open a node.
148-
This feature is strongly inspired by [t9md/vim-choosewin][].
162+
This feature is strongly inspired by [t9md/vim-choosewin][t9md/vim-choosewin].
149163

150164
![Window selector](https://user-images.githubusercontent.com/546312/73605707-090e9780-45e5-11ea-864a-457dd785f1c4.gif)
151165

152166
[t9md/vim-choosewin]: https://github.com/t9md/vim-choosewin
153167

154168
### Renamer action (A.k.a exrename)
155169

156-
The `rename` action open a new buffer with path of selected nodes.
157-
Users can edit that buffer and `:w` applies the changes.
158-
This feature is strongly inspired by [shougo/vimfiler.vim][].
170+
The `rename` action open a new buffer with path of selected nodes. Users can
171+
edit that buffer and `:w` applies the changes. This feature is strongly inspired
172+
by [shougo/vimfiler.vim][shougo/vimfiler.vim].
159173

160174
![Renamer](https://user-images.githubusercontent.com/546312/73184814-5d86c280-4160-11ea-9ed1-d5a8d66d1774.gif)
161175

@@ -165,8 +179,10 @@ This feature is strongly inspired by [shougo/vimfiler.vim][].
165179

166180
## Users
167181

168-
Most of functionalities are provided as plugins in fern.
169-
So visit [Github topics of `fern-vim-plugin`](https://github.com/topics/fern-vim-plugin) or [Plugins](https://github.com/lambdalisue/fern.vim/wiki/Plugins) page to find fern plugins to satisfy your wants.
182+
Most of functionalities are provided as plugins in fern. So visit
183+
[Github topics of `fern-vim-plugin`](https://github.com/topics/fern-vim-plugin)
184+
or [Plugins](https://github.com/lambdalisue/vim-fern/wiki/Plugins) page to find
185+
fern plugins to satisfy your wants.
170186

171187
For example, following features are provided as official plugins
172188

@@ -179,18 +195,20 @@ And lot more!
179195

180196
## Developers
181197

182-
Please add `fern-vim-plugin` topic to your fern plugin. The topic is used to list up 3rd party fern plugins.
198+
Please add `fern-vim-plugin` topic to your fern plugin. The topic is used to
199+
list up 3rd party fern plugins.
183200
![](https://user-images.githubusercontent.com/546312/94343538-d160ce00-0053-11eb-9ec6-0dd2a4c3f4b0.png)
184201

185202
Then please add a following badge to indicate that your plugin is for fern.
186203

187204
```
188-
[![fern plugin](https://img.shields.io/badge/🌿%20fern-plugin-yellowgreen)](https://github.com/lambdalisue/fern.vim)
205+
[![fern plugin](https://img.shields.io/badge/🌿%20fern-plugin-yellowgreen)](https://github.com/lambdalisue/vim-fern)
189206
```
190207

191208
## Customize
192209

193-
Use `FileType fern` autocmd to execute initialization scripts for fern buffer like:
210+
Use `FileType fern` autocmd to execute initialization scripts for fern buffer
211+
like:
194212

195213
```vim
196214
function! s:init_fern() abort
@@ -204,21 +222,25 @@ augroup fern-custom
204222
augroup END
205223
```
206224

207-
The `FileType` autocmd will be invoked AFTER a fern buffer has initialized but BEFORE contents of a buffer become ready.
208-
So avoid accessing actual contents in the above function.
225+
The `FileType` autocmd will be invoked AFTER a fern buffer has initialized but
226+
BEFORE contents of a buffer become ready. So avoid accessing actual contents in
227+
the above function.
209228

210-
See [Tips](https://github.com/lambdalisue/fern.vim/wiki/Tips) pages to find tips, or write pages to share your tips ;-)
229+
See [Tips](https://github.com/lambdalisue/vim-fern/wiki/Tips) pages to find
230+
tips, or write pages to share your tips ;-)
211231

212232
# Contribution
213233

214234
Any contribution including documentations are welcome.
215235

216-
Contributors who change codes should install [thinca/vim-themis][] to run tests before complete a PR.
217-
PRs which does not pass tests won't be accepted.
236+
Contributors who change codes should install
237+
[thinca/vim-themis][thinca/vim-themis] to run tests before complete a PR. PRs
238+
which does not pass tests won't be accepted.
218239

219240
[thinca/vim-themis]: https://github.com/thinca/vim-themis
220241

221242
# License
222243

223-
The code in fern.vim follows MIT license texted in [LICENSE](./LICENSE).
224-
Contributors need to agree that any modifications sent in this repository follow the license.
244+
The code in vim-fern follows MIT license texted in [LICENSE](./LICENSE).
245+
Contributors need to agree that any modifications sent in this repository follow
246+
the license.

autoload/fern/internal/drawer/smart_quit.vim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ function! s:smart_quit() abort
3232
let winid = win_getid()
3333
if has('patch-8.1.1756') || has('nvim-0.7.1')
3434
" Use timer to avoid E242 in Vim
35-
" https://github.com/lambdalisue/fern.vim/issues/435
35+
" https://github.com/lambdalisue/vim-fern/issues/435
3636
call timer_start(0, { -> s:complement(winid, width) })
3737
else
3838
call s:complement(winid, width)

autoload/fern/internal/viewer.vim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ function! s:init() abort
5050
setlocal noswapfile nobuflisted nomodifiable
5151
setlocal signcolumn=yes
5252
" The 'foldmethod=manual' is required to avoid the following issue
53-
" https://github.com/lambdalisue/fern.vim/issues/331
53+
" https://github.com/lambdalisue/vim-fern/issues/331
5454
setlocal foldmethod=manual
5555

5656
augroup fern_internal_viewer_init

autoload/fern/util.vim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ function! fern#util#obsolete(name, ...) abort
4141
endfunction
4242

4343
" Apply workaround to expand() issue of completeslash on Windows
44-
" See https://github.com/lambdalisue/fern.vim/issues/226
44+
" See https://github.com/lambdalisue/vim-fern/issues/226
4545
if exists('+completeslash')
4646
function! fern#util#expand(expr) abort
4747
let completeslash_saved = &completeslash

doc/fern-develop.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*fern-develop.txt* Developer documentations for fern.vim
1+
*fern-develop.txt* Developer documentations for vim-fern
22

33
Author: Alisue <[email protected]>
44
License: MIT license
@@ -24,7 +24,7 @@ UTILITY |fern-develop-utility|
2424
=============================================================================
2525
INTRODUCTION *fern-develop-introduction*
2626

27-
This is documentation for |fern.vim| developer.
27+
This is documentation for |vim-fern| developer.
2828

2929

3030
=============================================================================

doc/fern.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ DEVELOPMENT |fern-development|
3131
=============================================================================
3232
INTRODUCTION *fern-introduction*
3333

34-
*fern.vim* (fern) is a general purpose asynchronous tree explorer written in
34+
*vim-fern* (fern) is a general purpose asynchronous tree explorer written in
3535
pure Vim script. It provides "file" scheme in default to use it as a file
3636
explorer.
3737

@@ -41,7 +41,7 @@ FEATURES *fern-features*
4141
No external dependencies~
4242
Fern is written in pure Vim script without any external libraries
4343
(note that vim-jp/vital.vim is bundled, not external dependencies) so
44-
users do NOT need to install anything rather than fern.vim itself.
44+
users do NOT need to install anything rather than vim-fern itself.
4545
Exception: "trash" feature in Linux.
4646
https://github.com/lambdalisue/vital-Whisky/issues/31
4747

@@ -233,7 +233,7 @@ For example, following execute "open" on leaf but "expand" on branch.
233233
\ "<Plug>(fern-action-expand)",
234234
\ )
235235
<
236-
See https://github.com/lambdalisue/fern.vim/wiki/ for custom tips.
236+
See https://github.com/lambdalisue/vim-fern/wiki/ for custom tips.
237237

238238

239239
=============================================================================
@@ -250,11 +250,11 @@ RENDERER *fern-renderer*
250250

251251
Renderer is an object to render nodes as a tree like (default renderer):
252252
>
253-
fern.vim
253+
vim-fern
254254
|- autoload
255255
|+ fern
256256
|+ vital
257-
| fern.vim
257+
| vim-fern
258258
|- doc
259259
| fern-develop.txt
260260
| fern.txt
@@ -400,7 +400,7 @@ VARIABLE *fern-variable*
400400
*g:fern#disable_viewer_spinner*
401401
Set 1 to disable viewer spinner shown on a sign column.
402402
Note that the default value will be 1 if CUI Vim is running on
403-
Windows. See https://github.com/lambdalisue/fern.vim/issues/256 for
403+
Windows. See https://github.com/lambdalisue/vim-fern/issues/256 for
404404
detail.
405405

406406
*g:fern#disable_viewer_auto_duplication*
@@ -420,7 +420,7 @@ VARIABLE *fern-variable*
420420

421421
Note that this feature is automatically disabled on floating windows
422422
of Neovim to avoid unwilling resize reported as #294
423-
https://github.com/lambdalisue/fern.vim/issues/294
423+
https://github.com/lambdalisue/vim-fern/issues/294
424424

425425
Default: 0
426426

0 commit comments

Comments
 (0)