Format OCaml code

.ocamlformat

@@ -2,3 +2,5 @@ version = 0.26.1
 profile = default
 break-cases = fit-or-vertical
 break-infix = wrap-or-vertical
+doc-comments = before
+type-decl = sparse

bin/dune

@@ -1,6 +1,4 @@
 (executable
  (public_name github_tui)
  (name main)
- (libraries 
+ (libraries github_tui))
-   github_tui
- ))

lib/cli.ml

@@ -6,15 +6,20 @@ let repo_arg =
 
 let path_arg =
   let doc = "Path to a local directory of a GitHub repository" in
-  Arg.(value & opt string "." & info ["d"; "directory"] ~docv:"DIRECTORY_PATH" ~doc)
+  Arg.(
+    value
+    & opt string "."
+    & info [ "d"; "directory" ] ~docv:"DIRECTORY_PATH" ~doc)
 
 let gh_tui_t = Term.(const Tui.start $ repo_arg $ path_arg)
 
 let cmd =
   let doc = "TUI of a GitHub repository" in
-  let man = [
+  let man =
-    `S Manpage.s_bugs;
+    [
-    `P "Submit bug reports at: https://github.com/chshersh/github-tui/issues" ]
+      `S Manpage.s_bugs;
+      `P "Submit bug reports at: https://github.com/chshersh/github-tui/issues";
+    ]
   in
   let info = Cmd.info "gh-tui" ~version:"0.1.0" ~doc ~man in
   Cmd.v info gh_tui_t

lib/dune

@@ -2,11 +2,4 @@
 
 (library
  (name github_tui)
- (libraries 
+ (libraries ANSITerminal cmdliner ezcurl minttea uuseg.string))
-   ANSITerminal
-   cmdliner
-   ezcurl
-   minttea
-   uuseg.string
- )
-)

lib/fs.ml

@@ -8,58 +8,50 @@ let file_name = function
 
 (* A files comparison:
 
-1. Directories before files
+   1. Directories before files
-2. Otherwise, lexicographically
+   2. Otherwise, lexicographically
 *)
 let order_files t1 t2 =
   match (t1, t2) with
-  | (Dir _, File _) -> -1
+  | Dir _, File _ -> -1
-  | (File _, Dir _) -> 1
+  | File _, Dir _ -> 1
-  | (File name_1, File name_2) -> String.compare name_1 name_2
+  | File name_1, File name_2 -> String.compare name_1 name_2
-  | (Dir (name_1, _), Dir (name_2, _)) -> String.compare name_1 name_2
+  | Dir (name_1, _), Dir (name_2, _) -> String.compare name_1 name_2
 
 let rec sort_tree = function
   | File name -> File name
   | Dir (name, children) ->
-    Array.sort order_files children;
+      Array.sort order_files children;
-    Dir (name, Array.map sort_tree children)
+      Dir (name, Array.map sort_tree children)
 
 let rec to_tree path =
   if Sys.is_directory path then
-    let children = Array.map
+    let children =
-      (fun child_name -> to_tree (Filename.concat path child_name))
+      Array.map
-      (Sys.readdir path)
+        (fun child_name -> to_tree (Filename.concat path child_name))
+        (Sys.readdir path)
     in
     let dirname = Filename.basename path ^ "/" in
     Dir (dirname, children)
-  else
+  else File (Filename.basename path)
-    File (Filename.basename path)
 
-let read_tree path =
+let read_tree path = path |> to_tree |> sort_tree
-  path |> to_tree |> sort_tree
 
-type cursor =
+type cursor = {
-  {
+  pos : int;
-     pos: int;
+  files : tree array;
-     files: tree array;
+}
-  }
 
 let file_at cursor =
-  if cursor.pos < 0 || Array.length cursor.files <= cursor.pos
+  if cursor.pos < 0 || Array.length cursor.files <= cursor.pos then None
-  then None
   else Some cursor.files.(cursor.pos)
 
-type zipper =
+type zipper = {
-   {
+  parents : cursor list;
-     parents: cursor list;
+  current : cursor;
-     current: cursor;
+}
-   }
 
-let zip_it trees =
+let zip_it trees = { parents = []; current = { pos = 0; files = trees } }
-  {
-    parents = [];
-    current = { pos = 0; files = trees; }
-  }
 
 let zipper_parents zipper =
   List.filter_map
