Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jsdoc.vim v2.0.0 #81

Closed
heavenshell opened this issue Apr 18, 2020 · 3 comments
Closed

jsdoc.vim v2.0.0 #81

heavenshell opened this issue Apr 18, 2020 · 3 comments

Comments

@heavenshell
Copy link
Owner

Hello, jsdoc.vim users.
I'm sorry for long time no update and response.

I'm currently working on jsdoc.vim v2.0.0

What's new

  • Complete re-write
  • Can handle complex params

For example.

const foo = (arg1: (arg1: { foo: string, bar: number }) => string, arg2: number) => {}

will generate like following.

/**
 * foo.
 *
 * @param {Function} arg1
 * @param {number} arg2
 */
const foo = (arg1: (arg1: { foo: string, bar: number }) => string, arg2: number) => {}
  • You can choose document block template from JSDoc, ESDoc, TSDoc and your own customaized template

Deprecate

v2.0.0 will Deprecate all g:jsdoc_* variables.
interactive mode is also deprecate but you can use snippet plugin and custmaized template to insert document interactive.

Current version is too much global variables.
v2.x will be less global variables.

Support Vim version

First release of v2.0.0 will only support Vim8.
I know some of user use Neovim, but I don't have Neovim env and knowledges.
So after release v2.0.0, If you want to use in Neovim, please send me PR.

Release date

TBA. Hopefully I will release in near future.

Stay safe and take care.

Kapture 2020-04-18 at 17 45 46

@heavenshell
Copy link
Owner Author

#82

@glepnir
Copy link

glepnir commented May 16, 2020

why not support neovim? ..Hope can support it.

@heavenshell
Copy link
Owner Author

@glepnir
Thx for comment.
Because I don't have any Neovim env and knowledge.
PRs are welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants