Toggle nerd font icons (#57)

* Add a cli arg to toggle icons

* Add docs back

Author: heathhenley

lib/cli.ml

@@ -22,12 +22,22 @@ let ignore_size_warning_arg =
   let doc = "Ignore the minimum size warning." in
   Arg.(value & flag & info [ "i"; "ignore-size-warning" ] ~doc)
 
-let run owner_repo local_path log_file ignore_size_warning =
-  Tui.start { owner_repo; local_path; log_file; ignore_size_warning }
+let no_nerd_font_arg =
+  let doc = "Don't try to use Nerd Font Icons." in
+  Arg.(value & flag & info [ "n"; "no-nerd-font" ] ~doc)
+
+let run owner_repo local_path log_file ignore_size_warning no_nerd_font =
+  Tui.start
+    { owner_repo; local_path; log_file; ignore_size_warning; no_nerd_font }
 
 let gh_tui_term =
   Term.(
-    const run $ owner_repo_arg $ path_arg $ log_arg $ ignore_size_warning_arg)
+    const run
+    $ owner_repo_arg
+    $ path_arg
+    $ log_arg
+    $ ignore_size_warning_arg
+    $ no_nerd_font_arg)
 
 let cmd =
   let doc = "TUI of a GitHub repository" in

lib/pretty/dune

@@ -3,5 +3,6 @@
  (libraries
   ansifmt
   shell
+  str
   ;; Internal dependencies
   extra))

lib/pretty/icon.ml

@@ -1,11 +1,43 @@
-let closed_char = "\u{ebda}"
-let open_char = "\u{ea64}"
-let merged_char = "\u{e725}"
-let arrow_left_char = "\u{f0a8}"
-let pwd_char = "\u{e5fd}"
-let dir_char = "\u{f4d4}"
-let empty_dir_char = "\u{f413}"
-let file_char = "\u{f4a5}"
-let bin_char = "\u{eae8}"
-let warning = "\u{26A0}"
-let issue_char = "\u{f41b}"
+type t = {
+  closed_char : string;
+  open_char : string;
+  merged_char : string;
+  arrow_left_char : string;
+  pwd_char : string;
+  dir_char : string;
+  empty_dir_char : string;
+  file_char : string;
+  bin_char : string;
+  warning : string;
+  issue_char : string;
+}
+
+let get_icons no_nerd_font =
+  if no_nerd_font = false then
+    {
+      closed_char = "\u{ebda}";
+      open_char = "\u{ea64}";
+      merged_char = "\u{e725}";
+      arrow_left_char = "\u{f0a8}";
+      pwd_char = "\u{e5fd}";
+      dir_char = "\u{f4d4}";
+      empty_dir_char = "\u{f413}";
+      file_char = "\u{f4a5}";
+      bin_char = "\u{eae8}";
+      warning = "\u{26A0}";
+      issue_char = "\u{f41b}";
+    }
+  else
+    {
+      closed_char = "x";
+      open_char = "o";
+      merged_char = "m";
+      arrow_left_char = "<-";
+      pwd_char = "*";
+      dir_char = "/";
+      empty_dir_char = "/";
+      file_char = "f";
+      bin_char = "b";
+      warning = "!";
+      issue_char = "i";
+    }

lib/pretty/icon.mli

@@ -0,0 +1,23 @@
+(** A record representing the Icons and symbols used for identifying different
+    parts. Symbols from Hack Nerd Font Mono are used when it's not explicitly
+    disabled.
+
+    Symbols list:
+
+    - https://www.nerdfonts.com/cheat-sheet *)
+type t = {
+  closed_char : string;
+  open_char : string;
+  merged_char : string;
+  arrow_left_char : string;
+  pwd_char : string;
+  dir_char : string;
+  empty_dir_char : string;
+  file_char : string;
+  bin_char : string;
+  warning : string;
+  issue_char : string;
+}
+
+(* Get the icon set - either nerd font or text icons *)
+val get_icons : bool -> t

lib/pretty/pretty.mli

@@ -15,7 +15,6 @@ module Layout = Layout
 
 (** Icons and symbols used for identifying different parts. Symbols from Hack
     Nerd Font Mono are used when it's available. Symbols list:
-
     - https://www.nerdfonts.com/cheat-sheet *)
 module Icon = Icon
 

lib/tui/init/init.ml

@@ -71,12 +71,14 @@ type t = {
   local_path : string option;
   log_file : string option;
   ignore_size_warning : bool;
+  no_nerd_font : bool;
 }
 
-let init { owner_repo; local_path; ignore_size_warning; log_file = _ } :
-    Model.initial_data =
+let init
+    { owner_repo; local_path; ignore_size_warning; log_file = _; no_nerd_font }
+    : Model.initial_data =
   let ({ owner; repo } as owner_repo) = parse_owner_repo owner_repo in
   let root_dir_path = clone_repo ~owner_repo ~local_path in
   let files = Lazy.force (read_root_tree ~root_dir_path) in
   let { height; width } = get_terminal_dimensions ignore_size_warning in
-  { owner; repo; root_dir_path; files; width; height }
+  { owner; repo; root_dir_path; files; width; height; no_nerd_font }

lib/tui/init/init.mli

@@ -3,6 +3,7 @@ type t = {
   local_path : string option;
   log_file : string option;
   ignore_size_warning : bool;
+  no_nerd_font : bool;
 }
 
 val init : t -> Model.initial_data

lib/tui/model/dune

@@ -4,4 +4,5 @@
   ;; Internal dependencies
   fs
   gh
+  pretty
   render))

lib/tui/model/issue.ml

@@ -39,12 +39,12 @@ let apply_filter filter t =
     let scroll_start = 0 in
     { t with filter; issues; offset; scroll_start }
 
-let make ~owner ~repo =
+let make ~owner ~repo icons =
   let issues_and_errors =
     lazy
       (match Gh.Issue.issues ~owner ~repo with
       | Ok issues ->
-          let rendered = Render.issues issues in
+          let rendered = Render.issues issues icons in
           (rendered, None)
       | Error err -> ([], Some err))
   in

lib/tui/model/issue.mli

@@ -22,7 +22,7 @@ and filter =
 val filter_all : filter
 val filter_open : filter
 val filter_closed : filter
-val make : owner:string -> repo:string -> t
+val make : owner:string -> repo:string -> Pretty.Icon.t -> t
 
 (** Change the filter to a new one and update currently selected issues. *)
 val apply_filter : filter -> t -> t