ocamlformat-lib 0.26.2 · OCaml Package

This module contains ways to declare command-line and config-files options for ocamlformat. To look at declared options, see Conf.mli. To declare a new option :

Add a field to one of the records in Conf_t
Declare the option in Conf, using functions from this module.

type typ =

| Int
| Bool
| Range
| Ocaml_version
| Choice of Ocamlformat_stdlib.string Ocamlformat_stdlib.list

module UI : sig ... end

type 'a t

The type of an option declaration

type kind =

| Formatting
| Operational

type deprecated

type removed

type status = [

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

]

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

The type of option declarators, that is functions returning a declaration

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

Values of multiple-choice options

module Value_removed : sig ... end

module Store : sig ... end

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

val flag : Ocamlformat_stdlib.bool declarator

val int : docv:Ocamlformat_stdlib.string -> Ocamlformat_stdlib.int declarator

val ocaml_version : Ocaml_version.t declarator

val any : 
  'a Cmdliner.Arg.conv ->
  values:typ ->
  docv:Ocamlformat_stdlib.string ->
  'a declarator

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

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 : 
  Store.t ->
  config:Conf_t.t ->
  from:Conf_t.updated_from ->
  name:Ocamlformat_stdlib.string ->
  value:Ocamlformat_stdlib.string ->
  inline:Ocamlformat_stdlib.bool ->
  (Conf_t.t, Conf_t.Error.t) Ocamlformat_stdlib.Result.t

val to_ui : 'a t -> Conf_t.t UI.t

val print_config : Store.t -> Conf_t.t -> Ocamlformat_stdlib.unit

package ocamlformat-lib