Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.15 KB

README.md

File metadata and controls

38 lines (25 loc) · 1.15 KB

emacs-ocamlunit

This is a Emacs minor mode implementation to run OUnit2 tests or other tests in a OCaml dune project.

Tests are actually run with dune test. So also other test definitions than OUnit/OUnit2 are run also.

There is no package on Elpa or Melpa. To install it clone this to some local folder and initialize like this in Emacs:

(use-package ocamlunit
  :load-path "~/.emacs.d/plugins/ocamlunit")

The default key binding is C-c t.

To configure a custom key binding do this:

(use-package ocamlunit
  :load-path "~/.emacs.d/plugins/ocamlunit"
  :bind (:map ocamlunit-mode-map
              ("C-c C-t" . ocamlunit-execute))
  :commands
  (ocamlunit-mode))

When done you have a minor mode called ocamlunit-mode.

This mode can be enabled for basically every buffer but only tuareg-mode buffers are supported. On other code or project it just saves the buffer.

The key sequence: C-c t (or a custom defined one) will first save the buffer and then run the tests using dune.

After the first execution of ocamlunit-execute you can view the "OCamlUnit output" buffer for test output.

Emacs screenshot