package ocamlformat-lib

You can search for identifiers within the package.

in-package search v0.2.0

ocamlformat-lib
- Ocamlformat_lib
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Mod
    
    Mty
    
    Pat
    
    Token
    
    Tyd
  - Chunk
  - Cmt
  - Cmts
    
    Toplevel
  - Conf
    
    Elt
    
    Error
    
    Operational
    
    UI
  - Conf_decl
    
    Store
    
    UI
    
    Value
    
    Value_removed
  - Conf_t
    
    Elt
    
    Error
  - Docstring
  - Eol_compat
  - Exposed
    
    Left
    
    Right
  - Extended_ast
    
    Asttypes
    
    Parse
    
    Printast
  - Fmt
  - Fmt_ast
  - Fmt_odoc
  - Indent
    
    Partial_ast
    
    Valid_ast
  - Literal_lexer
  - Loc_tree
  - Migrate_ast
    
    Lexing
    
    Location
    
    Longident
    
    Position
  - Multimap
    
    M
    
    K
  - Non_overlapping_interval_tree
    
    IN
    
    Make
    
    Itv
    
    S
  - Normalize_extended_ast
  - Normalize_std_ast
  - Params
    
    Align
    
    Exp
    
    Infix_op_arg
  - Parse_with_comments
    
    W
  - Prec
  - Range
  - Source
  - Std_ast
    
    Parse
    
    Printast
  - Std_longident
    
    String_id
  - Sugar
    
    Exp
    
    Let_binding
  - Syntax
  - Toplevel_lexer
  - Translation_unit
    
    Error
  - Version
ocamlformat-lib.format_
- Format_
ocamlformat-lib.ocaml_common
- Ocaml_common
  - Location
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat-lib.ocamlformat_stdlib
- Ocamlformat_stdlib
  - Caml
  - Export
  - Exported_for_specific_uses
  - Fpath
    
    Map
    
    Set
  - Int_conversions
  - List
    
    Assoc
    
    Cartesian_product
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Or_unequal_lengths
  - Sexp
  - String
    
    Caseless
    
    Escaping
    
    Search_pattern
    
    Private
    
    Utf16be
    
    Utf16le
    
    Utf32be
    
    Utf32le
    
    Utf8
  - Warning
ocamlformat-lib.odoc_parser
- Odoc_parser
  - Ast
  - Loc
  - Warning
ocamlformat-lib.parser_extended
- Parser_extended
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-lib.parser_recovery
- Parser_recovery
ocamlformat-lib.parser_shims
- Parser_shims
  - Clflags
  - Int
  - List
  - Misc
    
    Color
    
    Error_style
    
    Int_literal_converter
    
    LongString
    
    Magic_number
    
    Stdlib
    
    Array
    
    List
    
    Option
    
    String
    
    Map
    
    Set
    
    Tbl
ocamlformat-lib.parser_standard
- Parser_standard
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Printast
ocamlformat-lib.result
- Ocamlformat_result
  - Global_scope
  - Let_syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of Conf_t

type parsed_from = [

| `File of Ocaml_common.Location.t
| `Attribute of Ocaml_common.Location.t

]

type updated_from = [

| `Env
| `Commandline
| `Parsed of parsed_from

]

type from = [

| `Default
| `Profile of Ocamlformat_stdlib.string * updated_from
| `Updated of updated_from * from Ocamlformat_stdlib.option

]

module Error : sig ... end

module Elt : sig ... end

type 'a elt = 'a Elt.t

