package ocamlformat

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package ocamlformat

ocamlformat
- Ocamlformat
  - Assoc
  - Ast
    
    Attr
    
    Key
    
    Cl
    
    Cty
    
    Exp
    
    Ext
    
    Key
    
    Indexing_op
    
    Longident
    
    Mod
    
    Mty
    
    Pat
    
    String_id
    
    Token
    
    Tyd
  - Cmt
  - Cmts
    
    Toplevel
  - Conf
  - Config_option
    
    CONFIG
    
    Error
    
    Make
    
    C
    
    Value
    
    Value_removed
  - Docstring
  - Exposed
    
    Left
    
    Right
  - Extended_ast
    
    Asttypes
    
    Parse
    
    Pprintast
    
    Printast
  - File_system
  - 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
    
    Exp
    
    Infix_op_arg
  - Parse_with_comments
    
    W
  - Prec
  - Source
  - Std_ast
    
    Parse
    
    Pprintast
  - Sugar
    
    Exp
    
    Let_binding
    
    Pat
  - Syntax
  - Toplevel_lexer
  - Translation_unit
    
    Error
  - Version
ocamlformat.format_
- Format_
ocamlformat.ocaml_413
- Ocaml_413
  - 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
  - Pprintast
  - Printast
ocamlformat.ocaml_413_extended
- Ocaml_413_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
    
    Vb
  - Ast_mapper
  - Asttypes
  - Docstrings
    
    WithMenhir
  - Lexer
  - Parse
  - Parser
    
    Incremental
    
    MenhirInterpreter
  - Parsetree
  - Pprintast
  - Printast
ocamlformat.ocaml_common
- Ocaml_common
  - Location
  - Longident
  - Syntaxerr
  - Warnings
ocamlformat.ocamlformat_stdlib
- Ocamlformat_stdlib
  - Cmdliner
  - Export
  - Exported_for_specific_uses
  - Fpath
    
    Map
    
    Set
  - 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
  - Warning
ocamlformat.parse_wyc
- Parse_wyc
ocamlformat.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

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module C : CONFIG

Signature

type config = C.config

type 'a t

type kind =

| Formatting
| Operational

type parsed_from = [

| `File of Ocamlformat_stdlib.Fpath.t * Ocamlformat_stdlib.int
| `Attribute

]

type updated_from = [

| `Env
| `Commandline
| `Parsed of parsed_from

]

type deprecated

type removed

type status = [

| `Valid
| `Deprecated of deprecated
| `Removed of removed

]

type 'a option_decl =
  names:Ocamlformat_stdlib.string Ocamlformat_stdlib.list ->
  doc:Ocamlformat_stdlib.string ->
  kind:kind ->
  ?allow_inline:Ocamlformat_stdlib.bool ->
  ?status:[ `Valid | `Deprecated of deprecated ] ->
  (config -> 'a -> config) ->
  (config -> 'a) ->
  'a t

val section_name : kind -> status -> Ocamlformat_stdlib.string

val deprecated : since:Version.t -> Ocamlformat_stdlib.string -> deprecated

val removed : since:Version.t -> Ocamlformat_stdlib.string -> removed

module Value : sig ... end

module Value_removed : sig ... end

val choice : 
  all:'a Value.t Ocamlformat_stdlib.list ->
  ?removed_values:Value_removed.t Ocamlformat_stdlib.list ->
  'a option_decl

val flag : 
  default:Ocamlformat_stdlib.bool ->
  Ocamlformat_stdlib.bool option_decl

val any : 
  ?default_doc:Ocamlformat_stdlib.string ->
  'a Ocamlformat_stdlib.Cmdliner.Arg.conv ->
  default:'a ->
  docv:Ocamlformat_stdlib.string ->
  'a option_decl

val removed_option : 
  names:Ocamlformat_stdlib.string Ocamlformat_stdlib.list ->
  since:Version.t ->
  msg:Ocamlformat_stdlib.string ->
  Ocamlformat_stdlib.unit

Declare an option as removed. Using such an option will result in an helpful error including msg and since.

val default : 'a t -> 'a

val update_using_cmdline : config -> config

val update : 
  config:config ->
  from:updated_from ->
  name:Ocamlformat_stdlib.string ->
  value:Ocamlformat_stdlib.string ->
  inline:Ocamlformat_stdlib.bool ->
  (config, Error.t) Ocamlformat_stdlib.Result.t

val print_config : config -> Ocamlformat_stdlib.unit