https://github.com/yukimemi/asyncwalker.vim
Vim plugin for asynchronous walk files
https://github.com/yukimemi/asyncwalker.vim
deno neovim neovim-plugin vim vim-denops vim-plugin
Last synced: 2 months ago
JSON representation
Vim plugin for asynchronous walk files
- Host: GitHub
- URL: https://github.com/yukimemi/asyncwalker.vim
- Owner: yukimemi
- Created: 2021-04-03T09:50:54.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T06:08:33.000Z (8 months ago)
- Last Synced: 2024-10-17T18:14:26.837Z (8 months ago)
- Topics: deno, neovim, neovim-plugin, vim, vim-denops, vim-plugin
- Language: TypeScript
- Homepage:
- Size: 122 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# asyncwalker
Denops scan and walk files.
# Features
asyncwalker is a Vim plugin that walks files.
# Installation
If you use [folke/lazy.nvim](https://github.com/folke/lazy.nvim).
```lua
{
"yukimemi/asyncwalker.vim",
lazy = false,
dependencies = {
"vim-denops/denops.vim",
},
}
```
If you use [yukimemi/dvpm](https://github.com/yukimemi/dvpm).
```typescript
dvpm.add({ url: "yukimemi/asyncwalker.vim" });
```
# Requirements
- [Deno - A modern runtime for JavaScript and TypeScript](https://deno.land/)
- [vim-denops/denops.vim: 🐜 An ecosystem of Vim/Neovim which allows developers to write cross-platform plugins in Deno](https://github.com/vim-denops/denops.vim)
# Usage
No special settings are required.
`:AsyncWalk` and `:AsyncWalkBufferDir` command are available.
# Commands
`:AsyncWalk [--path=path]`
Walk files and display buffer.
You can filter files by typing.
If --path is not specified, current directory is used.
`:AsyncWalkBufferDir`
Same as `:AsyncWalk --path="%:p:h"`.
`:AsyncWalkResume`
Resume walk buffer.
# Config
No settings are required. However, the following settings can be made if necessary.
`g:asyncwalker_debug`
Enable debug messages.
default is v:false
`g:asyncwalker_height`
Height of walk buffer.
default is 15
`g:asyncwalker_chunk`
Chunk size of walk buffer.
default is 500
`g:asyncwalker_ignore`
Ignore patterns.
default is ["\\.git", "\\.svn", "\\.hg", "\\.o$", "\\.obj$", "\\.a$", "\\.exe~?$", "tags$"]
`g:asyncwalker_no_mapping`
Whether to disable default mappings.
default is v:false
# Mappings
On filter buffer (`asyncwalker-filter`), you can use the following mappings.
`(asyncwalker-cursor-down)`
Cursor move next line. (Default is )
`(asyncwalker-cursor-up)`
Cursor move previous line. (Default is )
`(asyncwalker-escape)`
Escape filter buffer and go to walk buffer. (Default is )
`(asyncwalker-enter)`
Open cursor selected line. (Default is )
`(asyncwalker-quit)`
Quit walk and filter buffer. (Default is )
`(asyncwalker-insert)`
Go to filter buffer. (Default is i and a)
# Example
```vim
nnoremap wa AsyncWalk
nnoremap ws AsyncWalk --path=~/src
nnoremap wD AsyncWalk --path=~/.dotfiles
nnoremap wc AsyncWalk --path=~/.cache
nnoremap wm AsyncWalk --path=~/.memolist
nnoremap wd AsyncWalkBufferDir
nnoremap wr AsyncWalkResume
```
# License
Licensed under MIT License.
Copyright (c) 2023 yukimemi