[#39] Move to Ansifmt (#46)

chshersh · qexat · web-flow · commit deb91b859a57 · 2025-02-05T16:55:56.000Z
* Move to Ansifmt
* Make Ansifmt a normal dependency
Ansifmt 0.2.0 was just released, so we can pull it from the opam repository directly.

---------

Co-authored-by: Qexat &lt;43090614+qexat@users.noreply.github.com&gt;
diff --git a/dune-project b/dune-project
@@ -19,7 +19,7 @@
  (depends
    (ocaml (>= "5.1"))
    dune
-   (ANSITerminal (>= "0.8.5"))
+   (ansifmt (>= "0.2.0"))
    (cmdliner (>= "1.2.0"))
    (ezcurl (>= "0.2.4"))
    shape-the-term
diff --git a/github_tui.opam b/github_tui.opam
@@ -11,7 +11,7 @@ bug-reports: "https://github.com/chshersh/github-tui/issues"
 depends: [
   "ocaml" {>= "5.1"}
   "dune" {>= "3.12"}
-  "ANSITerminal" {>= "0.8.5"}
+  "ansifmt" {>= "0.2.0"}
   "cmdliner" {>= "1.2.0"}
   "ezcurl" {>= "0.2.4"}
   "shape-the-term"
diff --git a/lib/pretty/chunk.ml b/lib/pretty/chunk.ml
@@ -3,10 +3,11 @@ type t = {
   string : string;
 }
 
-let fmt { styles; string } = ANSITerminal.sprintf styles "%s" string
+let fmt { styles; string } = Ansifmt.Styling.wrap ~contents:string styles
 
 let replicate width s =
-  if width <= 0 then { styles = []; string = "" }
+  let styles = Style.none in
+  if width <= 0 then { styles; string = "" }
   else
     let filling = Extra.String.repeat_txt width s in
-    { styles = []; string = filling }
+    { styles; string = filling }
diff --git a/lib/pretty/color.ml b/lib/pretty/color.ml
diff --git a/lib/pretty/color.mli b/lib/pretty/color.mli
diff --git a/lib/pretty/doc.ml b/lib/pretty/doc.ml
@@ -7,7 +7,7 @@ type t =
   | Horizontal of t list
   | With_size of (width:int -> height:int -> t)
 
-let str string = Str ([], string)
+let str string = Str (Style.none, string)
 let fmt styles string = Str (styles, string)
 let horizontal cols = Horizontal cols
 let vertical rows = Vertical rows
diff --git a/lib/pretty/doc.mli b/lib/pretty/doc.mli
@@ -1,5 +1,3 @@
-module Style = Style
-
 (** A type representing a structured document. *)
 type t
 
diff --git a/lib/pretty/dune b/lib/pretty/dune
@@ -1,7 +1,7 @@
 (library
  (name pretty)
  (libraries
-  ANSITerminal
+  ansifmt
   shell
   ;; Internal dependencies
   extra))
diff --git a/lib/pretty/layout.ml b/lib/pretty/layout.ml
@@ -17,7 +17,7 @@ let height { height; _ } = height
 let str string =
   let width = Extra.String.width string in
   let height = 1 in
-  let node = Str ([], string) in
+  let node = Str (Style.none, string) in
   { width; height; node }
 
 let fmt styles string =
diff --git a/lib/pretty/layout.mli b/lib/pretty/layout.mli
@@ -1,5 +1,3 @@
-module Style = Style
-
 (** A type representing a structured document with known sizes for all
     sub-elements. *)
 type t
diff --git a/lib/pretty/pretty.ml b/lib/pretty/pretty.ml
@@ -1,6 +1,6 @@
-module Color = Color
 module Doc = Doc
 module Layout = Layout
+module Style = Style
 
 let render ~width ~height doc =
   doc |> Doc.render ~width ~height |> Layout.to_lines |> Extra.String.unlines
diff --git a/lib/pretty/pretty.mli b/lib/pretty/pretty.mli
@@ -1,5 +1,8 @@
 (** A library for declarative UI definition. *)
 
+(** Common styles for GitHub TUI. *)
+module Style = Style
+
 (** A module containing declarative UI definition. The elements provide
     flexibility. *)
 module Doc = Doc
@@ -10,9 +13,6 @@ module Doc = Doc
     {!Layout.t} is the output of {!Doc.render} with all the sizes calculated. *)
 module Layout = Layout
 
-(** Color-related functions. *)
-module Color = Color
-
 (** Render a document into the final string
 
     All notes from {!Doc.render} apply. *)
diff --git a/lib/pretty/style.ml b/lib/pretty/style.ml
@@ -1,15 +1,44 @@
-type t = ANSITerminal.style list
-
-let fg_black = ANSITerminal.[ Foreground Black ]
-let fg_white = ANSITerminal.[ Foreground White ]
-let repo = ANSITerminal.[ Bold; blue ]
-let selected = ANSITerminal.[ Bold; green ]
-let directory = ANSITerminal.[ Bold; magenta ]
-let chosen = ANSITerminal.[ Bold; magenta ]
-let secondary = ANSITerminal.[ cyan ]
-let bold = ANSITerminal.[ Bold ]
-let issue_open = ANSITerminal.[ green ]
-let issue_closed = ANSITerminal.[ red ]
-let pr_closed = ANSITerminal.[ Bold; red ]
-let pr_open = ANSITerminal.[ Bold; green ]
-let pr_merged = ANSITerminal.[ Bold; magenta ]
+module Color = Ansifmt.Color
+module Styling = Ansifmt.Styling
+
+type t = Styling.t
+
+let ( & ) = Styling.( & )
+
+(* Empty style *)
+let none = Styling.none
+
+(* Repository name. *)
+let repo = Styling.(bold & fg Color.blue)
+
+(* A selected element: text or a bordered widget. *)
+let selected = Styling.(bold & fg Color.green)
+
+(* Cloned repository directory. *)
+let directory = Styling.(bold & fg Color.magenta)
+
+(* When a file in a tree viewer is chosen. *)
+let chosen = Styling.(bold & fg Color.magenta)
+
+(* Additional helper text. *)
+let secondary = Styling.(fg Color.cyan)
+let bold = Styling.bold
+let issue_open = Styling.(fg Color.green)
+let issue_closed = Styling.(fg Color.red)
+let pr_closed = Styling.(bold & fg Color.red)
+let pr_open = Styling.(bold & fg Color.green)
+let pr_merged = Styling.(bold & fg Color.magenta)
+
+let apply_background_hex_color ~hex text =
+  let color = Color.make_rgb_hex hex in
+  match color with
+  | None -> (text, `Light)
+  | Some color ->
+      let foreground_suggestion = Color.best_for_contrast ~threshold:80 color in
+      let contents = Printf.sprintf " %s " text in
+      let text = Styling.(wrap ~contents (bg color)) in
+      (text, foreground_suggestion)
+
+let color_of_theme = function
+  | `Light -> Styling.(fg Color.white)
+  | `Dark -> Styling.(fg Color.black)
diff --git a/lib/tui/render/dune b/lib/tui/render/dune
@@ -1,6 +1,7 @@
 (library
  (name render)
  (libraries
+  ansifmt
   ;; Internal dependencies
   extra
   gh
diff --git a/lib/tui/render/render.ml b/lib/tui/render/render.ml
@@ -1,3 +1,4 @@
+module Style = Pretty.Style
 module Layout = Pretty.Layout
 
 type 'a t = {
@@ -24,24 +25,13 @@ let fmt_title (issue : Gh.Issue.t) =
       fmt Style.bold (Printf.sprintf "@%s" issue.author);
     ]
 
-let apply_background_color ~color text =
-  let module Color = Pretty.Color in
-  let color = Color.of_hex color in
-  let foreground_suggestion = Color.foreground color in
-  let color_code = Pretty.Color.to_escape_seq color in
-  let text = Printf.sprintf "\027[48;%sm %s \027[0m" color_code text in
-  (text, foreground_suggestion)
-
 let fmt_labels labels =
   let open Layout in
   let fmt_label (label : Gh.Issue.label) =
     let label, foreground =
-      apply_background_color ~color:label.color label.name
+      Style.apply_background_hex_color ~hex:label.color label.name
     in
-    let label = label ^ " " in
-    match foreground with
-    | `Light -> fmt Style.fg_white label
-    | `Dark -> fmt Style.fg_black label
+    fmt (Style.color_of_theme foreground) (label ^ " ")
   in
   labels |> List.map fmt_label |> fun labels -> horizontal (str "   " :: labels)
 
diff --git a/lib/tui/view.ml b/lib/tui/view.ml
@@ -1,3 +1,5 @@
+module Style = Pretty.Style
+
 let repo_header (model : Model.t) =
   let owner_repo = model.owner ^ "/" ^ model.repo in
   Pretty.Doc.(fmt Style.repo owner_repo)
diff --git a/lib/tui/widget/code.ml b/lib/tui/widget/code.ml
@@ -1,3 +1,5 @@
+module Style = Pretty.Style
+
 let scroll ~lines ~span ~offset =
   let height = 40 in
   let scroll = Scroll.make ~height ~span ~lines ~offset in
diff --git a/lib/tui/widget/generic.ml b/lib/tui/widget/generic.ml
@@ -1,5 +1,5 @@
 module Doc = Pretty.Doc
-module Style = Doc.Style
+module Style = Pretty.Style
 module Layout = Pretty.Layout
 
 type item = {
diff --git a/lib/tui/widget/issue.ml b/lib/tui/widget/issue.ml
@@ -1,9 +1,9 @@
 module Doc = Pretty.Doc
-module Style = Doc.Style
+module Style = Pretty.Style
 module Layout = Pretty.Layout
 
 let fmt_filter ~style ~is_selected filter_box =
-  let fmt = if is_selected then Doc.fmt (style @ Style.bold) else Doc.str in
+  let fmt = if is_selected then Doc.fmt Style.(style & bold) else Doc.str in
   filter_box |> List.map fmt |> Doc.vertical
 
 let fmt_filters current_filter =
@@ -27,7 +27,7 @@ let fmt_filters current_filter =
   in
   let filter_all =
     fmt_filter
-    ~style:[]
+    ~style:Style.none
     ~is_selected:(current_filter = Model.Issue.filter_all)
     [ "╭─────────╮";
       "│ All   a │";
diff --git a/lib/tui/widget/pr.ml b/lib/tui/widget/pr.ml
@@ -1,3 +1,5 @@
+module Style = Pretty.Style
+
 let closed_char = "\u{ebda}"
 let open_char = "\u{ea64}"
 let merged_char = "\u{e725}"
diff --git a/lib/tui/widget/widget.ml b/lib/tui/widget/widget.ml
@@ -2,6 +2,7 @@ module Code = Code
 module Issue = Issue
 module Pr = Pr
 module Generic = Generic
+module Style = Pretty.Style
 
 let about_doc (model: Model.t) =
   let widget =
@@ -17,7 +18,7 @@ let about_doc (model: Model.t) =
     ]
   in
   let open Pretty.Doc in
-  widget |> List.map (fmt ANSITerminal.[ cyan ]) |> vertical
+  widget |> List.map (fmt Style.secondary) |> vertical
   [@@ocamlformat "disable"]
 
 let tab_doc ~is_selected tab_lines =
diff --git a/test/test_extra/test_extra.ml b/test/test_extra/test_extra.ml
@@ -1,6 +1,4 @@
 (* Utilities for Alcotest *)
 
-module Testable = Testable
-
 let test : string -> (unit -> unit) -> unit Alcotest.test_case =
  fun name test -> (name, `Quick, test)
diff --git a/test/test_extra/testable.ml b/test/test_extra/testable.ml
diff --git a/test/test_pretty/test_color.ml b/test/test_pretty/test_color.ml
diff --git a/test/test_pretty/test_pretty.ml b/test/test_pretty/test_pretty.ml
@@ -1 +1 @@
-let tests = List.flatten [ Test_color.tests ]
+let tests = List.flatten []

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-module Style = Style`
`2`		`-`
`3`	`1`	`(** A type representing a structured document. *)`
`4`	`2`	`type t`
`5`	`3`