package ocp-index

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

Install

Dune Dependency

Authors

Maintainers

Sources

1.3.6.tar.gz
md5=b4d5f80b168a31146df5eb30613cc1b9
sha512=f8f97e846e37473a77636518ceefafa72a62f26ed9e7fc65ee4625498bcc1797187e895d903dfb2e874e93889956ee02b2e1f6f90c61717107db8e96d388d65a

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: 27 Feb 2024

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 >= "1.1.0"
  2. re >= "1.9.0"
  3. ocp-indent >= "1.4.2"
  4. dune >= "1.0"
  5. cppo build & >= "1.1.0"
  6. ocaml >= "4.08.0"

Dev Dependencies (1)

  1. odoc with-doc

Used by (5)

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

Conflicts

None