neovim / nvim.net

Nvim .NET client and plugin host

Documentation | Chat

Neovim is a project that seeks to aggressively refactor Vim in order to:

• Simplify maintenance and encourage contributions
• Split the work between multiple developers
• Enable advanced UIs without modifications to the core
• Maximize extensibility

See the Introduction wiki page and Roadmap for more information.

Features

• Modern GUIs
• API access from any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java/Kotlin, JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust
• Embedded, scriptable terminal emulator
• Asynchronous job control
• Shared data (shada) among multiple editor instances
• XDG base directories support
• Compatible with most Vim plugins, including Ruby and Python plugins

See :help nvim-features for the full list, and :help news for noteworthy changes in the latest version!

Install from package

Pre-built packages for Windows, macOS, and Linux are found on the Releases page.

Managed packages are in Homebrew, Debian, Ubuntu, Fedora, Arch Linux, Void Linux, Gentoo, and more!

Install from source

See BUILD.md and supported platforms for details.

The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command.

make CMAKE_BUILD_TYPE=RelWithDebInfo
sudo make install

To install to a non-default location:

make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/
make install

CMake hints for inspecting the build:

• cmake --build build --target help lists all build targets.
• build/CMakeCache.txt (or cmake -LAH build/) contains the resolved values of all CMake variables.
• build/compile_commands.json shows the full compiler invocations for each translation unit.

Transitioning from Vim

See :help nvim-from-vim for instructions.

Project layout

├─ cmake/           CMake utils
├─ cmake.config/    CMake defines
├─ cmake.deps/      subproject to fetch and build dependencies (optional)
├─ runtime/         plugins and docs
├─ src/nvim/        application source code (see src/nvim/README.md)
│  ├─ api/          API subsystem
│  ├─ eval/         Vimscript subsystem
│  ├─ event/        event-loop subsystem
│  ├─ generators/   code generation (pre-compilation)
│  ├─ lib/          generic data structures
│  ├─ lua/          Lua subsystem
│  ├─ msgpack_rpc/  RPC subsystem
│  ├─ os/           low-level platform code
│  └─ tui/          built-in UI
└─ test/            tests (see test/README.md)

License

Neovim contributions since b17d96 are licensed under the Apache 2.0 license, except for contributions copied from Vim (identified by the vim-patch token). See LICENSE for details.

Vim is Charityware.  You can use and copy it as much as you like, but you are
encouraged to make a donation for needy children in Uganda.  Please see the
kcc section of the vim docs or visit the ICCF web site, available at these URLs:

        https://iccf-holland.org/
        https://www.vim.org/iccf/
        https://www.iccf.nl/

You can also sponsor the development of Vim.  Vim sponsors can vote for
features.  The money goes to Uganda anyway.

nvim.net's Issues

doc: how to run the code-generator?

Need a brief snippet showing how to run the code-generator.

cc @b-r-o-c-k

Unclear on Directory Structure, and Usage with F#

Hello! So, in trying to use this library, I've come across a few things that I'm unsure about:

1. The directions for creating a plugin in the README aren't very clear to me after reading through them and trying the steps myself. The main thing I'm unsure about is the directory structure. What exactly does a valid plugin directory structure look like? Would this work or is this invalid?

.config
    nvim
        rplugin
            dotnet
                dotnet.sln
                my-plugin
                    <class and csproj and all that>

I've tried looking around but I haven't found any examples of this. For reference, python works just fine and loads the plugin when I create a remote plugin in .config/nvim/rplugin/python/<project> using pynvim, but I have been unable to achieve the same effect with F#/C# and this library.

2. Can this library be used with F#? So simply creating an F# classlib instead of a C# one and using that instead? I see no reason why it wouldn't work, but due to the first point I haven't been able to properly test it.

Thanks in advance!

Strange error when subscribing to unhandled notifications

Error invoking 'poll' on channel 92:^@ch 92 sent an invalid message, closed

I get the above error when registering commands like so:

using System;
using System.IO;

using NvimClient.API;
using NvimClient.API.NvimPlugin.Attributes;
using NvimClient.API.NvimPlugin.Parameters;

namespace Suggestions {
    [NvimPlugin]
    public class SuggestionsPlugin {
        private readonly NvimAPI nvim;
        private StreamWriter log;