@@ -87,15 +79,14 @@ let go_next zipper =
   | None -> zipper
   | Some (File _) -> zipper
   | Some (Dir (_, next)) ->
-    if Array.length next = 0 then
+      if Array.length next = 0 then zipper
-      zipper
+      else
-    else
+        {
-      {
+          parents = cursor :: zipper.parents;
-        parents = cursor :: zipper.parents;
+          current = { pos = 0; files = next };
-        current = { pos = 0; files = next; }
+        }
-      }
 
 let go_back zipper =
   match zipper.parents with
   | [] -> zipper
-  | current :: parents -> { parents; current; }
+  | current :: parents -> { parents; current }

lib/gh.ml

@@ -1,19 +1,17 @@
 let github_api_url = "https://api.github.com/graphql"
 
 let query query_body =
-    let token = Sys.getenv "GITHUB_TOKEN" in
+  let token = Sys.getenv "GITHUB_TOKEN" in
-    let response = 
+  let response =
-      Ezcurl.post
+    Ezcurl.post ~params:[]
-        ~params:[]
+      ~headers:
-        ~headers:
+        [
-          [
+          ("Authorization", "bearer " ^ token);
-            ("Authorization", "bearer " ^ token) ;
+          ("User-Agent", "chshersh/github-tui");
-            ("User-Agent", "chshersh/github-tui")
+        ]
-          ]
+      ~content:(`String (Printf.sprintf "{ \"query\": %S }" query_body))
-        ~content:(`String (Printf.sprintf "{ \"query\": %S }" query_body))
+      ~url:github_api_url ()
-        ~url:github_api_url
+  in
-        ()
+  match response with
-    in
+  | Error (_code, msg) -> Printf.sprintf "Error: %s" msg
-    match response with
+  | Ok response -> response.body
-    | Error (_code, msg) -> Printf.sprintf "Error: %s" msg
-    | Ok response -> response.body

lib/list_extra.ml

@@ -4,12 +4,9 @@ let in_between ~sep list =
     | x :: xs -> sep :: x :: loop xs
   in
   match list with
-  | [] | [_] -> list
+  | [] | [ _ ] -> list
   | x :: xs -> x :: loop xs
 
 let generate n f =
-  let rec loop i =
+  let rec loop i = if i = n then [] else f i :: loop (i + 1) in
-    if i = n
+  loop 0
-      then []
-      else f i :: loop (i + 1)
-  in loop 0

lib/pretty.ml

@@ -19,78 +19,61 @@ let col = function
   | [] -> Empty
   | hd :: tl -> List.fold_left (fun l r -> Vertical (l, r)) hd tl
 
-type chunk =
+type chunk = {
-  {
+  styles : styles;
-    styles: styles;
+  string : string;
-    string: string;
+}
-  }
 
-let fmt_chunk {styles; string} =
+let fmt_chunk { styles; string } = ANSITerminal.sprintf styles "%s" string
-  ANSITerminal.sprintf styles "%s" string
 
 let mk_padding_chunk n =
   let padding = String.make n ' ' in
-  {styles = []; string = padding}
+  { styles = []; string = padding }
 
-type line = 
+type line = { chunks : chunk list }
-  { 
-    chunks: chunk list
-  }
 
-let fmt_line line =
+let fmt_line line = line.chunks |> List.map fmt_chunk |> String.concat ""
-  line.chunks
-  |> List.map fmt_chunk
-  |> String.concat "" 
 
 let line_len line =
   List.fold_left
-    (fun acc {string; _} -> acc + String_extra.graphemes_len string)
+    (fun acc { string; _ } -> acc + String_extra.graphemes_len string)
-    0
+    0 line.chunks
-    line.chunks
 
-let zip_lines (l: line list) (r: line list) =
+let zip_lines (l : line list) (r : line list) =
   let max_len_l = List.map line_len l |> List.fold_left max 0 in
 
   let rec zip l r =
     match (l, r) with
