Fix folding with code block and level setting

- Add fenced code blocks tracking to pythonic folding
- Fix fenced code block check with folding
- Fix setext fold level setting grater than 2
- Add tests for g:vim_markdown_folding_level

- The behavior commented in tests would not be a bug.
  Fold level `-1` is returned against atx headers.
  `-1` means that the fold level is undefined, use the fold level
  of a line before or after this line, whichever is the lowest.
  Fold level of setext headers `=` should be 1.
  14 lines of `foldtextresult(45)` is corrent because 15th blank
  line is delimiter line of vader.

diff --git a/after/ftplugin/markdown.vim b/after/ftplugin/markdown.vim
index 06a1583835a7468ddff46145005c1275c01a662e..586ff2f5b001ee8490c5a6f7d6f8e1fd74b8d2ab 100644 (file)
--- a/after/ftplugin/markdown.vim
+++ b/after/ftplugin/markdown.vim
@@ -13,17 +13,26 @@ endfunction
 
 if get(g:, "vim_markdown_folding_style_pythonic", 0)
     function! Foldexpr_markdown(lnum)
 
 if get(g:, "vim_markdown_folding_style_pythonic", 0)
     function! Foldexpr_markdown(lnum)

+        let l1 = getline(a:lnum)
+        " keep track of fenced code blocks
+        if l1 =~ '````*' || l1 =~ '\~\~\~\~*'
+            if b:fenced_block == 0
+                let b:fenced_block = 1
+            elseif b:fenced_block == 1
+                let b:fenced_block = 0
+            endif
+        endif
+

         let l2 = getline(a:lnum+1)
         let l2 = getline(a:lnum+1)

-        if  l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
+        if l2 =~ '^==\+\s*' && b:fenced_block == 0 && !s:is_mkdCode(a:lnum+1)

             " next line is underlined (level 1)
             return '>0'
             " next line is underlined (level 1)
             return '>0'

-        elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
+        elseif l2 =~ '^--\+\s*' && b:fenced_block == 0 && !s:is_mkdCode(a:lnum+1)

             " next line is underlined (level 2)
             return '>1'
         endif
 
             " next line is underlined (level 2)
             return '>1'
         endif
 

-        let l1 = getline(a:lnum)
-        if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
+        if l1 =~ '^#' && b:fenced_block == 0 && !s:is_mkdCode(a:lnum)

             " current line starts with hashes
             return '>'.(matchend(l1, '^#\+') - 1)
         elseif a:lnum == 1
             " current line starts with hashes
             return '>'.(matchend(l1, '^#\+') - 1)
         elseif a:lnum == 1


@@ -63,12 +72,12 @@ else
         endif
 
         let l2 = getline(a:lnum+1)
         endif
 
         let l2 = getline(a:lnum+1)

-        if  l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
+        if  l2 =~ '^==\+\s*' && b:fenced_block == 0 && !s:is_mkdCode(a:lnum+1)

             " next line is underlined (level 1)
             return '>1'
             " next line is underlined (level 1)
             return '>1'

-        elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
+        elseif l2 =~ '^--\+\s*' && b:fenced_block == 0 && !s:is_mkdCode(a:lnum+1)

             " next line is underlined (level 2)
             " next line is underlined (level 2)

-            if g:vim_markdown_folding_level == 2
+            if g:vim_markdown_folding_level >= 2

                 return '>1'
             else
                 return '>2'
                 return '>1'
             else
                 return '>2'


@@ -76,22 +85,18 @@ else
         endif
 
         let l1 = getline(a:lnum)
         endif
 
         let l1 = getline(a:lnum)

-        if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
+        if l1 =~ '^#' && b:fenced_block == 0 && !s:is_mkdCode(a:lnum)

             " fold level according to option
             let l:level = matchend(l1, '^#\+')
             if g:vim_markdown_folding_level == 1 || l:level > g:vim_markdown_folding_level
                 return -1
             else
             " fold level according to option
             let l:level = matchend(l1, '^#\+')
             if g:vim_markdown_folding_level == 1 || l:level > g:vim_markdown_folding_level
                 return -1
             else

