add folds and comments to mail ftplugin

[etc/lazyvim.git] / .config / lazyvim / after / ftplugin / mail.lua

diff --git a/.config/lazyvim/after/ftplugin/mail.lua b/.config/lazyvim/after/ftplugin/mail.lua
index b3d4005a731debe4d57fc1d4cad2000054a8f180..39eaf3e1639ce29997a05ad1eca1bc287e4f5564 100644 (file)
--- a/.config/lazyvim/after/ftplugin/mail.lua
+++ b/.config/lazyvim/after/ftplugin/mail.lua
@@ -1,3 +1,4 @@
+-- {{{ markdown in mail
 local i, _ = string.find(vim.bo.filetype, "markdown")
 if not i then
   vim.opt_local.filetype = "mail.markdown"
@@ -12,11 +13,17 @@ vim.b.autoformat = false
 
 -- disable Treesitter format expression for Mail
 vim.opt_local.formatexpr = ""
+-- }}}
 
-vim.opt_local.formatoptions:remove("o")
-vim.opt_local.formatoptions:remove("r")
-vim.opt_local.formatoptions:remove("l")
+-- {{{ formatting
+vim.opt_local.formatoptions:remove("o") -- would insert current comment leader for o/O
+vim.opt_local.formatoptions:remove("r") -- would insert current comment leader for <CR>
+vim.opt_local.formatoptions:remove("l") -- would not break lines that were long before insert
 
+vim.opt_local.commentstring = "> %s" -- commenting means quoting in mails
+-- }}}
+
+-- {{{ keymaps
 vim.keymap.set("n", "<leader>m", "", { buffer = true, desc = "mail functions" })
 vim.keymap.set("n", "<leader>ms", "", { buffer = true, desc = "subject manipulation" })
 
@@ -34,6 +41,8 @@ vim.keymap.set(
   { buffer = true, desc = "remove old subjects" }
 )
 
+-- {{{ profiles
+
 vim.keymap.set("n", "<leader>p", "", { buffer = true, desc = "mailplate profiles" })
 
 vim.keymap.set(
@@ -65,6 +74,11 @@ profile_keymap("F10", "mtfk")
 profile_keymap("F11", "sudetia")
 profile_keymap("F12", "default")
 
+-- }}} profiles
+-- }}}
+
+-- {{{ write mail backups
+
 local function write_mail_backup()
   local tmpdir = vim.fn.expand(os.getenv("TMPDIR") or "/tmp") .. "/mail-backups"
   vim.fn.mkdir(tmpdir, "p", "0o700")
@@ -84,7 +98,9 @@ vim.api.nvim_create_autocmd({ "BufWrite" }, {
   buffer = 0,
 })
 
-vim.cmd.runtime("greeting_abbrevs.vim")
+-- }}}
+
+-- {{{ mail area detect
 
 local function mail_area_detect()
   local ts = vim.treesitter
@@ -96,11 +112,11 @@ local function mail_area_detect()
     return
   end
   if node:type():find("^body") ~= nil then
-    vim.opt_local.formatoptions:append("a")
-    vim.opt_local.formatoptions:append("w")
-    vim.opt_local.formatoptions:append("n")
-    vim.opt_local.formatoptions:append("t")
-    vim.opt_local.formatoptions:append("c")
+    vim.opt_local.formatoptions:append("a") -- turn on auto-reflow
+    vim.opt_local.formatoptions:append("w") -- trailing whitespace for format=flowed
+    vim.opt_local.formatoptions:append("n") -- numbered lists
+    vim.opt_local.formatoptions:append("t") -- autowrap with textwidth
+    vim.opt_local.formatoptions:append("c") -- autowrap and insert quote (comment) leader
     vim.w.in_body = true
   else
     vim.opt_local.formatoptions:remove("a")
@@ -119,3 +135,9 @@ vim.api.nvim_create_autocmd({ "CursorMoved", "CursorMovedI" }, {
   callback = mail_area_detect,
 })
 mail_area_detect()
+
+vim.cmd.runtime("greeting_abbrevs.vim")
+
+-- }}}
+
+-- vim:foldmethod=marker:foldlevel=0