ocamlformat 0.27.0

Author: cknitt

.ocamlformat

@@ -1,5 +1,5 @@
 profile = default
-version = 0.26.2
+version = 0.27.0
 
 field-space = tight-decl
 break-cases = toplevel

analysis/reanalyze/src/DeadCommon.ml

@@ -555,7 +555,8 @@ module Decl = struct
         let refIsBelow (pos : Lexing.position) =
           decl.pos.pos_fname <> pos.pos_fname
           || decl.pos.pos_cnum < pos.pos_cnum
-             && (* not a function defined inside a function, e.g. not a callback *)
+             &&
+             (* not a function defined inside a function, e.g. not a callback *)
              decl.posEnd.pos_cnum < pos.pos_cnum
         in
         refs |> PosSet.exists refIsBelow

analysis/reanalyze/src/Paths.ml

@@ -110,10 +110,8 @@ module Config = struct
       | None -> ())
 end
 
-(**
-  * Handle namespaces in cmt files.
-  * E.g. src/Module-Project.cmt becomes src/Module
-  *)
+(** * Handle namespaces in cmt files. * E.g. src/Module-Project.cmt becomes
+    src/Module *)
 let handleNamespace cmt =
   let cutAfterDash s =
     match String.index s '-' with

analysis/src/CompletionJsx.ml

@@ -286,16 +286,15 @@ type jsxProps = {
   childrenStart: (int * int) option;
 }
 
-(** 
-<div muted= />
+(** <div muted= />
 
-This is a special case for JSX props, where the above code is parsed 
-as <div muted=//, a regexp literal. We leverage that fact to trigger completion
-for the JSX prop value.
+    This is a special case for JSX props, where the above code is parsed as <div
+    muted=//, a regexp literal. We leverage that fact to trigger completion for
+    the JSX prop value.
 
-This code is safe because we also check that the location of the expression is broken,
-which only happens when the expression is a parse error/not complete.
-*)
+    This code is safe because we also check that the location of the expression
+    is broken, which only happens when the expression is a parse error/not
+    complete. *)
 let isRegexpJsxHeuristicExpr expr =
   match expr.Parsetree.pexp_desc with
   | Pexp_extension

analysis/src/Loc.ml

@@ -9,8 +9,9 @@ let toString (loc : t) =
 
 let hasPos ~pos loc = start loc <= pos && pos < end_ loc
 
-(** Allows the character after the end to be included. Ie when the cursor is at the 
-    end of the word, like `someIdentifier<cursor>`. Useful in some scenarios. *)
+(** Allows the character after the end to be included. Ie when the cursor is at
+    the end of the word, like `someIdentifier<cursor>`. Useful in some
+    scenarios. *)
 let hasPosInclusiveEnd ~pos loc = start loc <= pos && pos <= end_ loc
 
 let mkPosition (pos : Pos.t) =

analysis/src/References.ml

@@ -209,7 +209,8 @@ let definedForLoc ~file ~package locKind =
           maybeLog "Yes!! got it";
           Some res)))
 
-(** Find alternative declaration: from res in case of interface, or from resi in case of implementation  *)
+(** Find alternative declaration: from res in case of interface, or from resi in
+    case of implementation *)
 let alternateDeclared ~(file : File.t) ~package (declared : _ Declared.t) tip =
   match Hashtbl.find_opt package.pathsForModule file.moduleName with
   | None -> None

analysis/src/SharedTypes.ml

@@ -356,7 +356,8 @@ and completionType =
       fields: field list;
       definition:
         [ `NameOnly of string
-          (** When we only have the name, like when pulling the record from a declared type. *)
+          (** When we only have the name, like when pulling the record from a
+              declared type. *)
         | `TypeExpr of Types.type_expr
           (** When we have the full type expr from the compiler. *) ];
     }
@@ -573,7 +574,8 @@ module Completable = struct
   (** Additional context for nested completion where needed. *)
   type nestedContext =
     | RecordField of {seenFields: string list}
-        (** Completing for a record field, and we already saw the following fields... *)
+        (** Completing for a record field, and we already saw the following
+            fields... *)
     | CameFromRecordField of string
         (** We just came from this field (we leverage use this for better
             completion names etc) *)
@@ -656,11 +658,13 @@ module Completable = struct
     | CdecoratorPayload of decoratorPayload
     | CextensionNode of string  (** e.g. %todo *)
     | CnamedArg of contextPath * string * string list
