Jsdoc vuejs altimewax

A JSDoc plugin for documenting .vue files.

Version: 1.0.3 Updated: 06/08/2018

By: alTimewax License: GPL-3.0

Downloads Last 30 Days: 28

Install

npm i jsdoc-vuejs-altimewax
yarn add jsdoc-vuejs-altimewax

Repository: https://github.com/alTimewax/jsdoc-vuejs

CDNs

bundle.run: https://bundle.run/jsdoc-vuejs-altimewax

jsDelivr: https://cdn.jsdelivr.net/npm/jsdoc-vuejs-altimewax

unpkg: https://unpkg.com/jsdoc-vuejs-altimewax

JSDoc for VueJS

npm version Build Status Coverage Status

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
Categories: Vue js