Ensure OpamConsole.pause always prints a newline character at the end

ocaml · Feb 10, 2025 · 6e89c8c · 6e89c8c
1 parent 78fb841
commit 6e89c8c
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/master_changes.md b/master_changes.md
@@ -233,6 +233,7 @@ users)
 
 ## opam-core
   * `OpamConsole`: Replace `black` text style (unused and not very readable) by `gray` [#6358 @kit-ty-kate]
+  * `OpamConsole.pause`: Ensure the function always prints a newline character at the end [#6376 @kit-ty-kate]
   * `OpamStd.List.split`: Improve performance [#6210 @kit-ty-kate]
   * `OpamStd.Sys.{get_terminal_columns,uname,getconf,guess_shell_compat}`: Harden the process calls to account for failures [#6230 @kit-ty-kate - fix #6215]
   * `OpamStd.Sys.getconf`: was removed, replaced by `get_long_bit` [#6217 @kit-ty-kate]

diff --git a/src/client/opamClient.ml b/src/client/opamClient.ml
@@ -1288,7 +1288,6 @@ let initialise_msys2 root =
         OpamConsole.error_and_exit `Aborted "MSYS2 failed to initialise"
     | `No ->
       OpamConsole.pause "Standing by, press enter to continue when done.";
-      OpamConsole.msg "\n"
     | `Ignore ->
       ()
     | `Quit ->

diff --git a/src/client/opamSolution.ml b/src/client/opamSolution.ml
@@ -1215,7 +1215,6 @@ let install_sys_packages ~map_sysmap ~confirm env config sys_packages t =
       OpamConsole.msg "\n";
       print_command sys_packages;
       OpamConsole.pause "Standing by, press enter to continue when done.";
-      OpamConsole.msg "\n";
       check_again t sys_packages
     | `Ignore -> bypass t
     | `Quit -> give_up_msg (); OpamStd.Sys.exit_because `Aborted

diff --git a/src/core/opamConsole.ml b/src/core/opamConsole.ml
@@ -748,9 +748,9 @@ let short_user_input ~prompt ?default ?on_eof f =
       match input with
       | None -> loop ()
       | Some i -> match f i with
-        | Some a ->
-          if String.length i > 0 && i.[0] <> '\027' then print_endline i;
-          a
+        | Some a when String.length i > 0 && i.[0] = '\027' ->
+          print_newline (); a
+        | Some a -> print_endline i; a
         | None -> loop ()
     in
     let attr = tcgetattr stdin in
@@ -780,7 +780,7 @@ let pause fmt =
         let prompt = OpamStd.Format.reformat s in
         short_user_input ~prompt ~default:""
         (function
-        | "\027" -> OpamStd.Sys.exit_because `Aborted
+        | "\027" -> print_newline (); OpamStd.Sys.exit_because `Aborted
         | _ -> Some ()))
       fmt
   else