Merge pull request #65 from heavenshell/fix/default_params

Fix/default params

Author: heavenshell

autoload/jsdoc.vim

@@ -1,7 +1,7 @@
 " File: jsdoc.vim
 " Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 " Modifyed: Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:  0.11.1
+" Version:  0.12.0
 " WebPage:  http://github.com/heavenshell/vim-jsdoc/
 " Description: Generate JSDoc to your JavaScript file.
 " License: BSD, see LICENSE for more details.
@@ -133,15 +133,21 @@ function! s:parse_type(args)
 
       let type = s:trim(args[1])
       " Split keywaord args.
+      let default_arg = ''
       if type =~# '='
-        let type = s:trim(split(type, '=')[0])
+        let values = split(type, '=')
+        let type = s:trim(values[0])
+        let default_arg = s:trim(values[1])
+      endif
+      if default_arg != ''
+        " Default keywaord should be `[keyword=default]`.
+        let val = printf('%s=%s', val, default_arg)
       endif
       call add(results, {'val': val, 'type': type})
     else
       call add(results, {'val': s:trim(arg), 'type': ''})
     endif
   endfor
-
   return results
 endfunction
 
@@ -199,7 +205,8 @@ function! s:hookArgs(lines, space, arg, hook, argType, argDescription) abort
       let l:description = a:argDescription !=# ''
             \ ? g:jsdoc_param_description_separator . a:argDescription
             \ : ''
-      call add(a:lines, a:space . ' * @' . g:jsdoc_tags['param'] . ' ' . l:type . a:arg . l:description)
+      let arg = s:parse_keyword_arg(a:arg)
+      call add(a:lines, a:space . ' * @' . g:jsdoc_tags['param'] . ' ' . l:type . arg . l:description)
 
     else
 
@@ -221,7 +228,8 @@ function! s:hookArgs(lines, space, arg, hook, argType, argDescription) abort
       else
         let l:description = g:jsdoc_param_description_separator . a:argDescription
       endif
-      call add(a:lines, a:space . ' * @' . g:jsdoc_tags['param'] . ' ' . l:type . a:arg . l:description)
+      let arg = s:parse_keyword_arg(a:arg)
+      call add(a:lines, a:space . ' * @' . g:jsdoc_tags['param'] . ' ' . l:type . arg . l:description)
 
     endif
 
@@ -309,6 +317,15 @@ function! s:extract_return_type(line)
   return l:return_type
 endfunction
 
+function! s:parse_keyword_arg(arg)
+  let result = a:arg
+  if a:arg =~ '='
+    let result = printf('[%s]', a:arg)
+  endif
+
+  return result
+endfunction
+
 function! jsdoc#insert() abort
   let l:line = getline('.')
   let l:indentCharSpace = ' '

doc/jsdoc.txt

@@ -1,6 +1,6 @@
 *jsdoc.txt*	Generate JSDoc to your JavaScript code.
 
-Version: 0.11.1
+Version: 0.12.0
 Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 Modifyed: Shinya Ohynagi <sohyanagi@gmail.com>
 Repository: http://github.com/heavenshell/vim-jsdoc/
@@ -301,6 +301,11 @@ g:jsdoc_user_defined_tags			*g:jsdoc_user_defined_tags*
 >
 ==============================================================================
 CHANGELOG					*jsdoc-changelog*
+2017-01-28
+- Fix an optional parameter and default value.
+  see https://github.com/heavenshell/vim-jsdoc/issues/64 details.
+  (thx @codeinabox)
+
 2016-10-30
 - Fix missing @param around single function argument.
   see https://github.com/heavenshell/vim-jsdoc/issues/61 details.

ftplugin/javascript/jsdoc.vim

@@ -1,7 +1,7 @@
 " File: jsdoc.vim
 " Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 " Modifyed: Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:  0.11.1
+" Version:  0.12.0
 " WebPage:  http://github.com/heavenshell/vim-jsdoc/
 " Description: Generate JSDoc to your JavaScript file.
 " License: BSD, see LICENSE for more details.

ftplugin/typescript/jsdoc.vim

@@ -1,7 +1,7 @@
 " File: jsdoc.vim
 " Author: NAKAMURA, Hisashi <https://github.com/sunvisor>
 " Modifyed: Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:  0.11.1
+" Version:  0.12.0
 " WebPage:  http://github.com/heavenshell/vim-jsdoc/
 " Description: Generate JSDoc to your JavaScript file.
 " License: BSD, see LICENSE for more details.

test/flow.js

@@ -0,0 +1,23 @@
+// @flow
+function foo(arg1 :string, arg2: number): string {
+  return ''
+}
+
+interface Foo {
+  foo: string
+}
+
+type Bar = {
+  bar: number
+}
+
+class FooBar {
+  props: Bar
+
+  foo (arg1: string, arg2: any): void {
+  }
+
+  bar (arg1: number, arg2: Foo): any {
+    return
+  }
+}

test/test.js

@@ -17,6 +17,8 @@ function namedFunctionDeclaration(_a2, err) { }
 
 function* namedGeneratorFunc(data) { }
 
+function defaultParams(arg, arg1 = 'foo', arg2 = 100) {}
+
 const namespace = {};
 
 namespace.x0 = function (e) { }; // anonymous method

test/test.ts

@@ -14,19 +14,27 @@ function union(): number | string {
 }
 
 interface IFoo {
+  foo?: string
+}
+
+interface InterfaceBar extends IFoo {
 }
 
 class Foo {
 }
 
 class Bar extends Foo implements IFoo {
+  private foo: number
+  bar: string
   constructor(private arg1: string, public arg2: string) {
     super()
   }
   private foo(arg1: string, arg2: number = 0): void {
   }
   public _bar(): void {
   }
+  public baz(arg1: string = 'foo', arg2: number = 100): void {
+  }
 }
 
 class Baz extends Foo implements IFoo {