1
1
mirror of https://github.com/qvacua/vimr.git synced 2024-12-01 01:32:04 +03:00
VimR — Neovim GUI for macOS in Swift
Go to file
2023-10-30 14:27:31 -07:00
.github The nightly release may not be present 2022-06-30 19:55:32 +02:00
bin update build scripts 2023-10-30 14:21:48 -07:00
Commons bump min os to get things working 2023-10-30 14:27:31 -07:00
docs Update DEVELOP.md 2021-12-13 18:47:02 +01:00
Ignore Reformat 2022-12-15 15:25:24 +09:00
Neovim@3dcf6880ad bump nvim to head 2023-10-30 14:01:26 -07:00
NvimServer update build scripts 2023-10-30 14:21:48 -07:00
NvimView bump min os to get things working 2023-10-30 14:27:31 -07:00
resources Talk to external nvim without uibridge 2023-10-29 13:46:05 -07:00
RxPack bump min os to get things working 2023-10-30 14:27:31 -07:00
Tabs Update deps 2022-11-03 16:16:36 +01:00
VimR bump min os to get things working 2023-10-30 14:27:31 -07:00
VimR.xcworkspace update workspace 2023-10-30 13:26:41 -07:00
Workspace Reformat 2022-12-15 15:25:24 +09:00
.gitattributes Add waiting script for notarization 2019-12-22 21:45:42 +01:00
.gitignore update ignores for swiftpm 2023-10-30 13:26:21 -07:00
.gitmodules rename neovim 2023-10-30 10:57:58 -07:00
.swiftformat Reformat 2022-12-15 15:25:24 +09:00
.swiftlint.yml Add Airbnb's swiftlint rules 2021-12-24 09:54:18 +01:00
appcast_snapshot.xml Update appcast 2023-01-03 18:14:18 +01:00
appcast.xml Update appcast 2023-01-03 18:14:18 +01: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 DEVELOP 2022-06-30 21:28:45 +02:00
LICENSE Implement VCS ignoring in Swift and use fzy to fuzzy match 2022-06-16 15:26:39 +02:00
README.md readme and ignores 2023-10-29 13:50:52 -07:00

VimR — Neovim GUI for macOS

DownloadDocumentation

Screenshot 1 Screenshot 2

Fork differences

Originially and wonderfully by qvacua which appears to be unsupported any more.

This version can talk to an arbitrary nvim (once the upstream bits get merged) It therefore should be able to keep pace with nvim development better. Work was done to avoid having to modify neovim, and the uibridge mechanism has been replaced with api calls.

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

clean=true notarize=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