-    | (l, []) -> 
+    | l, [] -> l
-      l
+    | [], r ->
+        (* Optimisation: Add extra chunk only if padding is needed *)
+        if max_len_l > 0 then
+          let padding_chunk = mk_padding_chunk max_len_l in
+          List.map (fun line -> { chunks = padding_chunk :: line.chunks }) r
+        else r
+    | hd_l :: tl_l, hd_r :: tl_r ->
+        let left_len = line_len hd_l in
 
-    | ([], r) -> 
+        (* Optimisation: Combine chunks when left is already max len *)
-      (* Optimisation: Add extra chunk only if padding is needed *)
+        if left_len >= max_len_l then
-      if max_len_l > 0 then
+          let new_line = { chunks = hd_l.chunks @ hd_r.chunks } in
-        let padding_chunk = mk_padding_chunk max_len_l in
+          new_line :: zip tl_l tl_r
-        List.map (fun line -> { chunks = padding_chunk :: line.chunks }) r
+        else
-      else
+          let padding_chunk = mk_padding_chunk (max_len_l - left_len) in
-        r
+          let new_line =
-
+            { chunks = hd_l.chunks @ [ padding_chunk ] @ hd_r.chunks }
-    | (hd_l :: tl_l, hd_r :: tl_r) ->
+          in
-      let left_len = line_len hd_l in
+          new_line :: zip tl_l tl_r
-
-      (* Optimisation: Combine chunks when left is already max len *)
-      if left_len >= max_len_l then
-        let new_line = { chunks = hd_l.chunks @ hd_r.chunks } in
-        new_line :: zip tl_l tl_r
-      else
-        let padding_chunk = mk_padding_chunk (max_len_l - left_len) in
-        let new_line = { chunks = hd_l.chunks @ [padding_chunk] @ hd_r.chunks } in
-        new_line :: zip tl_l tl_r
   in
 
   zip l r
 
 let rec render_to_lines = function
-  | Empty ->
+  | Empty -> []
-    []
+  | Str (styles, string) -> [ { chunks = [ { styles; string } ] } ]
-  | Str (styles, string) ->
+  | Vertical (top, bottom) -> render_to_lines top @ render_to_lines bottom
-    [{ chunks = [{styles; string}] }]
-  | Vertical (top, bottom) ->
-    render_to_lines top @ render_to_lines bottom
   | Horizontal (left, right) ->
-    zip_lines (render_to_lines left) (render_to_lines right)
+      zip_lines (render_to_lines left) (render_to_lines right)
 
 let render doc =
-  doc
+  doc |> render_to_lines |> List.map fmt_line |> String_extra.unlines
-  |> render_to_lines
-  |> List.map fmt_line
-  |> String_extra.unlines

lib/string_extra.ml

