The nvimhost-scala from viniarck

nvimhost-scala's Introduction

nvimhost-scala

Neovim (nvim) host plugin provider and API client library in Scala.

Screencast

Goals

Provide an API for other projects to integrate with nvim.
Provide a library for high-performance plugins with Scala static types.
Pay the JVM startup cost only once (when the plugin is first called).

Docs

You can find the API client code on Api.scala, it's fully asynchronous based on scala.concurrent.Future
If you want to develop a plugin you should read how to write a plugin.

Docs TLDR for Scala 2.13

libraryDependencies += "io.github.viniarck" %% "nvimhost-scala" % "1.1.0"

How to compile with SBT

In the CI yml file there's a complete example how to compile, source (from Neovim) and run the plugin.
In the test folder, on build.sbt you can find a base configuration to start your build.sbt configuration.

nvimhost-scala's People

Stargazers

Watchers

nvimhost-scala's Issues

Possible to use to create UI?

Is it possible to use this plugin to create custom UI? If no, are there any plans to make it possible?

Hello! I’m interested in writing a plugin using this library, but there doesn’t appear to be any documentation on how to create an application which Neovim can communicate with via stdin/stdout after starting the app [binary] with jobstart(). Would you mind giving a short example of this, with the necessary Scala and Vimscript code?

For example, the following article details how to do this with Rust and the neovim-lib library: https://blog.usejournal.com/a-detailed-guide-to-writing-your-first-neovim-plugin-in-rust-a81604c606b1

Something like that (but shorter and just the code) would be very helpful.