type fmt_opts = {

align_symbol_open_paren : Ocamlformat_stdlib.bool elt;
assignment_operator : [ `Begin_line | `End_line ] elt;
break_before_in : [ `Fit_or_vertical | `Auto ] elt;
break_cases : [ `Fit | `Nested | `Toplevel | `Fit_or_vertical | `Vertical | `All ] elt;
break_collection_expressions : [ `Wrap | `Fit_or_vertical ] elt;
break_colon : [ `Before | `After ] elt;
break_infix : [ `Wrap | `Fit_or_vertical | `Wrap_or_vertical ] elt;
break_infix_before_func : Ocamlformat_stdlib.bool elt;
break_fun_decl : [ `Wrap | `Fit_or_vertical | `Smart ] elt;
break_fun_sig : [ `Wrap | `Fit_or_vertical | `Smart ] elt;
break_separators : [ `Before | `After ] elt;
break_sequences : Ocamlformat_stdlib.bool elt;
break_string_literals : [ `Auto | `Never ] elt;
(*
How to potentially break string literals into new lines.
*)
break_struct : Ocamlformat_stdlib.bool elt;
cases_exp_indent : Ocamlformat_stdlib.int elt;
cases_matching_exp_indent : [ `Normal | `Compact ] elt;
disambiguate_non_breaking_match : Ocamlformat_stdlib.bool elt;
doc_comments : [ `Before | `Before_except_val | `After_when_possible ] elt;
doc_comments_padding : Ocamlformat_stdlib.int elt;
doc_comments_tag_only : [ `Fit | `Default ] elt;
dock_collection_brackets : Ocamlformat_stdlib.bool elt;
exp_grouping : [ `Parens | `Preserve ] elt;
extension_indent : Ocamlformat_stdlib.int elt;
field_space : [ `Tight | `Loose | `Tight_decl ] elt;
function_indent : Ocamlformat_stdlib.int elt;
function_indent_nested : [ `Always | `Auto | `Never ] elt;
if_then_else : [ `Compact | `Fit_or_vertical | `Keyword_first | `K_R | `Vertical ] elt;
indent_after_in : Ocamlformat_stdlib.int elt;
indicate_multiline_delimiters : [ `No | `Space | `Closing_on_separate_line ] elt;
indicate_nested_or_patterns : [ `Space | `Unsafe_no ] elt;
infix_precedence : [ `Indent | `Parens ] elt;
leading_nested_match_parens : Ocamlformat_stdlib.bool elt;
let_and : [ `Compact | `Sparse ] elt;
let_binding_indent : Ocamlformat_stdlib.int elt;
let_binding_spacing : [ `Compact | `Sparse | `Double_semicolon ] elt;
let_module : [ `Compact | `Sparse ] elt;
line_endings : [ `Lf | `Crlf ] elt;
margin : Ocamlformat_stdlib.int elt;
(*
Format code to fit within margin columns.
*)
match_indent : Ocamlformat_stdlib.int elt;
match_indent_nested : [ `Always | `Auto | `Never ] elt;
max_indent : Ocamlformat_stdlib.int Ocamlformat_stdlib.option elt;
module_item_spacing : [ `Compact | `Preserve | `Sparse ] elt;
nested_match : [ `Wrap | `Align ] elt;
ocp_indent_compat : Ocamlformat_stdlib.bool elt;
(*
Try to indent like ocp-indent
*)
parens_ite : Ocamlformat_stdlib.bool elt;
parens_tuple : [ `Always | `Multi_line_only ] elt;
parens_tuple_patterns : [ `Always | `Multi_line_only ] elt;
parse_docstrings : Ocamlformat_stdlib.bool elt;
parse_toplevel_phrases : Ocamlformat_stdlib.bool elt;
sequence_blank_line : [ `Compact | `Preserve_one ] elt;
sequence_style : [ `Before | `Separator | `Terminator ] elt;
single_case : [ `Compact | `Sparse ] elt;
space_around_arrays : Ocamlformat_stdlib.bool elt;
space_around_lists : Ocamlformat_stdlib.bool elt;
space_around_records : Ocamlformat_stdlib.bool elt;
space_around_variants : Ocamlformat_stdlib.bool elt;
stritem_extension_indent : Ocamlformat_stdlib.int elt;
type_decl : [ `Compact | `Sparse ] elt;
type_decl_indent : Ocamlformat_stdlib.int elt;
wrap_comments : Ocamlformat_stdlib.bool elt;
(*
Wrap comments at margin.
*)
wrap_fun_args : Ocamlformat_stdlib.bool elt;

}

Formatting options

type opr_opts = {

comment_check : Ocamlformat_stdlib.bool elt;
debug : Ocamlformat_stdlib.bool elt;
(*
Generate debugging output if true.
*)
disable : Ocamlformat_stdlib.bool elt;
margin_check : Ocamlformat_stdlib.bool elt;
(*
Check whether the formatted output exceeds the margin.
*)
max_iters : Ocamlformat_stdlib.int elt;
(*
Fail if output of formatting does not stabilize within max_iters iterations.
*)
ocaml_version : Ocaml_version.t elt;
(*
Version of OCaml syntax of the output.
*)
quiet : Ocamlformat_stdlib.bool elt;
range : (Ocamlformat_stdlib.string -> Range.t) elt;
disable_conf_attrs : Ocamlformat_stdlib.bool elt;
version_check : Ocamlformat_stdlib.bool elt;

}

Options changing the tool's behavior

type t = {

fmt_opts : fmt_opts;
opr_opts : opr_opts;
profile : [ `default | `conventional | `ocamlformat | `janestreet ] elt;

}

val default_profile : from -> fmt_opts

val default : t

val update : 
  ?quiet:Ocamlformat_stdlib.bool ->
  t ->
  Parser_extended.Parsetree.attribute ->
  t

update ?quiet c a updates configuration c after reading attribute a. quiet is false by default.

val update_value : 
  t ->
  name:Ocamlformat_stdlib.string ->
  value:Ocamlformat_stdlib.string ->
  (t, Error.t) Ocamlformat_stdlib.Result.t

val update_state : t -> [ `Enable | `Disable ] -> t

val parse_line : 
  t ->
  ?version_check:Ocamlformat_stdlib.bool ->
  ?disable_conf_attrs:Ocamlformat_stdlib.bool ->
  from:
    [< `Attribute of Ocaml_common.Warnings.loc
    | `File of Ocaml_common.Warnings.loc ] ->
  Ocamlformat_stdlib.string ->
  (t, Error.t) Ocamlformat_stdlib.Result.t

val print_config : t -> Ocamlformat_stdlib.unit

val collect_warnings : 
  (Ocamlformat_stdlib.unit -> t) ->
  t * (Ocamlformat_stdlib.unit -> Ocamlformat_stdlib.unit)

val warn : 
  loc:Ocaml_common.Warnings.loc ->
  ('a,
    Ocamlformat_stdlib.Format.formatter,
    Ocamlformat_stdlib.unit,
    Ocamlformat_stdlib.unit)
    Ocamlformat_stdlib.format4 ->
  'a

module UI : sig ... end

module Operational : sig ... end

val term : (t -> t) Cmdliner.Term.t

val options : Conf_decl.Store.t