feat: Allow for configuration of foldlevel similar to Emacs Orgmode (#615)

Author: PriceHiller

DOCS.md

@@ -153,6 +153,15 @@ Applies to:
         - agenda window
         - capture window
 
+#### **org_startup_folded**
+*type*: `string`<br />
+*default value*: `overview`<br />
+How many headings and other foldable items should be shown when an org file is opened.<br />
+Available options:
+* `overview` - Only show top level elements (default)
+* `content` - Only show the first two levels
+* `showeverything` - A double line box
+* `inherit` - Use the fold level set in Neovim's global `foldlevel` option
 
 #### **org_todo_keyword_faces**
 *type*: `table<string, string>`<br />

ftplugin/org.vim

@@ -5,6 +5,7 @@ let b:did_ftplugin = 1
 
 lua require('orgmode.config'):setup_mappings('org')
 lua require('orgmode.config'):setup_mappings('text_objects')
+lua require('orgmode.config'):setup_foldlevel()
 
 function! OrgmodeFoldText()
   return luaeval('require("orgmode.org.indent").foldtext()')
@@ -24,7 +25,6 @@ setlocal foldmethod=expr
 setlocal foldexpr=nvim_treesitter#foldexpr()
 setlocal foldtext=OrgmodeFoldText()
 setlocal formatexpr=OrgmodeFormatExpr()
-setlocal foldlevel=0
 setlocal omnifunc=OrgmodeOmni
 setlocal commentstring=#\ %s
 inoreabbrev <silent><buffer> :today: <C-R>=luaeval("require('orgmode.objects.date').today():to_wrapped_string(true)")<CR>

lua/orgmode/config/defaults.lua

@@ -16,6 +16,7 @@ local DefaultConfig = {
       template = '* TODO %?\n  %u',
     },
   },
+  org_startup_folded = 'overview',
   org_agenda_skip_scheduled_if_done = false,
   org_agenda_skip_deadline_if_done = false,
   org_agenda_text_search_extra_files = {},

lua/orgmode/config/init.lua

@@ -292,6 +292,21 @@ function Config:setup_mappings(category, buffer)
   end
 end
 
+--- Setup the foldlevel for a given org file
+function Config:setup_foldlevel()
+  if self.org_startup_folded == 'overview' then
+    vim.opt_local.foldlevel = 0
+  elseif self.org_startup_folded == 'content' then
+    vim.opt_local.foldlevel = 1
+  elseif self.org_startup_folded == 'showeverything' then
+    vim.opt_local.foldlevel = 99
+  elseif self.org_startup_folded ~= 'inherit' then
+    utils.echo_warning("Invalid option passed for 'org_startup_folded'!")
+    self.opts.org_startup_folded = 'overview'
+    self:setup_foldlevel()
+  end
+end
+
 ---@return string|nil
 function Config:parse_archive_location(file, archive_loc)
   if self:is_archive_file(file) then