refactor: rewrite tags and rendering system

.gitignore

@@ -56,6 +56,3 @@ typings/
 
 # dotenv environment variables file
 .env
-
-/example/docs/
-coverage

.travis.yml

@@ -1,22 +1,40 @@
+sudo: false
+dist: trusty
+
 language: node_js
 node_js:
-  - "8"
-  - "7"
   - "6"
+  - "8"
+  - "9"
+  - "10"
+
+cache:
+  yarn: true
+  directories:
+    - node_modules
+    - ~/.cache
 
 before_install:
-  - curl -o- -L https://yarnpkg.com/install.sh | bash
-  - export PATH="$HOME/.yarn/bin:$PATH"
+  - npm i -g yarn
 
 install:
   - yarn
   - cd example && yarn && cd ..
+  - yarn cypress install
 
 before_script:
-  - cd example && yarn docs && cd ..
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+  - cd example
+  - yarn jsdoc -d docs -c jsdoc.json
+  - yarn jsdoc -d docs-docstrap -c jsdoc.json -t ./node_modules/ink-docstrap/template
+  - yarn jsdoc -d docs-minami -c jsdoc.json -t ./node_modules/minami
+  - yarn jsdoc -d docs-tui -c jsdoc.json -t ./node_modules/tui-jsdoc-template
+  - cd ..
 
 script:
   - yarn lint
-  - yarn test
+  - yarn test -i
+  - yarn cypress run --browser chrome --config watchForFileChanges=false
 
 after_success: cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

CHANGELOG.md

@@ -2,10 +2,22 @@
 
 ## 2.0.0
 
+### Features
+
+- Added `@vue-prop` tag (#59)
+- Added `@vue-data` tag (#59)
+- Added `@vue-computed` tag (#59)
+- Added rendering system to support more JSDoc templates (#59)
+
 ### Removals 
 
 - Removed `followImports` config (#53)
 - Removed configuration system (#53)
 - Removed source transformation (Babel) (#55)
 - Removed Vue component script evaluation (#57)
-- Removed hooks listing (#59)
+- Removed Vue lifecycle hooks listing (#59)
+- Removed `@vue` tag (#59)
+
+### Internals
+
+- Use [Cypress](https://cypress.io) for E2E testing (#59)

UPGRADE.md

@@ -31,3 +31,27 @@ because it is not used anymore.
   }
 }
 ```
+
+### Usage
+
+You SHOULD NOT use `@vue` tag anymore. 
+
+Instead, you should use `@vue-prop`, `@vue-data`, and `@vue-computed` like this:
+
+```vue
+<template>
+  <div>Hello world</div>
+</template>
+
+<script>
+/**
+* @vue-prop {Number} initialCounter
+* @vue-prop {Number} [step=1] Step
+* @vue-data {Number} counter - Current counter's value
+* @vue-computed {String} message A message
+*/
+export default {
+  // ...
+}
+</script>
+``` 

__tests__/core/__fixtures__/Component.vue

@@ -0,0 +1,17 @@
+<template>
+  <div>Hello world</div>
+</template>
+
+<script>
+/**
+ * @vue-data {String} [foo=bar] Foo description
+ */
+export default {
+  name: 'Component',
+  data() {
+    return {
+      foo: 'bar'
+    }
+  }
+}
+</script>

__tests__/core/__snapshots__/vueScriptExtractor.js.snap

@@ -0,0 +1,17 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`core.extractVueScript extract script 1`] = `
+"
+/**
+ * @vue-data {String} [foo=bar] Foo description
+ */
+export default {
+  name: 'Component',
+  data() {
+    return {
+      foo: 'bar'
+    }
+  }
+}
+"
+`;

__tests__/core/vueScriptExtractor.js

@@ -0,0 +1,10 @@
+const path = require('path')
+const extractVueScript = require('../../lib/core/vueScriptExtractor')
+
+describe('core.extractVueScript', () => {
+  const filename = path.join(__dirname, '__fixtures__', 'Component.vue')
+
+  test('extract script', () => {
+    expect(extractVueScript(filename)).toMatchSnapshot()
+  })
+})