jsdoc-vuejs-altimewax

JSDoc for VueJS

A wobbly JSDoc plugin for listing props, data, computed data, hooks and methods from *.vue files.

WARNING: Actually, it's only working with the default JSDoc template.

alTimewax

Add a description to Vue component

Installation

$ yarn add jsdoc-vuejs -D
# $ npm i jsdoc-vuejs -D 

Usage

Update your JSDoc configuration

{
  "plugins": [
    "node_modules/jsdoc-vuejs"
  ],
  "source": {
    "includePattern": "\\.(vue|js)$"
  },
  "jsdoc-vuejs": {
    "followImports": true // enable/disable require/import function
  }
}

Update your .vue files:

<template>
  <div>Foo</div>
</template>
 
<script>
  /**
   * Add the @vue tag here
   * @vue
   */
  export default {
    data () {
      return {}
    }
  }
</script>

Tests

Before running tests, you should generate a JSDoc documentation inside example folder:

$ cd example
$ yarn && yarn docs
# $ npm install && npm run docs 
$ $ cd ..

Then run:

$ yarn test
# $ npm test