[Experimental] coc-jsdoc

lehre (jsdoc/esdoc/tsdoc document block generator) extension for coc.nvim

[WIP]TODO?

• For "line" and "range" of "Code Actions", automatically detect and process the range of the corresponding symbol block
• There is a pattern of broken indentation in lehre

Install

CocInstall:

TODO

vim-plug:

Plug 'yaegassy/coc-jsdoc', {'do': 'yarn install --frozen-lockfile'}

Note

Quickly generate document block for typescript/javascript.

Configuration options

• jsdoc.enable: Enable coc-jsdoc extension, default: true
• jsdoc.lehrePath: (OPTIONAL) The path to the lehre tool (Absolute path), default: ""
• jsdoc.formatter: Document block formatter (--formatter), valid options ["jsdoc", "esdoc", "tsdoc"], default: "jsdoc"
• jsdoc.enableFileAction: Enable file-level code action, default: false

Code Actions

• Add document block for "Line" by jsdoc
• Add document block for "Range" by jsdoc
• Add document block for "File" by jsdoc
  • File-level code actions are disabled (false) by default.

Commands

• jsdoc.run: Run lehre for file

Similar plugins

• heavenshell/vim-jsdoc
  • This is a vim plugin by the author of lehre.

Thanks

• heavenshell/ts-lehre | lehre

License

MIT

---

This extension is built with create-coc-extension