package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (19)

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.9.tbz
sha256=de395dd37d246e3ec303e1af35ff8421665fa4f0f0005d95732124b22e3417ac
sha512=74756b28767cdfe10288720540582e818a9d946dd2406606724ebc7b68d1cf6623142e56a1e457f7862839732e7add365aec056930c7ac89be7036c22e5f29ae

doc/merlin-lib.kernel/Merlin_kernel/Mconfig_dot/index.html

Module Merlin_kernel.Mconfig_dotSource

Sourcemodule Configurator : sig ... end
Sourcetype config = {
  1. build_path : string list;
  2. source_path : string list;
  3. hidden_build_path : string list;
  4. hidden_source_path : string list;
  5. cmi_path : string list;
  6. cmt_path : string list;
  7. index_files : string list;
  8. flags : string list Merlin_utils.Std.with_workdir list;
  9. extensions : string list;
  10. suffixes : (string * string) list;
  11. stdlib : string option;
  12. source_root : string option;
  13. unit_name : string option;
  14. wrapping_prefix : string option;
  15. reader : string list;
  16. exclude_query_dir : bool;
  17. use_ppx_cache : bool;
  18. ppx_dependencies : string list;
}
Sourceval empty_config : config
Sourceval prepend_config : dir:string -> Configurator.t -> Merlin_dot_protocol.directive list -> config -> config * string list

prepend_config ~dir c directives config parses directives and update config accordingly, prepending new items when to already existing list fields of config. dir is used as the workdir for flags declared in the directives. If c = Dune, unknown directives are ignored.

Sourceval postprocess_config : config -> config

prostprocess_config config removes duplicates and reverses the lists in config

Sourcetype context
Sourceval get_config : context -> string -> config * string list
Sourceval find_project_context : string -> (context * string) option

find_project_config dir searches for a "project configuration file" in dir and its parent directories. Stopping on the first one it finds and returning a configuration context along with the path to the configuration file, returning None otherwise (if '/' was reached without finding such a file).

A project configuration files is one of:

  • .merlin
  • dune-project
  • dune-workspace

They are detected in that order. dune and jbuild file do not need to be taken into account because any project using a recent version of dune should have a dune-project file which is even auto-generated when it is missing. And only recent versions of dune will stop writing .merlin files.