Skip to content
This repository has been archived by the owner on Jul 30, 2021. It is now read-only.
/ coc-jsdoc Public archive

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

License

Notifications You must be signed in to change notification settings

yaegassy/coc-jsdoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

[Experimental] coc-jsdoc

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

coc-jsdoc-demo

[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

Thanks

License

MIT


This extension is built with create-coc-extension