package ocp-index

  1. Overview
  2. Docs
Lightweight completion and documentation browsing for OCaml libraries

Install

Dune Dependency

Authors

Maintainers

Sources

1.3.3.tar.gz
md5=738dd32765ce0b6b6423620cc62b7db9
sha512=6360240c951ac64baf9b3736c9a37c41a5ac8c5ddf52e723019fb5ef294e786e245712fd88f408bd8f6881d8741ab152872181062acd81443eec07d1d703e85a

Description

This package includes

  • The ocp-index library and command-line tool
  • ocp-grep, a tool that finds uses of a given (qualified) identifier in a source tree
  • bindings for emacs and vim (sublime text also available)

To automatically configure your editors, install this with package user-setup.

Tags

org:ocamlpro org:typerex

Published: 26 Jan 2022

README

README.md

ocp-index is a light-weight tool and library providing easy access to the information contained in your OCaml cmi/cmt/cmti files. It can be used to provide features like library interface browsing, auto-completion, show-type and goto-source.

This source tree builds:

  • ocp-index.lib, the engine as a library

  • the ocp-index command-line tool

  • the ocp-grep command-line tool, that can search code for a given qualified OCaml ident (including uses after opens, etc.)

  • the ocp-browser tool, which is a browser for installed OCaml APIs on the terminal

The first tree are part of opam package ocp-index, and the latter is in its own ocp-browser package.

ocp-index is part of TypeRex, developed and maintained by OCamlPro. Documentation to install and use this tool is available on http://www.typerex.org/ocp-index.html

It is released under LGPL v3 with linking exception.

Dependencies (6)

  1. cmdliner
  2. re >= "1.9.0"
  3. ocp-indent >= "1.4.2"
  4. dune >= "1.0"
  5. cppo build & >= "1.1.0"
  6. ocaml >= "4.02.0" & < "5.1"

Dev Dependencies (1)

  1. odoc with-doc

Used by (5)

  1. iocaml-kernel < "0.4.6"
  2. ocaml-top >= "1.1.3" & < "1.2.0"
  3. ocp-browser < "1.1.6" | = "1.3.3"
  4. ocp-index-top
  5. starterkit

Conflicts

None