qvacua/vimr
1
1
Fork 0
mirror of https://github.com/qvacua/vimr.git synced 2024-12-25 06:43:24 +03:00
Code Issues Projects Releases Wiki Activity
VimR — Neovim GUI for macOS in Swift
4,007 Commits 6 Branches 428 Tags 39 MiB
Swift 90.5%
CSS 2.7%
Shell 2.5%
Python 2.2%
HTML 0.7%
Other 1.4%
c05d20269a
Go to file
Tae Won Ha c05d20269a
Make classes final if possible
2022-06-26 15:19:30 +02:00
.github Implement VCS ignoring in Swift and use fzy to fuzzy match 2022-06-16 15:26:39 +02:00
bin Update appcast and adapt release script 2022-06-16 15:51:12 +02:00
Commons wip 2022-06-17 22:42:20 +02:00
docs Update DEVELOP.md 2021-12-13 18:47:02 +01:00
Ignore Make classes final if possible 2022-06-26 15:19:30 +02:00
NvimServer@3a0dc4b9d4 Update submodule 2022-06-18 17:35:04 +02:00
NvimView Make classes final if possible 2022-06-26 15:19:30 +02:00
resources Bump version 2022-06-18 16:19:07 +02:00
Tabs Make classes final if possible 2022-06-26 15:19:30 +02:00
VimR Make classes final if possible 2022-06-26 15:19:30 +02:00
VimR.xcworkspace Extract Rx classes for MessagePort and MsgpackRPC and move RxNeovimApi to NvimServer 2022-06-18 11:48:40 +02:00
Workspace Make classes final if possible 2022-06-26 15:19:30 +02:00
.gitattributes Add waiting script for notarization 2019-12-22 21:45:42 +01:00
.gitignore Add a dev target 2019-03-14 09:56:23 +01:00
.gitmodules Add NvimServer as submodule and add a script for local dev 2020-08-18 19:20:40 +02:00
.swiftformat Reformat using swiftformat 2020-09-18 16:01:55 +02:00
.swiftlint.yml Add Airbnb's swiftlint rules 2021-12-24 09:54:18 +01:00
appcast_snapshot.xml Update appcast 2022-06-18 16:26:25 +02:00
appcast.xml Update appcast 2022-06-18 16:26:25 +02:00
Brewfile Add SDKROOT when building libnvim 2020-03-26 22:39:58 +01:00
Cartfile Update deps and release notes 2021-11-30 18:50:13 +01:00
Cartfile.resolved Update version to SNAPSHOT-20211201.192602 2021-12-01 19:27:12 +01:00
DEVELOP.md Update appcast and adapt release script 2022-06-16 15:51:12 +02:00
LICENSE Implement VCS ignoring in Swift and use fzy to fuzzy match 2022-06-16 15:26:39 +02:00
README.md Implement VCS ignoring in Swift and use fzy to fuzzy match 2022-06-16 15:26:39 +02:00

README.md

VimR — Neovim GUI for macOS

Download • Documentation

Screenshot 1 Screenshot 2

About

Project VimR is a Neovim GUI for macOS. The goal is to build an editor that uses Neovim inside with many of the convenience GUI features similar to those present in modern editors. We mainly use Swift, but also use C/Objective-C when where appropriate.

There are other Neovim GUIs for macOS, see the list, so why?

  • Play around with Neovim,
  • play around with Swift (and especially with RxSwift), and
  • (most importantly) have fun!

If you want to support VimR financially, use Github's Sponsor.

Download

Pre-built Universal signed and notarized binaries can be found under Releases.

Reusable Components

  • RxMessagePort: RxSwift wrapper for local and remote CFMessagePort.
  • RxMsgpackRpc: Implementation of MsgpackRpc using RxSwift.
  • RxNeovimApi: RxSwift wrapper of Neovim API.
  • NvimView: SwiftPM module which bundles everything, e.g. Neovim's runtime-files, needed to embed Neovim in a Cocoa App.

Some Features

  • Markdown preview
  • Generic HTML preview (retains the scroll position when reloading)
  • Fuzzy file finder a la Xcode's "Open Quickly..."
  • Trackpad support: Pinching for zooming and two-finger scrolling.
  • Ligatures: Turned off by default. Turn it on in the Preferences.
  • Command line tool.
  • (Simple) File browser
  • Flexible workspace model a la JetBrain's IDEs

How to Build

Clone this repository. Install homebrew, then in the project root:

git submodule init
git submodule update

xcode-select --install # install the Xcode command line tools, if you haven't already
brew bundle

code_sign=false use_carthage_cache=false ./bin/build_vimr.sh
# VimR.app will be placed in ./build/Build/Products/Release/

Development

See DEVELOP.md.

License

MIT