tjdevries / ocaml.nvim

ocaml.nvim

Tools for working with OCaml. Status is very work in progress and likely to break. Use at your own risk (but feel free to file issues)

Just some utilties for working with ppx_rapper.

If you're not using OCaml (you should be) then this plugin is worthless to you.

Installation

Plug 'tjdevries/ocaml.nvim', {'do': ':lua require("ocaml").update()'}

And then, you'll probably need to do this before you load nvim-treesitter (if you want to use ensure_installed, but I do my best to make this not required)

require('ocaml').setup()

NOTE: you'll probably need to do this for your lspconfig (if you're using it)

  ocamllsp = {
    get_language_id = function(_, ftype)
      return ftype
    end,
  },

Feature: Highlighting

• Automatically highlight code from ppx_wraper:

let create_query =
  [%rapper
    get_one
      {|
      INSERT INTO resources (name)
      VALUES (%string{name})
      RETURNING @int{id}
    |}]
;;

You can customize the colors by doing something like:

hi! link @rapper_argument @parameter
hi! link @rapper_return @type

• Automatically highlight code from %graphql:

module SomeGraphql = [%graphql
  {| mutation deposit($account: String, $amount: UInt64) {
    changeBalance(account: $account) {
      payment {
        id
      }
    }
  } |}
];

You just need to have graphql grammar installed.

Feature: Easily update types in .ml/.mli files

You can map a function to easily update the corresponding type in your .ml or .mli files, by doing:

-- Use <leader>out to update the type
vim.keymap.set("n", "<leader>out", require('ocaml.actions').update_interface_type, { desc = "[O]caml [U]pdate [T]ype" })