use plugin nvim-ufo for better folding

The settings are copied from kevinhwang91/nvim-ufo#4 (comment),
with some modification.

lua/config/nvim_ufo.lua

@@ -0,0 +1,48 @@
+local handler = function(virtText, lnum, endLnum, width, truncate)
+  local newVirtText = {}
+  local totalLines = vim.api.nvim_buf_line_count(0)
+  local foldedLines = endLnum - lnum
+  local suffix = (" 󰁂  %d"):format(foldedLines)
+  local sufWidth = vim.fn.strdisplaywidth(suffix)
+  local targetWidth = width - sufWidth
+  local curWidth = 0
+
+  for _, chunk in ipairs(virtText) do
+    local chunkText = chunk[1]
+    local chunkWidth = vim.fn.strdisplaywidth(chunkText)
+    if targetWidth > curWidth + chunkWidth then
+      table.insert(newVirtText, chunk)
+    else
+      chunkText = truncate(chunkText, targetWidth - curWidth)
+      local hlGroup = chunk[2]
+      table.insert(newVirtText, { chunkText, hlGroup })
+      chunkWidth = vim.fn.strdisplaywidth(chunkText)
+      -- str width returned from truncate() may less than 2nd argument, need padding
+      if curWidth + chunkWidth < targetWidth then
+        suffix = suffix .. (" "):rep(targetWidth - curWidth - chunkWidth)
+      end
+      break
+    end
+    curWidth = curWidth + chunkWidth
+  end
+  local rAlignAppndx = math.max(math.min(vim.opt.textwidth["_value"], width - 1) - curWidth - sufWidth, 0)
+  suffix = (" "):rep(rAlignAppndx) .. suffix
+  table.insert(newVirtText, { suffix, "MoreMsg" })
+  return newVirtText
+end
+
+local opts = {}
+opts["fold_virt_text_handler"] = handler
+
+require("ufo").setup(opts)
+
+vim.keymap.set("n", "zR", require("ufo").openAllFolds)
+vim.keymap.set("n", "zM", require("ufo").closeAllFolds)
+vim.keymap.set("n", "zr", require("ufo").openFoldsExceptKinds)
+vim.keymap.set("n", "<leader>K", function()
+  local winid = require("ufo").peekFoldedLinesUnderCursor()
+  if not winid then
+    -- vim.lsp.buf.hover()
+    vim.cmd([[ Lspsaga hover_doc ]])
+  end
+end)

lua/plugin_specs.lua

@@ -180,7 +180,36 @@ local plugin_specs = {
       require("config.indent-blankline")
     end,
   },
-
+  {
+    "luukvbaal/statuscol.nvim",
+    opts = {},
+    config = function()
+      local builtin = require("statuscol.builtin")
+      require("statuscol").setup {
+        relculright = true,
+        segments = {
+          { text = { builtin.foldfunc }, click = "v:lua.ScFa" },
+          { text = { "%s" }, click = "v:lua.ScSa" },
+          { text = { builtin.lnumfunc, " " }, click = "v:lua.ScLa" },
+        },
+      }
+    end,
+  },
+  {
+    "kevinhwang91/nvim-ufo",
+    dependencies = "kevinhwang91/promise-async",
+    event = "VeryLazy",
+    opts = {},
+    init = function()
+      vim.o.foldcolumn = "1" -- '0' is not bad
+      vim.o.foldlevel = 99 -- Using ufo provider need a large value, feel free to decrease the value
+      vim.o.foldlevelstart = 99
+      vim.o.foldenable = true
+    end,
+    config = function()
+      require("config.nvim_ufo")
+    end,
+  },
   -- Highlight URLs inside vim
   { "itchyny/vim-highlighturl", event = "VeryLazy" },
 
@@ -442,7 +471,7 @@ local plugin_specs = {
       -- local prologue = "echo"
       local cmd_str = string.format(":call firenvim#install(0, '%s')", prologue)
       vim.cmd(cmd_str)
-    end
+    end,
   },
   -- Debugger plugin
   {
@@ -517,6 +546,6 @@ require("lazy").setup {
     title_pos = "center",
   },
   rocks = {
-    enabled = false
+    enabled = false,
   },
 }

viml_conf/options.vim

@@ -1,7 +1,7 @@
 scriptencoding utf-8
 
 " change fillchars for folding, vertical split, end of buffer, and message separator
-set fillchars=fold:\ ,vert:\│,eob:\ ,msgsep:‾,diff:╱
+set fillchars=fold:\ ,foldsep:\ ,foldopen:,foldclose:,vert:\│,eob:\ ,msgsep:‾,diff:╱
 
 " Split window below/right when creating horizontal/vertical windows
 set splitbelow splitright