package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

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

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.5-503.tbz
sha256=67da3b34f2fea07678267309f61da4a2c6f08298de0dc59655b8d30fd8269af1
sha512=1fb3b5180d36aa82b82a319e15b743b802b6888f0dc67645baafdb4e18dfc23a7b90064ec9bc42f7424061cf8cde7f8839178d8a8537bf4596759f3ff4891873

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

Module Merlin_kernel.MconfigSource

OCaml commandline parsing

Sourcetype ocaml = {
  1. include_dirs : string list;
  2. hidden_dirs : string list;
  3. no_std_include : bool;
  4. unsafe : bool;
  5. classic : bool;
  6. principal : bool;
  7. real_paths : bool;
  8. threads : [ `None | `Threads | `Vmthreads ];
  9. recursive_types : bool;
  10. strict_sequence : bool;
  11. applicative_functors : bool;
  12. nopervasives : bool;
  13. strict_formats : bool;
  14. open_modules : string list;
  15. ppx : string Merlin_utils.Std.with_workdir list;
  16. pp : string Merlin_utils.Std.with_workdir option;
  17. warnings : Ocaml_utils.Warnings.state;
}

Merlin high-level settings

Sourcetype merlin = {
  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. extensions : string list;
  9. suffixes : (string * string) list;
  10. stdlib : string option;
  11. source_root : string option;
  12. unit_name : string option;
  13. wrapping_prefix : string option;
  14. reader : string list;
  15. protocol : [ `Json | `Sexp ];
  16. log_file : string option;
  17. log_sections : string list;
  18. config_path : string option;
  19. use_ppx_cache : bool;
  20. exclude_query_dir : bool;
  21. flags_to_apply : string list Merlin_utils.Std.with_workdir list;
  22. flags_applied : string list Merlin_utils.Std.with_workdir list;
  23. failures : string list;
  24. extension_to_reader : (string * string) list;
  25. cache_lifespan : int;
}
Sourceval dump_merlin : merlin -> Merlin_utils.Std.json

Some flags affecting queries

Sourcemodule Verbosity : sig ... end
Sourcetype query = {
  1. filename : string;
  2. directory : string;
  3. printer_width : int;
  4. verbosity : Verbosity.t;
}

Main configuration

Sourcetype t = {
  1. ocaml : ocaml;
  2. merlin : merlin;
  3. query : query;
}
Sourceval initial : t
Sourceval merge_merlin_config : Mconfig_dot.config -> merlin -> failures:string list -> config_path:string -> merlin
Sourceval get_external_config : string -> t -> t
Sourceval normalize : t -> t
Sourceval is_normalized : t -> bool
Sourceval parse_arguments : wd:string -> warning:(string -> unit) -> 'a Merlin_utils.Marg.spec list -> string list -> t -> 'a -> t * 'a
Sourceval flags_for_completion : unit -> string list
Sourceval document_arguments : out_channel -> unit

Computing project paths

Sourceval source_path : t -> string list
Sourceval build_path : t -> string list
Sourceval hidden_build_path : t -> string list
Sourceval cmt_path : t -> string list
Sourceval global_modules : ?include_current:bool -> t -> string list

Accessors for other information

Sourceval filename : t -> string
Sourceval unitname : t -> string