dotfiles/config/nvim/lua/plugins/pretty-fold.lua

-- Fold code.

return {
  "anuvyklack/pretty-fold.nvim",
  config = {
    fill_char = "•",
    sections = {
      left = {
        "content",
      },
      right = {
        " ",
        "number_of_folded_lines",
        ": ",
        "percentage",
        " ",
        function(config) return config.fill_char:rep(3) end,
      },
    },

    remove_fold_markers = false,

    -- Keep the indentation of the content of the fold string.
    keep_indentation = true,

    -- Possible values:
    -- "delete" : Delete all comment signs from the fold string.
    -- "spaces" : Replace all comment signs with equal number of spaces.
    -- false    : Do nothing with comment signs.
    process_comment_signs = "spaces",

    -- Comment signs additional to the value of `&commentstring` option.
    comment_signs = {
      { "/**", "*/" }, -- multiline comment
      { "<!--", "-->" }, -- multiline comment
      { "%--[[", "--]]" }, -- multiline comment
    },

    -- List of patterns that will be removed from content foldtext section.
    stop_words = {
      "@brief%s*", -- (for C++) Remove '@brief' and all spaces after.
    },

    add_close_pattern = true,
    matchup_patterns = {
      { "{", "}" },
      { "%(", ")" }, -- % to escape lua pattern char
      { "%[", "]" }, -- % to escape lua pattern char
      { "if%s", "end" },
      { "do%s", "end" },
      { "for%s", "end" },
      { "function%s*%(", "end" }, -- 'function(' or 'function ('
    },
  },
}