fix(doc)!: update default write_pre to remove top ===/--- delims

Details:
- This complies better with `:h local-additions`.

Resolve #2100

Author: echasnovski

CHANGELOG.md

@@ -87,6 +87,12 @@ There are following change types:
 
 - Add support for working with files containing BOM bytes.
 
+## mini.doc
+
+### Refine
+
+- Update default `write_pre` hook to remove `===` and `---` delimiters from the top to better comply with `:h local-additions`.
+
 ## mini.extra
 
 ### Expand

doc/mini-doc.txt

@@ -207,7 +207,7 @@ Defaults ~
       doc = --<function: adds modeline>,
 
       -- Applied before output file is written. Takes lines array as argument.
-      write_pre = --<function: currently returns its input>,
+      write_pre = --<function: remove delimiters at the top>,
 
       -- Applied after output help file is written. Takes doc as argument.
       write_post = --<function: various convenience actions>,

lua/mini/doc.lua

@@ -397,8 +397,14 @@ MiniDoc.config = {
     --minidoc_replace_end
 
     -- Applied before output file is written. Takes lines array as argument.
-    --minidoc_replace_start write_pre = --<function: currently returns its input>,
-    write_pre = function(l) return l end,
+    --minidoc_replace_start write_pre = --<function: remove delimiters at the top>,
+    write_pre = function(l)
+      -- Remove first two lines with `======` and `------` delimiters to comply
+      -- with `:h local-additions` template
+      if l[1]:find('^=+$') ~= nil then table.remove(l, 1) end
+      if l[1]:find('^-+$') ~= nil then table.remove(l, 1) end
+      return l
+    end,
     --minidoc_replace_end
 
     -- Applied after output help file is written. Takes doc as argument.

readmes/mini-doc.md

@@ -163,7 +163,7 @@ Here are code snippets for some common installation methods (use only one):
     doc = --<function: adds modeline>,
 
     -- Applied before output file is written. Takes lines array as argument.
-    write_pre = --<function: currently returns its input>,
+    write_pre = --<function: remove delimiters at the top>,
 
     -- Applied after output help file is written. Takes doc as argument.
     write_post = --<function: various convenience actions>,

scripts/minidoc.lua

@@ -48,18 +48,8 @@ local modules = {
   'visits',
 }
 
-local hooks = vim.deepcopy(MiniDoc.default_hooks)
-
-hooks.write_pre = function(lines)
-  -- Remove first two lines with `======` and `------` delimiters to comply
-  -- with `:h local-additions` template
-  table.remove(lines, 1)
-  table.remove(lines, 1)
-  return lines
-end
-
-MiniDoc.generate({ 'lua/mini/init.lua' }, 'doc/mini-nvim.txt', { hooks = hooks })
+MiniDoc.generate({ 'lua/mini/init.lua' }, 'doc/mini-nvim.txt')
 
 for _, m in ipairs(modules) do
-  MiniDoc.generate({ 'lua/mini/' .. m .. '.lua' }, 'doc/mini-' .. m .. '.txt', { hooks = hooks })
+  MiniDoc.generate({ 'lua/mini/' .. m .. '.lua' }, 'doc/mini-' .. m .. '.txt')
 end

tests/dir-doc/arguments/output_reference.txt

@@ -1,5 +1,3 @@
-==============================================================================
-------------------------------------------------------------------------------
 This file should be used to generate output help file.
 It also should respect `--` as annotation prefix (as test for respecting
 `config` argument).

tests/dir-doc/custom-script/output_reference.txt

@@ -1,5 +1,3 @@
-==============================================================================
-------------------------------------------------------------------------------
 File inside test for usage of custom script
 
 

tests/dir-doc/default-collation/default-collation_reference.txt

@@ -1,5 +1,3 @@
-==============================================================================
-------------------------------------------------------------------------------
 File 'default-collation/init.lua'
 
 

tests/dir-doc/inference/inference_reference.txt

@@ -1,5 +1,3 @@
-==============================================================================
-------------------------------------------------------------------------------
 Tests for inferring from afterline
 
 ------------------------------------------------------------------------------

tests/dir-doc/sections/sections_reference.txt

@@ -1,5 +1,3 @@
-==============================================================================
-------------------------------------------------------------------------------
                                                                         *M.User*
                                     `M.User`
 Test for `@class`, `@field`, and `@type`