Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chtenb/helix.vim
Emulate Helix keybindings inside Vim emulators
https://github.com/chtenb/helix.vim
helix helix-editor kakoune text-editor vim
Last synced: 24 days ago
JSON representation
Emulate Helix keybindings inside Vim emulators
- Host: GitHub
- URL: https://github.com/chtenb/helix.vim
- Owner: chtenb
- License: mit
- Created: 2023-10-03T06:44:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-18T08:41:21.000Z (4 months ago)
- Last Synced: 2024-07-18T10:54:31.606Z (4 months ago)
- Topics: helix, helix-editor, kakoune, text-editor, vim
- Language: Vim Script
- Homepage:
- Size: 332 KB
- Stars: 37
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A set of unholy Vim keybindings to make it behave like [Helix](https://github.com/helix-editor/helix).
Useful for IDEs with a Vim emulator but no Helix emulator.
# Usage
Download or clone the Vim files from this repository.
Cloning is probably easier for keeping up-to-date.
```
git clone https://github.com/chtenb/helix.vim ~/helix.vim/
```
Then source the relevant `.vim` files in your `.vimrc`.
### For generic Vim
```
source ~/helix.vim/helix.vim
```
### For Visual Studio/VsVim
Make sure [VsVim](https://github.com/VsVim/VsVim) is installed. Then
```
source ~/helix.vim/helix.vs.vim
```
When [PeasyMotion](https://github.com/msomeone/PeasyMotion) is installed, `gw` will behave similarly as in helix.
### For JetBrains IDE's with IdeaVim
```
source ~/helix.vim/helix.idea.vim
```
#### Additional plugins used in the mappings
- [KJump](https://plugins.jetbrains.com/plugin/10149-kjump) for `gw`
- [String manipulation](https://plugins.jetbrains.com/plugin/2162-string-manipulation) for `&`
- [Tab Shifter](https://plugins.jetbrains.com/plugin/7475-tab-shifter) for directional window navigation
### For other Vim emulators
Your best bet is to source `helix.vim`, but you will probably run into emulator-specific bugs or quirks.
If you manage to develop a working set of mappings for an IDE that is not included here yet, feel free to open a pull request for it.
Also have a look at `apocryphal.vim` and `apocryphal.vs.vim` for mappings that are not canonical for Helix, but you may find useful nonetheless.
# Limitations
Vim has no builtin LSP, Treesitter or multiple selection support, so the generic mapping set lacks bindings that rely on these features.
Depending on the IDE some functionality can be emulated in IDE-specific mappings.
See [src/helix.vs.vim](https://github.com/chtenb/helix.vim/blob/main/src/helix.vs.vim) for examples.
# Documentation
The documentation consists of the scripts themselves, in `src/`,
most notably [src/helix.vim](https://github.com/chtenb/helix.vim/blob/main/src/helix.vim) and [src/helix.vs.vim](https://github.com/chtenb/helix.vim/blob/main/src/helix.vs.vim).
# Development
The source files are in `src/` and are compiled into top-level scripts with the `compile.sh` script.
For convenient development it is recommended that you source the files directly from `src/` and add the following mapping for reloading the keymap.
```
noremap :mapclear:source ~/.vimrc:echo "reloaded!"
```
Pull requests for fixes and additional emulator support are welcome.