File: Conf.mli

package info (click to toggle)
ocamlformat 0.27.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,068 kB
  • sloc: ml: 61,288; pascal: 4,739; lisp: 229; sh: 217; makefile: 121
file content (57 lines) | stat: -rw-r--r-- 1,875 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
(**************************************************************************)
(*                                                                        *)
(*                              OCamlFormat                               *)
(*                                                                        *)
(*            Copyright (c) Facebook, Inc. and its affiliates.            *)
(*                                                                        *)
(*      This source code is licensed under the MIT license found in       *)
(*      the LICENSE file in the root directory of this source tree.       *)
(*                                                                        *)
(**************************************************************************)

include module type of Conf_t

val default_profile : from -> fmt_opts

val default : t

val update : ?quiet:bool -> t -> Parsetree.attribute -> t
(** [update ?quiet c a] updates configuration [c] after reading attribute
    [a]. [quiet] is false by default. *)

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

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

val parse_state_attr : Parsetree.attribute -> [`Enable | `Disable] option

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

val print_config : t -> unit

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

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

module UI : sig
  val profile : t Conf_decl.UI.t

  val fmt_opts : t Conf_decl.UI.t list

  val opr_opts : t Conf_decl.UI.t list
end

module Operational : sig
  val update : f:(opr_opts -> opr_opts) -> t -> t
end

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

val options : Conf_decl.Store.t