Add option to hide usage message

When the 'cmdheight` option is set to 0, printing the usage message
triggers the "Press ENTER or type command to continue" prompt.

Fixes #4

Author: rafikdraoui

doc/jj-diffconflicts.txt

@@ -56,14 +56,23 @@ g:jj_diffconflicts_jujutsu_version          *g:jj_diffconflicts_jujutsu_version*
     binary is not desirable.
 
     Example:
-        `let g:jj_diffconflicts_jujutsu_version='0.17.1'`
+        `vim.g.jj_diffconflicts_jujutsu_version="0.17.1"`
 
 g:jj_diffconflicts_no_command                    *g:jj_diffconflicts_no_command*
 
     Set this variable if you don't want the |:JJDiffConflicts| command to be
     automatically defined. When set, the main plugin function can instead be
     run with `require("jj-diffconflicts").run()`
 
+g:jj_diffconflicts_show_usage_message    *g:jj_diffconflicts_show_usage_message*
+
+    Set this variable to `false` to hide the usage message at start up.
+
+    Defaults to `true`.
+
+    Example:
+        `vim.g.jj_diffconflicts_show_usage_message=false`
+
 
 Health check ~
 

lua/jj-diffconflicts/init.lua

@@ -55,7 +55,11 @@ M.run = function(show_history, marker_length)
     table.insert(conflicts, conflict)
   end
 
-  h.setup_ui(conflicts, show_history)
+  local show_usage_message = vim.g.jj_diffconflicts_show_usage_message
+  if show_usage_message == nil then
+    show_usage_message = true
+  end
+  h.setup_ui(conflicts, show_history, show_usage_message)
 end
 
 -- Return a table representing a software version that can be used as an
@@ -274,7 +278,7 @@ h.parse_conflict = function(patterns, raw_conflict)
   }
 end
 
-h.setup_ui = function(conflicts, show_history)
+h.setup_ui = function(conflicts, show_history, show_usage_message)
   if show_history then
     -- Set up history view in a separate tab
     vim.cmd.tabnew()
@@ -287,13 +291,15 @@ h.setup_ui = function(conflicts, show_history)
 
   -- Set up conflict resolution diff
   h.setup_diff_splits(conflicts)
+  vim.cmd.redraw()
 
   -- Display usage message
-  vim.cmd.redraw()
-  vim.notify(
-    "Resolve conflicts leftward then save. Use :cq to abort.",
-    vim.log.levels.WARN
-  )
+  if show_usage_message then
+    vim.notify(
+      "Resolve conflicts leftward then save. Use :cq to abort.",
+      vim.log.levels.WARN
+    )
+  end
 end
 
 -- Set up a two-way diff for conflict resolution.

tests/screenshots/no_usage_message

@@ -0,0 +1,51 @@
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|  X                                    │  X                                     
+02|  X                                    │  X                                     
+03|  X                                    │  X                                     
+04|  apple                                │  APPLE                                 
+05|  grapefruit                           │  GRAPE                                 
+06|  orange                               │  ORANGE                                
+07|  X                                    │  X                                     
+08|  X                                    │  X                                     
+09|  X                                    │  X                                     
+10|~                                      │~                                       
+11|~                                      │~                                       
+12|~                                      │~                                       
+13|~                                      │~                                       
+14|~                                      │~                                       
+15|~                                      │~                                       
+16|~                                      │~                                       
+17|~                                      │~                                       
+18|~                                      │~                                       
+19|~                                      │~                                       
+20|~                                      │~                                       
+21|~                                      │~                                       
+22|~                                      │~                                       
+23|[No Name] [+]        4,1            All snapshot [RO]         4,1            All
+24|                                                                                
+
+--|---------|---------|---------|---------|---------|---------|---------|---------|
+01|00111111111111111111111111111111111111120011111111111111111111111111111111111111
+02|00111111111111111111111111111111111111120011111111111111111111111111111111111111
+03|00111111111111111111111111111111111111120011111111111111111111111111111111111111
+04|00333334444444444444444444444444444444420033333444444444444444444444444444444444
+05|00333333333344444444444444444444444444420033333444444444444444444444444444444444
+06|00333333444444444444444444444444444444420033333344444444444444444444444444444444
+07|00111111111111111111111111111111111111120011111111111111111111111111111111111111
+08|00111111111111111111111111111111111111120011111111111111111111111111111111111111
+09|00111111111111111111111111111111111111120011111111111111111111111111111111111111
+10|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+11|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+12|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+13|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+14|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+15|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+16|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+17|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+18|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+19|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+20|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+21|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+22|00000000000000000000000000000000000000020000000000000000000000000000000000000000
+23|55555555555555555555555555555555555555556666666666666666666666666666666666666666
+24|77777777777777777777777777777777777777777777777777777777777777777777777777777777

tests/test_jj_diffconflicts.lua

@@ -15,6 +15,7 @@ local SCREENSHOT = {
   long_markers = "tests/screenshots/long_markers_ui",
   multiple_conflicts = "tests/screenshots/multiple_conflicts_ui",
   missing_newline = "tests/screenshots/missing_newline_ui",
+  no_usage_message = "tests/screenshots/no_usage_message",
 }
 
 local T = MiniTest.new_set({
@@ -81,6 +82,12 @@ T["run"]["handles missing newlines conflicts"] = function()
   child.lua("jj.run(false, 7)")
   expect.reference_screenshot(child.get_screenshot(), SCREENSHOT.missing_newline)
 end
+T["run"]["hides usage message when g:jj_diffconflicts_show_usage_message is false"] = function()
+  set_lines(read_file("tests/data/fruits.txt"))
+  child.g.jj_diffconflicts_show_usage_message = false
+  child.lua("jj.run(false, 7)")
+  expect.reference_screenshot(child.get_screenshot(), SCREENSHOT.no_usage_message)
+end
 
 T["history view"] = MiniTest.new_set()
 T["history view"]["displays UI"] = function()