@@ -3,8 +3,7 @@ let unlines : string list -> string = String.concat "\n"
 let graphemes_len =
   Uuseg_string.fold_utf_8 `Grapheme_cluster (fun len _ -> len + 1) 0
 
-let repeat_txt n txt =
+let repeat_txt n txt = String.concat "" (List.init n (fun _ -> txt))
-  String.concat "" (List.init n (fun _ -> txt))
 
 let fill_right (n : int) (s : string) : string =
   s ^ repeat_txt (n - graphemes_len s) " "

lib/tui.ml

@@ -4,8 +4,8 @@ let start repo path =
   let tree = Fs.read_tree path in
   match tree with
   | Fs.File path ->
-    Printf.printf "Given path '%s' is not a directory!" path;
+      Printf.printf "Given path '%s' is not a directory!" path;
-    exit 1;
+      exit 1
   | Fs.Dir (dirname, files) ->
-    let initial_model = Model.initial_model ~repo ~dirname ~files in
+      let initial_model = Model.initial_model ~repo ~dirname ~files in
-    Minttea.start app ~initial_model
+      Minttea.start app ~initial_model

lib/tui/model.ml

@@ -1,28 +1,20 @@
-type code_tab =
+type code_tab = {
-  {
+  (* Repository directory *)
-    (* Repository directory *)
+  dirname : string;
-    dirname: string;
+  (* Zipper of the repository code *)
-    (* Zipper of the repository code *)
+  fs : Fs.zipper;
-    fs: Fs.zipper ;
+}
-  }
 
 type tab =
   | Code
   | Issues
   | PullRequests
 
-type t =
+type t = {
-  { repo: string ;
+  repo : string;
-    current_tab: tab ;
+  current_tab : tab;
-    code_tab: code_tab ;
+  code_tab : code_tab;
-  }
+}
 
 let initial_model ~repo ~dirname ~files =
-  {
+  { repo; current_tab = Code; code_tab = { dirname; fs = Fs.zip_it files } }
-     repo ;
-     current_tab = Code;
-     code_tab = {
-      dirname;
-      fs = Fs.zip_it files;
-     };
-  }

lib/tui/update.ml

@@ -1,51 +1,45 @@
 open Minttea
 
-let move_fs move_fn (code_tab: Model.code_tab) =
+let move_fs move_fn (code_tab : Model.code_tab) =
   let fs = move_fn code_tab.fs in
-  { code_tab with fs = fs }
+  { code_tab with fs }
 
-let move_up (model: Model.t) = match model.current_tab with
+let move_up (model : Model.t) =
-  | Code ->
+  match model.current_tab with
-    { model with code_tab = move_fs Fs.go_up model.code_tab }
+  | Code -> { model with code_tab = move_fs Fs.go_up model.code_tab }
   | Issues | PullRequests -> model
 
-let move_down (model: Model.t) = match model.current_tab with
+let move_down (model : Model.t) =
-  | Code ->
+  match model.current_tab with
-    { model with code_tab = move_fs Fs.go_down model.code_tab }
+  | Code -> { model with code_tab = move_fs Fs.go_down model.code_tab }
   | Issues | PullRequests -> model
 
-let move_back (model: Model.t) = match model.current_tab with
+let move_back (model : Model.t) =
-  | Code ->
+  match model.current_tab with
-    { model with code_tab = move_fs Fs.go_back model.code_tab }
+  | Code -> { model with code_tab = move_fs Fs.go_back model.code_tab }
   | Issues | PullRequests -> model
 
-let move_next (model: Model.t) = match model.current_tab with
+let move_next (model : Model.t) =
-  | Code ->
+  match model.current_tab with
-    { model with code_tab = move_fs Fs.go_next model.code_tab }
+  | Code -> { model with code_tab = move_fs Fs.go_next model.code_tab }
   | Issues | PullRequests -> model
 
-let update event (model: Model.t) =
+let update event (model : Model.t) =
   match event with
   (* if we press `q` or the escape key, we exit *)
-  | Event.KeyDown (Key "q" | Escape) -> (model, Command.Seq [Command.Exit_alt_screen; Command.Quit])
+  | Event.KeyDown (Key "q" | Escape) ->
-
+      (model, Command.Seq [ Command.Exit_alt_screen; Command.Quit ])
   (* if we press a digit, we switch to the corresponding tab *)
   | Event.KeyDown (Key "1") ->
-    ({ model with current_tab = Model.Code }, Command.Noop)
+      ({ model with current_tab = Model.Code }, Command.Noop)
   | Event.KeyDown (Key "2") ->
-    ({ model with current_tab = Model.Issues }, Command.Noop)
+      ({ model with current_tab = Model.Issues }, Command.Noop)
   | Event.KeyDown (Key "3") ->
-    ({ model with current_tab = Model.PullRequests }, Command.Noop)
+      ({ model with current_tab = Model.PullRequests }, Command.Noop)
-
   (* directions/movements *)
-  | Event.KeyDown (Up | Key "k") ->
+  | Event.KeyDown (Up | Key "k") -> (move_up model, Command.Noop)
-    (move_up model, Command.Noop)
+  | Event.KeyDown (Down | Key "j") -> (move_down model, Command.Noop)
-  | Event.KeyDown (Down | Key "j") ->
+  | Event.KeyDown (Left | Key "h") -> (move_back model, Command.Noop)
-    (move_down model, Command.Noop)
+  | Event.KeyDown (Right | Key "l") -> (move_next model, Command.Noop)
-  | Event.KeyDown (Left | Key "h") ->
-    (move_back model, Command.Noop)
-  | Event.KeyDown (Right | Key "l") ->
-    (move_next model, Command.Noop)
-
   (* otherwise, we do nothing *)
   | _ -> (model, Command.Noop)

lib/tui/view.ml

@@ -1,28 +1,16 @@
-let style_repo =
+let style_repo = ANSITerminal.[ Bold; blue ]
-  ANSITerminal.([Bold; blue])
+let style_selected = ANSITerminal.[ Bold; green ]
-
+let style_directory = ANSITerminal.[ Bold; magenta ]
-let style_selected =
-  ANSITerminal.([Bold; green])
-
-let style_directory =
-  ANSITerminal.([Bold; magenta])
 
 let tabs_section cur_tab =
   let open Pretty in
   let p_tab tab txt =
-    if cur_tab = tab
+    if cur_tab = tab then fmt style_selected txt else str txt
-    then fmt style_selected txt
-    else str txt
-  in
-  let sep = col
-    [
-      str " ";
-      str " ";
-      str "─";
-    ]
   in
+  let sep = col [ str " "; str " "; str "─" ] in
   row
-    [ col
+    [
+      col
         [
           p_tab Model.Code "╭──────╮";
           p_tab Model.Code "│ Code │";
@@ -48,20 +36,16 @@ let current_path_to_doc root_path parents =
   let nested_path =
     List.fold_left
       (fun acc cur -> Filename.concat acc cur)
-      ""
+      "" (List.rev parents)
-      (List.rev parents)
   in
   let full_path = Filename.concat root_path nested_path in
   Pretty.fmt style_directory full_path
 
-let current_level_to_doc (cursor: Fs.cursor) has_next =
+let current_level_to_doc (cursor : Fs.cursor) has_next =
   let open Pretty in
-
   let files = Array.map Fs.file_name cursor.files in
   let max_name_len =
-    files
+    files |> Array.map String_extra.graphemes_len |> Array.fold_left max 0
-    |> Array.map String_extra.graphemes_len
-    |> Array.fold_left max 0
   in
 
   (* Add two spaces for padding before and end of the file name *)
@@ -76,37 +60,29 @@ let current_level_to_doc (cursor: Fs.cursor) has_next =
   let fmt_selected_line line =
     "│ " ^ String_extra.fill_right max_name_len line ^ " ├"
   in
-  let fmt_line line =
+  let fmt_line line = "│ " ^ String_extra.fill_right max_name_len line ^ " │" in
-    "│ " ^ String_extra.fill_right max_name_len line ^ " │"
+  let hi_pos = (2 * cursor.pos) + 1 in
-  in
-  let hi_pos = 2 * cursor.pos + 1 in
 
   (* Combine *)
   files
   |> Array.to_list
   |> List.mapi (fun i line ->
-    if i = cursor.pos && has_next
+         if i = cursor.pos && has_next then fmt_selected_line line
-      then fmt_selected_line line
+         else fmt_line line)
-      else fmt_line line
-  )
   |> List_extra.in_between ~sep:mid
-  |> (fun lines -> [top] @ lines @ [bot])
+  |> (fun lines -> [ top ] @ lines @ [ bot ])
   |> List.mapi (fun i s ->
-    if i = hi_pos - 1 || i = hi_pos || i = hi_pos + 1
+         if i = hi_pos - 1 || i = hi_pos || i = hi_pos + 1 then
-      then fmt style_selected s
+           fmt style_selected s
-      else str s
+         else str s)
-  )
   |> col
 
 let children_to_doc ~prev_total ~pos children =
   let open Pretty in
-
   (* This array is guaranteed to be non-empty at this point *)
   let files = Array.map Fs.file_name children in
   let max_name_len =
-    files
+    files |> Array.map String_extra.graphemes_len |> Array.fold_left max 0
-    |> Array.map String_extra.graphemes_len
-    |> Array.fold_left max 0
   in
 
   (* Add two spaces for padding before and end of the file name *)
@@ -118,17 +94,12 @@ let children_to_doc ~prev_total ~pos children =
   let bot = "  ╰" ^ String_extra.repeat_txt (max_len - 2) "─" ^ "╯" in
 
   (* Connector arrow *)
-  let prev_rows_count = 2 * prev_total + 1 in
+  let prev_rows_count = (2 * prev_total) + 1 in
-  let connect_pos = 2 * pos + 1 in
+  let connect_pos = (2 * pos) + 1 in
   let connector_doc =
-    List_extra.generate
+    List_extra.generate prev_rows_count (fun i ->
-      prev_rows_count
-      (fun i ->
         let is_current_pos = i = connect_pos in
-        if is_current_pos
+        if is_current_pos then str "─" else str " ")
-          then str "─"
-          else str " "
-      )
     |> col
   in
 
@@ -138,14 +109,9 @@ let children_to_doc ~prev_total ~pos children =
     let is_last_pos = i = Array.length children - 1 in
     let has_more_than_one = Array.length children > 1 in
     let prefix =
-      if is_first_pos then
+      if is_first_pos then if has_more_than_one then "┬" else "─"
-        (if has_more_than_one
+      else if is_last_pos then "└"
-          then "┬"
+      else "├"
-          else "─")
-      else if is_last_pos then
-        "└"
-      else
-        "├"
     in
     prefix ^ "─┤ " ^ String_extra.fill_right max_name_len line ^ " │"
   in
@@ -156,22 +122,19 @@ let children_to_doc ~prev_total ~pos children =
     |> Array.to_list
     |> List.mapi fmt_line
     |> List_extra.in_between ~sep:mid
-    |> (fun lines -> [top] @ lines @ [bot])
+    |> (fun lines -> [ top ] @ lines @ [ bot ])
     |> (fun lines ->
-      let pad_before =
+         let pad_before =
-        List_extra.generate
+           List_extra.generate (max (connect_pos - 1) 0) (fun _ -> "")
-          (max (connect_pos - 1) 0)
+         in
-          (fun _ -> "")
+         pad_before @ lines)
-      in
-      pad_before @ lines
-    )
     |> List.map str
     |> col
   in
 
-  row [connector_doc; files_doc]
+  row [ connector_doc; files_doc ]
 
-let next_level_to_doc ~prev_total ~pos (selected_file: Fs.tree) =
+let next_level_to_doc ~prev_total ~pos (selected_file : Fs.tree) =
   (* Get the next level files *)
   match selected_file with
   (* No children of a file *)
@@ -184,50 +147,36 @@ let next_level_to_doc ~prev_total ~pos (selected_file: Fs.tree) =
 let fs_doc (fs : Fs.zipper) =
   let current = fs.current in
   let next_level_doc =
-    Option.bind
+    Option.bind (Fs.file_at current)
-      (Fs.file_at current)
+      (next_level_to_doc
-      (next_level_to_doc ~prev_total:(Array.length current.files) ~pos:current.pos)
+         ~prev_total:(Array.length current.files)
+         ~pos:current.pos)
+  in
+  let current_level_doc =
+    current_level_to_doc current (Option.is_some next_level_doc)
   in
-  let current_level_doc = current_level_to_doc current (Option.is_some next_level_doc) in
   match next_level_doc with
-  | None ->
+  | None -> current_level_doc
-    current_level_doc
+  | Some next_level_doc -> Pretty.row [ current_level_doc; next_level_doc ]
-  | Some next_level_doc ->
-    Pretty.row [ current_level_doc; next_level_doc]
 
-let code_section (code_tab: Model.code_tab) =
+let code_section (code_tab : Model.code_tab) =
-  let current_path_doc = current_path_to_doc
+  let current_path_doc =
-    code_tab.dirname
+    current_path_to_doc code_tab.dirname (Fs.zipper_parents code_tab.fs)
-    (Fs.zipper_parents code_tab.fs)
   in
-  Pretty.col
+  Pretty.col [ current_path_doc; fs_doc code_tab.fs ]
-    [
-      current_path_doc;
-      fs_doc code_tab.fs;
-    ]
 
-let tab_content_section (model: Model.t) =
+let tab_content_section (model : Model.t) =
   match model.current_tab with
   | Code -> code_section model.code_tab
   | Issues | PullRequests -> Pretty.str ""
 
-let to_doc (model: Model.t) =
+let to_doc (model : Model.t) =
   let open Pretty in
-
   let empty = str "" in
   let repo = fmt style_repo model.repo in
   let tabs = tabs_section model.current_tab in
   let content = tab_content_section model in
 
-  col
+  col [ repo; empty; tabs; content; empty ]
-    [
-      repo;
-      empty;
 
-      tabs;
+let view (model : Model.t) = model |> to_doc |> Pretty.render
-      content;
-      empty;
-    ]
-
-let view (model: Model.t) =
-  model |> to_doc |> Pretty.render