Git Product home page Git Product logo

coc-jsdoc's Introduction

[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

coc-jsdoc's People

Contributors

yaegassy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

coc-jsdoc's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.