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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
(**************************************************************************)
(* *)
(* 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. *)
(* *)
(**************************************************************************)
type parsed_from = [`File of Location.t | `Attribute of Location.t]
type updated_from = [`Env | `Commandline | `Parsed of parsed_from]
type from =
[ `Default
| `Profile of string * updated_from
| `Updated of updated_from * from option (* when redundant definition *) ]
module Error = struct
type t =
| Bad_value of string * string
| Malformed of string
| Misplaced of string * string
| Unknown of string * [`Msg of string] option
| Version_mismatch of {read: string; installed: string}
let to_string = function
| Malformed line -> Format.sprintf "Invalid format %S" line
| Misplaced (name, _) -> Format.sprintf "%s not allowed here" name
| Unknown (name, None) -> Format.sprintf "Unknown option %S" name
| Unknown (name, Some (`Msg msg)) ->
Format.sprintf "Unknown option %S: %s" name msg
| Bad_value (name, msg) -> Format.sprintf "For option %S: %s" name msg
| Version_mismatch {read; installed} ->
Format.sprintf
"Project should be formatted using ocamlformat version %S, but \
the installed version is %S"
read installed
end
module Elt = struct
type 'a t = {v: 'a; from: from}
let v elt = elt.v
let from elt = elt.from
let make v from = {v; from}
end
type 'a elt = 'a Elt.t
type fmt_opts =
{ align_symbol_open_paren: bool elt
; assignment_operator: [`Begin_line | `End_line] elt
; break_around_multiline_strings: bool elt
; break_before_in: [`Fit_or_vertical | `Auto] elt
; break_cases:
[`Fit | `Nested | `Toplevel | `Fit_or_vertical | `All | `Vertical] 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: 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: bool elt
; break_string_literals: [`Auto | `Never] elt
; break_struct: bool elt
; cases_exp_indent: int elt
; cases_matching_exp_indent: [`Normal | `Compact] elt
; disambiguate_non_breaking_match: bool elt
; doc_comments: [`Before | `Before_except_val | `After_when_possible] elt
; doc_comments_padding: int elt
; doc_comments_tag_only: [`Fit | `Default] elt
; dock_collection_brackets: bool elt
; exp_grouping: [`Parens | `Preserve] elt
; extension_indent: int elt
; field_space: [`Tight | `Loose | `Tight_decl] elt
; function_indent: 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: 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: bool elt
; let_and: [`Compact | `Sparse] elt
; let_binding_indent: int elt
; let_binding_deindent_fun: bool elt
; let_binding_spacing: [`Compact | `Sparse | `Double_semicolon] elt
; let_module: [`Compact | `Sparse] elt
; line_endings: [`Lf | `Crlf] elt
; margin: int elt
; match_indent: int elt
; match_indent_nested: [`Always | `Auto | `Never] elt
; max_indent: int option elt
; module_item_spacing: [`Compact | `Preserve | `Sparse] elt
; nested_match: [`Wrap | `Align] elt
; ocp_indent_compat: bool elt
; parens_ite: bool elt
; parens_tuple: [`Always | `Multi_line_only] elt
; parens_tuple_patterns: [`Always | `Multi_line_only] elt
; parse_docstrings: bool elt
; parse_toplevel_phrases: bool elt
; sequence_blank_line: [`Compact | `Preserve_one] elt
; sequence_style: [`Before | `Separator | `Terminator] elt
; single_case: [`Compact | `Sparse] elt
; space_around_arrays: bool elt
; space_around_lists: bool elt
; space_around_records: bool elt
; space_around_variants: bool elt
; stritem_extension_indent: int elt
; type_decl: [`Compact | `Sparse] elt
; type_decl_indent: int elt
; wrap_comments: bool elt
; wrap_docstrings: bool elt
; wrap_fun_args: bool elt }
type opr_opts =
{ comment_check: bool elt
; debug: bool elt
; disable: bool elt
; margin_check: bool elt
; max_iters: int elt
; ocaml_version: Ocaml_version.t elt
; quiet: bool elt
; disable_conf_attrs: bool elt
; version_check: bool elt }
type t =
{ fmt_opts: fmt_opts
; opr_opts: opr_opts
; profile: [`default | `conventional | `ocamlformat | `janestreet] elt }
|