Merge branch 'master' of https://github.com/mzlogin/vim-markdown-toc

Author: wsdjeg

README.md

@@ -7,6 +7,7 @@ A vim 7.4+ plugin to generate table of contents for Markdown files.
 ## Table of Contents
 
 <!-- vim-markdown-toc GFM -->
+
 * [Features](#features)
 * [Installation](#installation)
 * [Usage](#usage)
@@ -26,6 +27,7 @@ A vim 7.4+ plugin to generate table of contents for Markdown files.
   Supported Markdown parsers:
 
   - [x] GFM (GitHub Flavored Markdown)
+  - [x] GitLab
   - [x] Redcarpet
 
 * Update existing table of contents.
@@ -66,6 +68,12 @@ Move the cursor to the line you want to append table of contents, then type a co
 
     This command is suitable for Jekyll or anywhere else use Redcarpet as its Markdown parser.
 
+3. `:GenTocGitLab`
+
+    Generate table of contents in [GitLab][9] link style.
+
+    This command is suitable for GitLab repository and wiki.
+
 You can view [here][1] to know differences between *GFM* and *Redcarpet* style toc links.
 
 ### Update existing table of contents
@@ -160,3 +168,4 @@ The `:UpdateToc` command, which is designed to update toc manually, can only wor
 [6]: https://github.com/mzlogin/awesome-adb
 [7]: http://mazhuang.org/2015/12/19/vim-markdown-toc/
 [8]: https://github.com/junegunn/vim-plug
+[9]: https://docs.gitlab.com/ee/user/markdown.html

ftplugin/markdown.vim

@@ -147,6 +147,34 @@ function! s:GetHeadingLinkGFM(headingName)
     return l:headingLink
 endfunction
 
+" suppport for GitLab, fork of GetHeadingLinkGFM
+" it's dirty to copy & paste code but more clear for maintain
+function! s:GetHeadingLinkGitLab(headingName)
+    let l:headingLink = tolower(a:headingName)
+
+    let l:headingLink = substitute(l:headingLink, "\\_^_\\+\\|_\\+\\_$", "", "g")
+    let l:headingLink = substitute(l:headingLink, "\\%#=0[^[:alnum:]\u00C0-\u00FF\u4e00-\u9fbf _-]", "", "g")
+    let l:headingLink = substitute(l:headingLink, " ", "-", "g")
+    let l:headingLink = substitute(l:headingLink, "-\\{2,}", "-", "g")
+
+    if l:headingLink ==# ""
+        let l:nullKey = "<null>"
+        if has_key(g:GFMHeadingIds, l:nullKey)
+            let g:GFMHeadingIds[l:nullKey] += 1
+            let l:headingLink = l:headingLink . "-" . g:GFMHeadingIds[l:nullKey]
+        else
+            let g:GFMHeadingIds[l:nullKey] = 0
+        endif
+    elseif has_key(g:GFMHeadingIds, l:headingLink)
+        let g:GFMHeadingIds[l:headingLink] += 1
+        let l:headingLink = l:headingLink . "-" . g:GFMHeadingIds[l:headingLink]
+    else
+        let g:GFMHeadingIds[l:headingLink] = 0
+    endif
+
+    return l:headingLink
+endfunction
+
 function! s:GetHeadingLinkRedcarpet(headingName)
     let l:headingLink = tolower(a:headingName)
 
@@ -177,6 +205,8 @@ function! s:GetHeadingLink(headingName, markdownStyle)
         return <SID>GetHeadingLinkGFM(a:headingName)
     elseif a:markdownStyle ==# "Redcarpet"
         return <SID>GetHeadingLinkRedcarpet(a:headingName)
+    elseif a:markdownStyle ==# "GitLab"
+        return <SID>GetHeadingLinkGitLab(a:headingName)
     endif
 endfunction
 
@@ -322,7 +352,7 @@ function! s:DeleteExistingToc()
 
         if search(l:tocEndPattern, l:flags) != 0
             let l:markdownStyle = matchlist(l:beginLine, l:tocBeginPattern)[1]
-            if l:markdownStyle != "GFM" && l:markdownStyle != "Redcarpet"
+            if l:markdownStyle != "GFM" && l:markdownStyle != "Redcarpet" && l:markdownStyle != "GitLab"
                 let l:markdownStyle = "Unknown"
             else
                 let l:endLineNumber = line(".")
@@ -341,6 +371,7 @@ function! s:DeleteExistingToc()
 endfunction
 
 command! GenTocGFM :call <SID>GenToc("GFM")
+command! GenTocGitLab :call <SID>GenToc("GitLab")
 command! GenTocRedcarpet :call <SID>GenToc("Redcarpet")
 command! UpdateToc :call <SID>UpdateToc()
 command! RemoveToc :call <SID>DeleteExistingToc()

test/test.vim

@@ -40,6 +40,32 @@ call ASSERT(GetHeadingLinkTest("### ![](/path/to/a/png)", "GFM") ==# "-2")
 call ASSERT(GetHeadingLinkTest("### 1.1", "GFM") ==# "11")
 call ASSERT(GetHeadingLinkTest("### heading with some \"special\" \(yes, special\) chars: les caractères unicodes", "GFM") ==# "heading-with-some-special-yes-special-chars-les-caractères-unicodes")
 
+" GitLab Test Cases
+
+let g:GFMHeadingIds = {}
+
+call ASSERT(GetHeadingLinkTest("# 你好！", "GitLab") ==# "你好")
+call ASSERT(GetHeadingLinkTest("## Hello World", "GitLab") ==# "hello-world")
+call ASSERT(GetHeadingLinkTest("### Hello World", "GitLab") ==# "hello-world-1")
+call ASSERT(GetHeadingLinkTest("#### `Hello World`", "GitLab") ==# "hello-world-2")
+call ASSERT(GetHeadingLinkTest("##### _Hello_World_", "GitLab") ==# "hello_world")
+call ASSERT(GetHeadingLinkTest("###### ,", "GitLab") ==# "")
+call ASSERT(GetHeadingLinkTest("# ,", "GitLab") ==# "-1")
+call ASSERT(GetHeadingLinkTest("## No additional spaces before / after punctuation in fullwidth form", "GitLab") ==# "no-additional-spaces-before-after-punctuation-in-fullwidth-form")
+call ASSERT(GetHeadingLinkTest("### No additional spaces before/after punctuation in fullwidth form", "GitLab") ==# "no-additional-spaces-beforeafter-punctuation-in-fullwidth-form")
+call ASSERT(GetHeadingLinkTest("####   Hello    Markdown    ", "GitLab") ==# "hello-markdown")
+call ASSERT(GetHeadingLinkTest("####Heading without a space after the hashes", "GitLab") ==# "heading-without-a-space-after-the-hashes")
+call ASSERT(GetHeadingLinkTest("### heading with trailing hashes ###", "GitLab") ==# "heading-with-trailing-hashes")
+call ASSERT(GetHeadingLinkTest("### heading with trailing hashes###", "GitLab") ==# "heading-with-trailing-hashes-1")
+call ASSERT(GetHeadingLinkTest("### heading with trailing hashes ends with spaces ###  ", "GitLab") ==# "heading-with-trailing-hashes-ends-with-spaces-")
+call ASSERT(GetHeadingLinkTest("### heading with trailing hashes nested with spaces # #  #  ", "GitLab") ==# "heading-with-trailing-hashes-nested-with-spaces-")
+call ASSERT(GetHeadingLinkTest("### [vim-markdown-toc](https://github.com/mzlogin/vim-markdown-toc)", "GitLab") ==# "vim-markdown-toc")
+call ASSERT(GetHeadingLinkTest("### [vim-markdown-toc-again][1]", "GitLab") ==# "vim-markdown-toc-again")
+call ASSERT(GetHeadingLinkTest("### ![vim-markdown-toc-img](/path/to/a/png)", "GitLab") ==# "vim-markdown-toc-img")
+call ASSERT(GetHeadingLinkTest("### ![](/path/to/a/png)", "GitLab") ==# "-2")
+call ASSERT(GetHeadingLinkTest("### 1.1", "GitLab") ==# "11")
+call ASSERT(GetHeadingLinkTest("### heading with some \"special\" \(yes, special\) chars: les caractères unicodes", "GitLab") ==# "heading-with-some-special-yes-special-chars-les-caractères-unicodes")
+
 " Redcarpet Test Cases
 call ASSERT(GetHeadingLinkTest("# -Hello-World-", "Redcarpet") ==# "hello-world")
 call ASSERT(GetHeadingLinkTest("## _Hello_World_", "Redcarpet") ==# "hello_world")