-                " code blocks are always folded
-                return b:fenced_block
+                " headers are not folded
+                return 0

             endif
         endif
 
             endif
         endif
 

-        if l0 =~ '^#' && !s:is_mkdCode(a:lnum-1)
-            " collapse comments in fenced code blocks into a single fold
-            if b:fenced_block == 1
-                return 1
-            endif
+        if l0 =~ '^#' && b:fenced_block == 0 && !s:is_mkdCode(a:lnum-1)

             " current line starts with hashes
             return '>'.matchend(l0, '^#\+')
         else
             " current line starts with hashes
             return '>'.matchend(l0, '^#\+')
         else

diff --git a/test/folding-toc.vader b/test/folding-toc.vader
index 950d8cd19a298482f88b59b06e883bc12f4a7532..e743e63f2aac4d6c1b1da0f728d1181d56be5031 100644 (file)
--- a/test/folding-toc.vader
+++ b/test/folding-toc.vader
@@ -85,15 +85,34 @@ Execute (fold level):
   AssertEqual foldlevel(45), 1, 'chap 4\n======'
   AssertEqual foldlevel(48), 1, 'setext are evil'
   AssertEqual foldlevel(50), 2, 'chap 4.1\n------'
   AssertEqual foldlevel(45), 1, 'chap 4\n======'
   AssertEqual foldlevel(48), 1, 'setext are evil'
   AssertEqual foldlevel(50), 2, 'chap 4.1\n------'

-" BUG: for lines 30, 41, 45, the foldlevel should be 0.
-" The folding behavior itself is correct, but the level number isn't.

 
 Execute (fold text result):
   AssertEqual foldtextresult(2), '+-- 28 lines: hello'
   AssertEqual foldtextresult(31), '+-- 10 lines: another'
   AssertEqual foldtextresult(42), '+--  3 lines: nothing here'
   AssertEqual foldtextresult(45), '+-- 14 lines: chap 4'
 
 Execute (fold text result):
   AssertEqual foldtextresult(2), '+-- 28 lines: hello'
   AssertEqual foldtextresult(31), '+-- 10 lines: another'
   AssertEqual foldtextresult(42), '+--  3 lines: nothing here'
   AssertEqual foldtextresult(45), '+-- 14 lines: chap 4'

-" BUG: for line 45, vim shows and calling foldtextresult even echoes 15 lines.
+
+Execute (fold level with setting):
+  let g:vim_markdown_folding_level = 2
+  source ../after/ftplugin/markdown.vim
+  AssertEqual foldlevel(1), 0, '# chap 1'
+  AssertEqual foldlevel(3), 1, 'hello'
+  AssertEqual foldlevel(6), 1, '```bash'
+  AssertEqual foldlevel(7), 1, '# some bash scripting'
+  AssertEqual foldlevel(15), 0, '## chap 1.1'
+  AssertEqual foldlevel(21), 2, 'mkdir foo'
+  AssertEqual foldlevel(22), 2, 'comment in ~'
+  AssertEqual foldlevel(25), 2, '### chap 1.1.1'
+  AssertEqual foldlevel(27), 3, '- dragons'
+  AssertEqual foldlevel(30), 0, '# chap 2'
+  AssertEqual foldlevel(32), 1, 'another'
+  AssertEqual foldlevel(34), 0, '# chap 2.1'
+  AssertEqual foldlevel(37), 2, '- japan'
+  AssertEqual foldlevel(41), 0, '# chap 3'
+  AssertEqual foldlevel(45), 1, 'chap 4\n======'
+  AssertEqual foldlevel(48), 1, 'setext are evil'
+  AssertEqual foldlevel(50), 1, 'chap 4.1\n------'
+  let g:vim_markdown_folding_level = 0

 
 Execute (check TOC):
   :Toc
 
 Execute (check TOC):
   :Toc


@@ -123,4 +142,3 @@ Execute (check TOC):
   let elem = res[7]
   AssertEqual elem.lnum, 50
   AssertEqual elem.text, 'chap 4.1'
   let elem = res[7]
   AssertEqual elem.lnum, 50
   AssertEqual elem.text, 'chap 4.1'

-