Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FelixKratz/SketchyVim
Adds all vim moves and modes to macOS text fields
https://github.com/FelixKratz/SketchyVim
accessibility input keyboard-shortcuts macos text vim
Last synced: 3 months ago
JSON representation
Adds all vim moves and modes to macOS text fields
- Host: GitHub
- URL: https://github.com/FelixKratz/SketchyVim
- Owner: FelixKratz
- License: gpl-3.0
- Created: 2022-02-11T20:30:00.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T07:27:24.000Z (8 months ago)
- Last Synced: 2024-06-17T08:32:28.335Z (5 months ago)
- Topics: accessibility, input, keyboard-shortcuts, macos, text, vim
- Language: C
- Homepage:
- Size: 8.18 MB
- Stars: 584
- Watchers: 5
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- vim-keybindings-everywhere-the-ultimate-list - sketchyvim - Get vim-like navigation in any macOS text field. (System-wide)
README
# SketchyVim
This small project turns accessible(!) input fields on macOS into full vim
buffers. It should behave and feel like native vim, because, under the hood
I synchronize the text field with a real vim buffer.
You can use all modes (even commandline etc.) and all commands included in vim.
It is also possible to load a custom `svimrc` file, which can contain
custom vim configurations, e.g. remappings (see the examples folder).
Additionally, you can edit the `blacklist` file in the `~/.config/svim/` folder
to manually exclude applications from being handled by svim.
You will likely want to blacklist your terminal emulator and gvim, such that there
is no conflict.
Every time the vim mode changes, or a commandline update is issued, the script
`svim.sh` in the folder `~/.config/svim/` is executed where you can handle
how you want to process this information. I have a small popup in my [SketchyBar](https://github.com/FelixKratz/SketchyBar)
which shows me the command line output on demand for example.
(!): Accessible means, that the input field needs to conform to the accessibility
standards for text input fields, else there is nothing we can do.
## Installation
You can install this using brew from my tap:
```bash
brew tap FelixKratz/formulae
brew install svim
```
and then you can start the brew service using:
```
brew services start svim
```
where you will be asked to grant accessibility permissions.
You can change the macOS selection color to anything you like with this command (which is my green):
```bash
defaults write NSGlobalDomain AppleHighlightColor -string "0.615686 0.823529 0.454902"
```
## Issues
Please tell me if you encounter issues.
Known Issues:
-------------
* Multikey remappings are not recognized (e.g. jk for esc)
* Some text fields break the accessibility api and this leads to bugs,
be sure to blacklist all apps that are affected by this.
Sometimes it helps to switch to a "raw" or "markdown" editing mode on websites,
such that there is no interference.
Generally, Safari seems to make most text fields available, while Firefox does not.
* Comments in svimrc break the config (#18)
## Contributions
Pull requests are welcome. If you improve the code for your own use, consider creating
a pull request, such that all people (including me) can enjoy those improvements.
## Credits
* I use the libvim library which is a compact and minimal c library for the vim core.
* Many prior projects tried to accomplish a similar vision by rebuilding the vim
movements by hand, those have inspired me to create this project.