fix(#66): Remove returnType when the type is void

kkoomen · Dec 1, 2019 · 25c64d1 · 25c64d1
1 parent 4fa2c09
commit 25c64d1
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 11 deletions.
diff --git a/autoload/doge/preprocessors/javascript.vim b/autoload/doge/preprocessors/javascript.vim
@@ -0,0 +1,17 @@
+let s:save_cpo = &cpoptions
+set cpoptions&vim
+
+" A callback function being called after the tokens have been extracted. This
+" function will adjust the input if needed.
+function! doge#preprocessors#javascript#tokens(tokens) abort
+  if has_key(a:tokens, 'returnType')
+    if a:tokens['returnType'] ==# 'void'
+      let a:tokens['returnType'] = ''
+    elseif a:tokens['returnType'] ==# ''
+      let a:tokens['returnType'] = '!type'
+    endif
+  endif
+endfunction
+
+let &cpoptions = s:save_cpo
+unlet s:save_cpo
diff --git a/autoload/doge/preprocessors/typescript.vim b/autoload/doge/preprocessors/typescript.vim
@@ -0,0 +1,17 @@
+let s:save_cpo = &cpoptions
+set cpoptions&vim
+
+" A callback function being called after the tokens have been extracted. This
+" function will adjust the input if needed.
+function! doge#preprocessors#typescript#tokens(tokens) abort
+  if has_key(a:tokens, 'returnType')
+    if a:tokens['returnType'] ==# 'void'
+      let a:tokens['returnType'] = ''
+    elseif a:tokens['returnType'] ==# ''
+      let a:tokens['returnType'] = '!type'
+    endif
+  endif
+endfunction
+
+let &cpoptions = s:save_cpo
+unlet s:save_cpo
diff --git a/ftplugin/javascript.vim b/ftplugin/javascript.vim
@@ -58,7 +58,7 @@ call add(b:doge_patterns, {
 \        '%(async| * @{async})%',
 \        ' * @function {funcName|}',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },
@@ -131,7 +131,7 @@ call add(b:doge_patterns, {
 \        '%(static| * @static)%',
 \        '%(async| * @async)%',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },
@@ -169,7 +169,7 @@ call add(b:doge_patterns, {
 \        '%(async| * @async)%',
 \        ' * @function {className}#{funcName}',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },
@@ -224,7 +224,7 @@ call add(b:doge_patterns, {
 \        '%(async| * @async)%',
 \        ' * @function {funcName|}',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },

diff --git a/ftplugin/typescript.vim b/ftplugin/typescript.vim
@@ -61,7 +61,7 @@ call add(b:doge_patterns, {
 \        '%(async| * @{async})%',
 \        ' * @function {funcName|}',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },
@@ -90,7 +90,6 @@ call add(b:doge_patterns, {
 \      'jsdoc': [
 \        '/**',
 \        ' * !description',
-\        ' *',
 \        '%(parentClassName| * @extends {parentClassName})%',
 \        '%(interfaceName| * @implements {interfaceName})%',
 \        ' */',
@@ -135,7 +134,7 @@ call add(b:doge_patterns, {
 \        '%(static| * @static)%',
 \        '%(async| * @async)%',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },
@@ -173,7 +172,7 @@ call add(b:doge_patterns, {
 \        '%(async| * @async)%',
 \        ' * @function {className}#{funcName}',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },
@@ -228,7 +227,7 @@ call add(b:doge_patterns, {
 \        '%(async| * @async)%',
 \        ' * @function {funcName|}',
 \        '%(parameters| * {parameters})%',
-\        ' * @return {{returnType|!type}} !description',
+\        '%(returnType| * @return {{returnType|!type}} !description)%',
 \        ' */',
 \      ],
 \    },

diff --git a/playground/test.js b/playground/test.js
@@ -562,7 +562,6 @@ class Child extends Parent {
    *
    * @param {number} arg0 - [TODO:description]
    * @param {string} arg1 - [TODO:description]
-   * @return {void} [TODO:description]
    */
   public funcA(arg0: number, arg1?: string): void {
 

diff --git a/test/filetypes/javascript/functions.vader b/test/filetypes/javascript/functions.vader
@@ -244,7 +244,6 @@ Expect javascript (generated comment with a description, @param and @return tags
      * [TODO:description]
      *
      * @param {string} something - [TODO:description]
-     * @return {void} [TODO:description]
      */
     public printSomething(something?: string): void {}