QingWei-Li / jsdoc-vue

[➡️ https://github.com/Kocal/jsdoc-vuejs] A jsdoc plugin that parses *.vue files.

jsdoc-vue

A jsdoc plugin that parses *.vue files.

Installation

yarn add jsdoc-vue vue-template-compiler --dev
# npm i jsdoc-vue vue-template-compiler -D

Usage

Configuring JSDoc with conf.json

{
  "plugins": ["node_modules/jsdoc-vue"],
  "source": {
    "includePattern": "\\.(vue|js)$"
  }
}

Test

npm test

License

WTFPL