Onivim 2 User Manual

Onivim 2 User Manual

  • Early Access
  • About
  • Timeline
  • Docs

›Languages

Getting Started

  • Why Onivim?
  • Installation
  • Vim Differences
  • Tips for Vim Users
  • Tips for VSCode Users
  • Modal Editing 101

Basic Usage

  • Moving Around
  • Editing and Deleting Text
  • Visual Mode (Selection)
  • Working with Files
  • Formatting
  • Language Features
  • Command Line
  • Integrated Terminal
  • Emmet
  • Snippets

Configuration

  • Settings
  • Key Bindings
  • Extensions

Languages

  • Reason & OCaml
  • ReScript
  • Python
  • Go
  • Java
  • C / C++
  • C#
  • Rust

For Developers

  • Architecture
  • Building from Source
  • How to Contribute
  • Style Guide
  • License Key Bounty

Other

  • FAQ
  • Appendix A: v2 Design Doc
  • Appendix B: More Resources
Edit

Reason & OCaml

Being authored in Reason, Onivim supports Reason as well as sister languages like OCaml.

Onivim comes out-of-the-box with support for syntax highlighting and language detection for Reason & OCaml.

However, to get the most out of Onivim for these languages, you'll need a language server - we recommend ocaml-lsp.

Setup for a native esy project

If you're building a Reason or OCaml project with esy, simply add the following to the devDependencies of your package.json or esy.json:

  "devDependencies": {
    "@opam/ocaml-lsp-server": "ocaml/ocaml-lsp:ocaml-lsp-server.opam"
  }

Run esy to install and build, and open Onivim in the directory of your project.

Setup for a native opam project

You can install ocaml-lsp-server via these OPAM commands:

$ opam pin add ocaml-lsp-server https://github.com/ocaml/ocaml-lsp.git
$ opam install ocaml-lsp-server

Build your project, and then open Onivim in the directory of your project.

FAQ

I'm not getting completions or diagnostics - what can I try?

The tooling depends on the project being built - so make sure your project is built before you open Onivim.

Why isn't ocaml-lsp bundled with Onivim?

The ocamllsp binary depends on Merlin, which is tightly coupled to the OCaml compiler version being used - therefore, we rely on the environment to supply the correct ocamllsp binary for the current compiler version.

← ExtensionsReScript →
  • Setup for a native esy project
  • Setup for a native opam project
  • FAQ
    • I'm not getting completions or diagnostics - what can I try?
    • Why isn't ocaml-lsp bundled with Onivim?
Onivim 2 User Manual
Docs
Getting StartedBasic UsageFor DevelopersFAQ
Community
RedditDiscordTwitter
More
GitHubStar
Copyright © 2022 Outrun Labs, LLC