-        (** e.g. (..., "label", ["l1", "l2"]) for ...(...~l1...~l2...~label...) *)
+        (** e.g. (..., "label", ["l1", "l2"]) for ...(...~l1...~l2...~label...)
+        *)
     | Cnone  (** e.g. don't complete inside strings *)
     | Cpath of contextPath
     | Cjsx of string list * string * string list
-        (** E.g. (["M", "Comp"], "id", ["id1", "id2"]) for <M.Comp id1=... id2=... ... id *)
+        (** E.g. (["M", "Comp"], "id", ["id1", "id2"]) for <M.Comp id1=...
+            id2=... ... id *)
     | Cexpression of {
         contextPath: contextPath;
         nested: nestedPath list;

analysis/src/SignatureHelp.ml

@@ -553,44 +553,44 @@ let signatureHelp ~path ~pos ~currentFile ~debug ~allowForConstructorPayloads =
                 let offset = ref 0 in
                 Some
                   (`InlineRecord
-                    (fields
-                    |> List.map (fun (field : field) ->
-                           let startOffset = !offset in
-                           let argText =
-                             Printf.sprintf "%s%s: %s" field.fname.txt
-                               (if field.optional then "?" else "")
-                               (Shared.typeToString
-                                  (if field.optional then
-                                     Utils.unwrapIfOption field.typ
-                                   else field.typ))
-                           in
-                           let endOffset =
-                             startOffset + String.length argText
-                           in
-                           offset := endOffset + String.length ", ";
-                           (argText, field, (startOffset, endOffset)))))
+                     (fields
+                     |> List.map (fun (field : field) ->
+                            let startOffset = !offset in
+                            let argText =
+                              Printf.sprintf "%s%s: %s" field.fname.txt
+                                (if field.optional then "?" else "")
+                                (Shared.typeToString
+                                   (if field.optional then
+                                      Utils.unwrapIfOption field.typ
+                                    else field.typ))
+                            in
+                            let endOffset =
+                              startOffset + String.length argText
+                            in
+                            offset := endOffset + String.length ", ";
+                            (argText, field, (startOffset, endOffset)))))
               | Args [(typ, _)] ->
                 Some
                   (`SingleArg
-                    ( typ |> Shared.typeToString,
-                      docsForLabel ~file:full.file ~package:full.package
-                        ~supportsMarkdownLinks typ ))
+                     ( typ |> Shared.typeToString,
+                       docsForLabel ~file:full.file ~package:full.package
+                         ~supportsMarkdownLinks typ ))
               | Args args ->
                 let offset = ref 0 in
                 Some
                   (`TupleArg
-                    (args
-                    |> List.map (fun (typ, _) ->
-                           let startOffset = !offset in
-                           let argText = typ |> Shared.typeToString in
-                           let endOffset =
-                             startOffset + String.length argText
-                           in
-                           offset := endOffset + String.length ", ";
-                           ( argText,
-                             docsForLabel ~file:full.file ~package:full.package
-                               ~supportsMarkdownLinks typ,
-                             (startOffset, endOffset) ))))
+                     (args
+                     |> List.map (fun (typ, _) ->
+                            let startOffset = !offset in
+                            let argText = typ |> Shared.typeToString in
+                            let endOffset =
+                              startOffset + String.length argText
+                            in
+                            offset := endOffset + String.length ", ";
+                            ( argText,
+                              docsForLabel ~file:full.file ~package:full.package
+                                ~supportsMarkdownLinks typ,
+                              (startOffset, endOffset) ))))
             in
             let label =
               constructor.name ^ "("

analysis/src/TypeUtils.ml

@@ -1165,10 +1165,11 @@ let transformCompletionToPipeCompletion ?(synthetic = false) ~env ?posOfDot
         | Some posOfDot -> Some (makeAdditionalTextEditsForRemovingDot posOfDot));
     }
 
-(** This takes a type expr and the env that type expr was found in, and produces a globally unique 
-    id for that specific type. The globally unique id is the full path to the type as seen from the root
-    of the project. Example: type x in module SomeModule in file SomeFile would get the globally 
-    unique id `SomeFile.SomeModule.x`.*)
+(** This takes a type expr and the env that type expr was found in, and produces
+    a globally unique id for that specific type. The globally unique id is the
+    full path to the type as seen from the root of the project. Example: type x
+    in module SomeModule in file SomeFile would get the globally unique id
+    `SomeFile.SomeModule.x`.*)
 let rec findRootTypeId ~full ~env (t : Types.type_expr) =
   let debug = false in
   match t.desc with

analysis/src/Utils.ml

@@ -1,7 +1,5 @@
-(**
- * `startsWith(string, prefix)`
- * true if the string starts with the prefix
- *)
+(** * `startsWith(string, prefix)` * true if the string starts with the prefix
+*)
 let startsWith s prefix =
   if prefix = "" then true
   else

compiler/bsb/bsb_build_util.ml

@@ -101,12 +101,10 @@ let resolve_bsb_magic_file ~cwd ~desc p : result =
 
 (** converting a file from Linux path format to Windows *)
 
-(**
-   {[
-     mkp "a/b/c/d";;
-     mkp "/a/b/c/d"
-   ]}
-*)
+(** {[
+      mkp "a/b/c/d";;
+      mkp "/a/b/c/d"
+    ]} *)
 let rec mkp dir =
   if not (Sys.file_exists dir) then
     let parent_dir = Filename.dirname dir in
@@ -134,16 +132,10 @@ type top = Expect_none | Expect_name of string
 
 type package_context = {proj_dir: string; top: top; is_pinned: bool}
 
-(**
-   TODO: check duplicate package name
-   ?use path as identity?
-
-   Basic requirements
-     1. cycle detection
-     2. avoid duplication
-     3. deterministic, since -make-world will also comes with -clean-world
+(** TODO: check duplicate package name ?use path as identity?
 
-*)
+    Basic requirements 1. cycle detection 2. avoid duplication 3. deterministic,
+    since -make-world will also comes with -clean-world *)
 
 let pp_packages_rev ppf lst =
   Ext_list.rev_iter lst (fun s -> Format.fprintf ppf "%s " s)

compiler/bsb/bsb_build_util.mli

@@ -23,34 +23,28 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 
 val flag_concat : string -> string list -> string
-(**
-   Use:
-   {[
-     flag_concat "-ppx" [ppxs]
-   ]}
-*)
+(** Use:
+    {[
+      flag_concat "-ppx" [ppxs]
+    ]} *)
 
 val ppx_flags : Bsb_config_types.ppx list -> string
-(**
-   Build quoted commandline arguments for bsc.exe for the given ppx flags
+(** Build quoted commandline arguments for bsc.exe for the given ppx flags
 
-   Use:
-   {[
-     ppx_flags [ppxs]
-   ]}
-*)
+    Use:
+    {[
+      ppx_flags [ppxs]
+    ]} *)
 
 val pp_flag : string -> string
 
 val include_dirs : string list -> string
-(**
-   Build unquoted command line arguments for bsc.exe for the given include dirs
+(** Build unquoted command line arguments for bsc.exe for the given include dirs
 
-   Use:
-   {[
-     include_dirs [dirs]
-   ]}
-*)
+    Use:
+    {[
+      include_dirs [dirs]
+    ]} *)
 
 val include_dirs_by : 'a list -> ('a -> string) -> string
 

compiler/bsb/bsb_clean.mli

@@ -22,9 +22,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 
-(** clean bsc generated artifacts.
-    TODO: clean stale in source js artifacts
-*)
+(** clean bsc generated artifacts. TODO: clean stale in source js artifacts *)
 
 val clean_bs_deps : string -> unit
 

compiler/bsb/bsb_config.ml

@@ -65,8 +65,7 @@ let ocaml_bin_install_prefix p = lib_ocaml // p
 
 let proj_rel path = rev_lib_bs // path
 
-(** it may not be a bad idea to hard code the binary path 
-    of bsb in configuration time
-*)
+(** it may not be a bad idea to hard code the binary path of bsb in
+    configuration time *)
 
 (* let cmd_package_specs = ref None  *)

compiler/bsb/bsb_config.mli

@@ -46,4 +46,5 @@ val rev_lib_bs_prefix : string -> string
 val lib_bs_prefix_of_format : Ext_module_system.t -> string
 
 val top_prefix_of_format : Ext_module_system.t -> string
-(** default not install, only when -make-world, its dependencies will be installed  *)
+(** default not install, only when -make-world, its dependencies will be
+    installed *)

compiler/bsb/bsb_config_parse.ml

@@ -64,24 +64,16 @@ let extract_package_name_and_namespace (map : json_map) : string * string option
   in
   (package_name, namespace)
 
-(**
-    There are two things to check:
-   - the running bsb and vendoring bsb is the same
-   - the running bsb need delete stale build artifacts
-      (kinda check npm upgrade)
+(** There are two things to check:
+    - the running bsb and vendoring bsb is the same
+    - the running bsb need delete stale build artifacts (kinda check npm
+      upgrade)
 
-      Note if the setup is correct:
-      the running compiler and node_modules/rescript
-      should be the same version,
-      The exact check is that the running compiler should have a
-      compatible runtime version installed, the location of the
-      compiler is actually not relevant.
-      We disable the check temporarily
-      e.g,
-      ```
-      bsc -runtime runtime_dir@version
-      ```
-*)
+    Note if the setup is correct: the running compiler and node_modules/rescript
+    should be the same version, The exact check is that the running compiler
+    should have a compatible runtime version installed, the location of the
+    compiler is actually not relevant. We disable the check temporarily e.g, ```
+    bsc -runtime runtime_dir@version ``` *)
 let extract_gentype_config (map : json_map) : Bsb_config_types.gentype_config =
   match map.?(Bsb_build_schemas.gentypeconfig) with
   | None -> false
@@ -201,8 +193,8 @@ let extract_js_post_build (map : json_map) cwd : string option =
   |> ignore;
   !js_post_build_cmd
 
-(** ATT: make sure such function is re-entrant.
-    With a given [cwd] it works anywhere*)
+(** ATT: make sure such function is re-entrant. With a given [cwd] it works
+    anywhere*)
 let interpret_json ~(filename : string) ~(json : Ext_json_types.t)
     ~(package_kind : Bsb_package_kind.t) ~(per_proj_dir : string) :
     Bsb_config_types.t =

compiler/bsb/bsb_db_util.mli

@@ -29,10 +29,8 @@ val merge : Bsb_db.map -> Bsb_db.map -> Bsb_db.map
 
 val sanity_check : Bsb_db.map -> unit
 
-(** 
-   Currently it is okay to have duplicated module, 
-   In the future, we may emit a warning 
-*)
+(** Currently it is okay to have duplicated module, In the future, we may emit a
+    warning *)
 
 val add_basename :
   dir:string ->