tek / ribosome

A Neovim plugin host and framework for Haskell

Overview

Ribosome is a suite of libraries for building Neovim remote plugins in Haskell, using the algebraic effect system Polysemy as its foundation.

Its components are:

• ribosome High-level functionality for writing plugins
• ribosome-host MessagePack RPC server and TH-generated API functions
• ribosome-host-test Test utilities for ribosome-host
• ribosome-test Test utilities for ribosome
• ribosome-menu A fuzzy-finder menu tool

Quickstart

Install the Nix package manager and generate a skeleton project by running:

$ nix run 'github:tek/ribosome#new'

The new project will contain configuration for Github Actions that release binary executables on each push that will be downloaded automatically when a user starts the plugin for the first time, with support for pushing to and downloading from Cachix.

After initial generation, the Github Actions and Neovim boot files can be regenerated by running:

$ nix run '.#boot'