]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Add support for python-mode style folding
authorKit La Touche <kit@simpleenergy.com>
Tue, 12 May 2015 17:17:15 +0000 (11:17 -0600)
committerKit La Touche <klatouche@sensoryinc.com>
Fri, 11 Dec 2015 21:39:18 +0000 (14:39 -0700)
As a python-mode user in my day-to-day work, I would like the folding
styles of vim-markdown and python-mode to match, so that there's less
cognitive overhead in switching between my two most frequently-used
contexts.

To this end, I've made a distinct set of folding logic, keyed off of the
g:vim_markdown_folding_style_pythonic variable, so that using this style
is opt-in.

README.md
after/ftplugin/markdown.vim
test/python-folding.vader [new file with mode: 0644]

index 5ddf6ed6a485612c32ff18fbdeafe64984135927..925fd67a700d8acad6bf26a7646336a360abdd79 100644 (file)
--- a/README.md
+++ b/README.md
@@ -70,6 +70,15 @@ To enable/disable folding use Vim's standard folding configuration.
 set [no]foldenable
 ```
 
 set [no]foldenable
 ```
 
+### Change fold style
+
+To fold in a style like [python-mode](https://github.com/klen/python-mode), add
+the following to your `.vimrc`:
+
+```vim
+let g:vim_markdown_folding_style_pythonic = 1
+```
+
 ### Disable Default Key Mappings
 
 Add the following line to your `.vimrc` to disable default key mappings:
 ### Disable Default Key Mappings
 
 Add the following line to your `.vimrc` to disable default key mappings:
index a140c25a2c2ae9ac128506085a149641d6f0d187..e635f6d1967b06b09248035204f535b896a63165 100644 (file)
@@ -15,38 +15,77 @@ func! s:effective_line(lnum)
     return (line !~ '^[=-#]' || s:is_mkdCode(a:lnum)) ? '' : line
 endfunc
 
     return (line !~ '^[=-#]' || s:is_mkdCode(a:lnum)) ? '' : line
 endfunc
 
-func! Foldexpr_markdown(lnum)
-    let l2 = s:effective_line(a:lnum+1)
-    if  l2 =~ '^==\+\s*'
-        " next line is underlined (level 1)
-        return '>1'
-    elseif l2 =~ '^--\+\s*'
-        " next line is underlined (level 2)
-        return '>2'
-    endif
+if get(g:, "vim_markdown_folding_style_pythonic", 0)
+    func! Foldexpr_markdown(lnum)
+        let l2 = s:effective_line(a:lnum+1)
+        if  l2 =~ '^==\+\s*'
+            " next line is underlined (level 1)
+            return '>0'
+        elseif l2 =~ '^--\+\s*'
+            " next line is underlined (level 2)
+            return '>1'
+        endif
 
 
-    let l1 = s:effective_line(a:lnum)
-    if l1 =~ '^#'
-        " don't include the section title in the fold
-        return '-1'
-    endif
+        let l1 = s:effective_line(a:lnum)
+        if l1 =~ '^#'
+            " current line starts with hashes
+            return '>'.(matchend(l1, '^#\+') - 1)
+        elseif a:lnum == 1
+            " fold any 'preamble'
+            return '>1'
+        else
+            " keep previous foldlevel
+            return '='
+        endif
+    endfunc
 
 
-    if (a:lnum == 1)
-        let l0 = ''
-    else
-        let l0 = s:effective_line(a:lnum-1)
-    endif
-    if l0 =~ '^#'
-        " current line starts with hashes
-        return '>'.matchend(l0, '^#\+')
-    else
-        " keep previous foldlevel
-        return '='
-    endif
-endfunc
+    fun! Foldtext_markdown()
+        let line = getline(v:foldstart)
+        let has_numbers = &number || &relativenumber
+        let nucolwidth = &fdc + has_numbers * &numberwidth
+        let windowwidth = winwidth(0) - nucolwidth - 6
+        let foldedlinecount = v:foldend - v:foldstart
+        let line = strpart(line, 0, windowwidth - 2 -len(foldedlinecount))
+        let line = substitute(line, '\%("""\|''''''\)', '', '')
+        let fillcharcount = windowwidth - len(line) - len(foldedlinecount) + 1
+        return line . ' ' . repeat("-", fillcharcount) . ' ' . foldedlinecount
+    endfunc
+else
+    func! Foldexpr_markdown(lnum)
+        let l2 = s:effective_line(a:lnum+1)
+        if  l2 =~ '^==\+\s*'
+            " next line is underlined (level 1)
+            return '>1'
+        elseif l2 =~ '^--\+\s*'
+            " next line is underlined (level 2)
+            return '>2'
+        endif
+
+        let l1 = s:effective_line(a:lnum)
+        if l1 =~ '^#'
+            " don't include the section title in the fold
+            return '-1'
+        endif
 
 
+        if (a:lnum == 1)
+            let l0 = ''
+        else
+            let l0 = s:effective_line(a:lnum-1)
+        endif
+        if l0 =~ '^#'
+            " current line starts with hashes
+            return '>'.matchend(l0, '^#\+')
+        else
+            " keep previous foldlevel
+            return '='
+        endif
+    endfunc
+endif
 
 if !get(g:, "vim_markdown_folding_disabled", 0)
 
 if !get(g:, "vim_markdown_folding_disabled", 0)
-  setlocal foldexpr=Foldexpr_markdown(v:lnum)
-  setlocal foldmethod=expr
+    setlocal foldexpr=Foldexpr_markdown(v:lnum)
+    setlocal foldmethod=expr
+    if get(g:, "vim_markdown_folding_style_pythonic", 0)
+        setlocal foldtext=Foldtext_markdown()
+    endif
 endif
 endif
diff --git a/test/python-folding.vader b/test/python-folding.vader
new file mode 100644 (file)
index 0000000..55d46de
--- /dev/null
@@ -0,0 +1,39 @@
+Before:
+  let g:vim_markdown_folding_style_pythonic = 1
+  source ../after/ftplugin/markdown.vim
+
+After:
+  setlocal foldexpr=0
+  setlocal foldmethod=manual
+
+Given markdown;
+# Title
+
+## Chapter 1
+
+```
+This is code block
+# This is just a comment
+```
+
+## Chapter 2
+
+foobar
+
+Execute (fold level # in code block):
+  AssertEqual foldlevel(1), 0, '# Title'
+  AssertEqual foldlevel(3), 1, '## Chapter 1'
+  AssertEqual foldlevel(7), 1, '# This is just a comment'
+  AssertEqual foldlevel(8), 1, '```'
+  AssertEqual foldlevel(10), 1, '## Chapter 2'
+  AssertEqual foldlevel(12), 1, 'foobar'
+
+Given markdown;
+
+==+ Fold Level 1
+
+--+ Fold Level 2
+
+Execute (fold level ==+, --+):
+  AssertEqual foldlevel(2), 0, '==+'
+  AssertEqual foldlevel(4), 1, '--+'