ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

OCaml Autocompletion

by whitequark ST2/ST3

Sublime Text plugin which provides OCaml autocompletion with ocp-index

Details

  • 2014.09.23.13.45.37
  • github.​com
  • github.​com
  • 5 years ago
  • 3 hours ago
  • 6 years ago

Installs

  • Total 3K
  • Win 782
  • OS X 1K
  • Linux 1K
May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7
Windows 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0
OS X 0 0 1 1 0 0 0 0 1 1 0 1 0 0 0 0 0 1 0 0 0 1 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 2 1
Linux 0 0 0 0 0 0 1 1 1 2 1 2 0 0 1 0 1 1 1 0 1 1 0 0 0 1 0 0 2 0 0 0 0 0 2 0 0 1 1 0 0 0 0 0 1 0

Readme

Source
raw.​githubusercontent.​com

OCaml autocompletion for Sublime Text

Installation

opam install ocp-index

Usage

Within OCaml syntax files:

  • Standard sublime autocompletion is completely replaced with OCaml autocompletion
  • Type inspection of variables is available via the alt+a shortcut, which displays the type in the status bar

Build configuration

You need to pass the -bin-annot flag to ocamlc/ocamlopt. You are probably using a build system, so follow the guide below.

If you are not using one of the standard build output folders then a setting is available to pass the --build parameter to ocp-index:

"sublime_ocp_index_build_dir": "gen/ml"

This setting can be applied as a user preference or (recommended) in your .sublime-project file.

ocamlbuild

Ocamlbuild 4.01 supports generating binary annotations out of the box, with the bin_annot tag. In your _tags:

true: bin_annot

For earlier versions of Ocamlbuild, this can be replicated by adding one line to myocamlbuild.ml:

flag ["ocaml"; "compile"; "bin_annot"] (A"-bin-annot");

License

The MIT License

A note about ocp-index versions

This plugin uses ocp-index -I <folder> to enable searching local project libraries. Prior to the 1.0.2 release, this disabled searching OPAM libraries. To show OPAM libraries in autocomplete results with this version, use the following setting:

"sublime_ocp_index_include_local_packages": false

This can be applied globally in your user settings or overridden in a .sublime-project file.