CaryWill / kindaVim.docs

Ultimate Vim Mode for macOS

Home Page:https://kindavim.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

kindaVim brings Vim moves to macOS Input Fields and UI Elements.

awesome stuff happening in there


The Site

kindavim.app for all the fancy stuff.

Why kindaVim

Vim moves anywhere? That's fucking cool. Also kV makes using the keyboard more consistent on the whole macOS, where sometimes CTRL-P/CTRL-N works to go up/down lists, and sometimes it doesn't. Very annoying.

License

Unlimited trial. The trial is: without a coffee a month kindaVim sleeps in the mornings. (It will scold you from the Menu Bar when you'll try to use it.) You're still able to use it fully-featured the afternoons. (Until 5am the next day. Those are long afternoons, yes.) So if you're like me and spend your mornings reading, swimming in the open sea or climbing rocks, then kV is basically free.

Current Vim Implementation

Motions

Note
For motions that accept regexes, kV uses the ICU Regular Expressions (Perl) rather than Vim's own flavor ones.

kV Accessibility Strategy: text manipulation; accurate.

See the motions implemented.

kV Keyboard Strategy: keyboard remapping; less accurate.

See the motions implemented.

Commands

See the commands implementation.

APIs

kindaVim sends Distributed Notifications to macOS when the Vim Mode changes, so that you can hook an external tool like BetterTouchTool or Hammerspoon and respond to those changes. The Notifications Names should be self-explanatory:

  • kindaVimDidEnterInsertMode
  • kindaVimDidExitInsertMode
  • kindaVimDidEnterNormalMode
  • kindaVimDidExitNormalMode
  • kindaVimDidEnterVisualMode
  • kindaVimDidExitVisualMode

Sync your Preferences

Currently the Preferences are a plist file located at ~/Library/Preferences/mo.com.sleeplessmind.kindaVim.plist. You can add it to your dotfiles, or use a tool like Mackup to keep the Preferences in sync between your computers. (Mackup explicitely supports kindaVim.)

Feedback

  • whether you need a missing move, want to report a bug or ask for a feature, just open an issue.

AccessibilityStrategyTestApp

Testing the Vim moves when using the macOS Accessibility requires building an external app. This app, as well as the tests of each move in the context of the Accessibility Strategy, are open source and available here: AccessibilityStrategyTestApp

Alternatives

Acknowledgments

About

Ultimate Vim Mode for macOS

https://kindavim.app