        public SuggestionsPlugin(NvimAPI nvim) {
            this.nvim = nvim;
            log = File.AppendText("./logs");

            this.nvim.OnUnhandledNotification += UnhandledNotification;
        }

        [NvimFunction]
        public async void Test() {
            var currentBuffer = await this.nvim.GetCurrentBuf();
            currentBuffer.Attach(true, null);
            this.nvim.OnUnhandledNotification += UnhandledNotification;
        }

        public void UnhandledNotification(object sender, NvimUnhandledNotificationEventArgs args) {
            log.WriteLine(args.MethodName);
        }
    }
}

Any ideas whats going on? Its hard to debug this without much in the way of documentation/examples.

Migrate to .NET 6

Hey new contributor here.

.NET 6 is the replacement of .NET 5 and need to be migrated, it's not supported anymore.

Thanks, hope this repo is still active or I couldn't contribute :/

API generator: NvimAPI already contains a definition for 'Put'

Seems like the API generator might be confused about the new nvim_put API function?

https://travis-ci.org/neovim/nvim.net/builds/584789660

NvimAPI.generated.cs(459,17): error CS0102: The type 'NvimAPI' already contains a definition for 'Put' [/home/travis/build/neovim/nvim.net/src/NvimClient.API/NvimClient.API.csproj]

nuget: publish library as netstandard2.0 instead of netcoreapp2.0

installing via nuget failed for me:

    $ dotnet add my-plugin/my-plugin.csproj package NvimClient.API
    ... 
    error: Package NvimClient.API 1.0.0 is not compatible with netstandard2.0 (.NETStandard,Version=v2.0).
    Package NvimClient.API 1.0.0 supports: netcoreapp2.0 (.NETCoreApp,Version=v2.0)      
    error: Package 'NvimClient.API' is incompatible with 'all' frameworks in project 'my-plugin/my-plugin.csproj'.

• FIX: based on dotnet/sdk#1728, perhaps
  NvimClient.API should support netstandard2.0 instead of netcoreapp2.0
• WORKAROUND: target "netcoreapp" when creating the plugin

        dotnet new classlib --output my-plugin --framework netcoreapp2.1 
  

Build failing (provider setting not found) / Nuget package is not up to date

Hi,

the currently published nuget package seems to be not up to date. I've read in an earlier issue that the package gets deployed automatically after a successful build. As the build is currently failing, this might be the reason there is no current nuget package.

The error from AppVeyor seems to be the following one:

Error creating GitHub release: Provider setting not found or it's value is empty. If secure setting is used please check that value was encrypted (or YAML was exported) while being logged under correct account.
Parameter name: auth_token

It would be great if we can fix the build again.

doc: publishing to nuget

@b-r-o-c-k What are the steps you follow to publish to nuget?

Failed to load dotnet host on Windows 10

Hi,

I've tried to create a plugin using nvim.net but without any luck. It seems like the dotnet host is unable to load on Windows 10:

Failed to load dotnet host. You can try to see what happened by starting nvim with $NVIM_DOTNET_LOG_FILE set and opening the generated log file. Also, the host stderr is available in messages.

Here is the screenshot, where we can see that something is wrong with 'poll' function during :UpdateRemotePlugins:

Are there any chances it can be fixed soon? Or does the host require additional configuration?

I have the following dotnet runtimes installed:

Installed DotNet Runtimes

PS C:\Users\user> dotnet --list-runtimes
Microsoft.AspNetCore.All 2.1.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.1.3 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.1.4 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.1.5 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.1.17 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.1.24 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.All 2.2.0 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.All]
Microsoft.AspNetCore.App 2.1.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.1.3 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.1.4 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.1.5 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.1.17 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.1.24 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 2.2.0 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 3.0.0-preview3-19153-02 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 3.0.0-preview6.19307.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 3.1.11 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 5.0.1 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 5.0.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.NETCore.App 1.0.12 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 1.1.9 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.0.7 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.0.9 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.2 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.3-servicing-26724-03 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.3 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.4 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.5 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.12 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.17 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.1.24 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 2.2.0 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 3.0.0-preview6-27804-01 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 3.1.11 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 5.0.1 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 5.0.2 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 3.0.0-preview6-27804-01 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 3.1.11 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 5.0.1 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 5.0.2 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

C# / F# project templates

I think the threshold of getting started with nvim.net would be significantly reduced if project templates were available allowing one to simply type dotnet new nvim.net