chore: AppVeyor integration (#115)

Author: Kocal

.appveyor.yml

@@ -0,0 +1,36 @@
+environment:
+  matrix:
+    - nodejs_version: "8"
+    - nodejs_version: ""
+
+cache:
+  - node_modules
+  - example/node_modules
+  - '%APPDATA%\npm-cache'
+  - '%USERPROFILE%\.npm'
+  - '%USERPROFILE%\.cache'
+
+install:
+  - ps: Install-Product node $env:nodejs_version
+  - npm install -g yarn
+  - yarn install --frozen-lockfile
+  - yarn cypress install
+  - cd example
+  - yarn install --frozen-lockfile
+  - cd ..
+
+build: off
+
+before_test:
+  - cd example
+  - yarn docs
+  - yarn docs:docstrap
+  - yarn docs:minami
+  - yarn docs:tui
+  - cd ..
+
+test_script:
+  - yarn lint
+  - yarn test -i
+  - yarn codecov
+  - yarn cypress run --config watchForFileChanges=false --record

.travis.yml

@@ -11,6 +11,7 @@ cache:
   directories:
     - node_modules
     - example/node_modules
+    - ~/.npm
     - ~/.cache
 
 before_install:
@@ -32,4 +33,4 @@ before_script:
 script:
   - yarn lint
   - yarn test -i && yarn codecov
-  - yarn cypress run --config watchForFileChanges=false --record --key $CYPRESS_KEY
+  - yarn cypress run --config watchForFileChanges=false --record

README.md

@@ -2,8 +2,10 @@ JSDoc for VueJS
 ===============
 
 [![npm version](https://badge.fury.io/js/jsdoc-vuejs.svg)](https://badge.fury.io/js/jsdoc-vuejs)
-[![Build Status](https://travis-ci.org/Kocal/jsdoc-vuejs.svg?branch=master)](https://travis-ci.org/Kocal/jsdoc-vuejs)
+[![Build Status (Travis)](https://travis-ci.org/Kocal/jsdoc-vuejs.svg?branch=master)](https://travis-ci.org/Kocal/jsdoc-vuejs)
+[![Build Status (AppVeyor)](https://ci.appveyor.com/api/projects/status/a36pui6w1qhqq582?svg=true)](https://ci.appveyor.com/project/Kocal/jsdoc-vuejs)
 [![codecov](https://codecov.io/gh/Kocal/jsdoc-vuejs/branch/master/graph/badge.svg)](https://codecov.io/gh/Kocal/jsdoc-vuejs)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/850b7601f2bf4e8787a6aadbafa8afef)](https://www.codacy.com/app/kocal/jsdoc-vuejs?utm_source=github.com&utm_medium=referral&utm_content=Kocal/jsdoc-vuejs&utm_campaign=Badge_Grade)
 
 > A JSDoc plugin for listing props, data, computed data, and methods from *.vue files.
 

__tests__/core/getTemplatePath.test.js

@@ -1,35 +1,35 @@
 /* eslint-disable no-console */
-
+const { normalize } = require('path');
 const getTemplatePath = require('../../lib/core/getTemplatePath');
 
 describe('guessTemplatePath', () => {
   test('guess default', () => {
-    expect(getTemplatePath().endsWith('lib/templates/default.ejs')).toBeTruthy();
-    expect(getTemplatePath('default').endsWith('lib/templates/default.ejs')).toBeTruthy();
+    expect(getTemplatePath().endsWith(normalize('lib/templates/default.ejs'))).toBeTruthy();
+    expect(getTemplatePath('default').endsWith(normalize('lib/templates/default.ejs'))).toBeTruthy();
   });
 
   test('guess docstrap', () => {
     const templatePath = getTemplatePath('./node_modules/ink-docstrap/template');
 
-    expect(templatePath.endsWith('lib/templates/docstrap.ejs')).toBeTruthy();
+    expect(templatePath.endsWith(normalize('lib/templates/docstrap.ejs'))).toBeTruthy();
   });
 
   test('guess minami', () => {
     const templatePath = getTemplatePath('node_modules/minami');
 
-    expect(templatePath.endsWith('lib/templates/minami.ejs')).toBeTruthy();
+    expect(templatePath.endsWith(normalize('lib/templates/minami.ejs'))).toBeTruthy();
   });
 
   test('guess tui', () => {
     const templatePath = getTemplatePath('node_modules/tui-jsdoc-template');
 
-    expect(templatePath.endsWith('lib/templates/tui.ejs')).toBeTruthy();
+    expect(templatePath.endsWith(normalize('lib/templates/tui.ejs'))).toBeTruthy();
   });
 
   test('guess unsupported', () => {
     console.warn = jest.fn();
 
-    expect(getTemplatePath('foo-bar').endsWith('lib/templates/default.ejs')).toBeTruthy();
+    expect(getTemplatePath('foo-bar').endsWith(normalize('lib/templates/default.ejs'))).toBeTruthy();
     expect(console.warn).toHaveBeenCalledWith('The template "foo-bar" is not recognized by jsdoc-vuejs. Using default template as fallback.');
   });
 });

index.js

@@ -1,3 +1,4 @@
+const { join } = require('path');
 const config = require('./config');
 const render = require('./lib/core/renderer');
 const extractVueScript = require('./lib/core/vueScriptExtractor');
@@ -19,7 +20,7 @@ exports.handlers = {
   },
   newDoclet(e) {
     if (e.doclet.meta.filename.endsWith('.vue')) {
-      const fullPath = `${e.doclet.meta.path}/${e.doclet.meta.filename}`;
+      const fullPath = join(e.doclet.meta.path, e.doclet.meta.filename);
       const componentName = e.doclet.meta.filename.replace(/\.vue$/, '');
 
       // The main doclet before `export default {}`

lib/core/getTemplatePath.js

@@ -4,22 +4,24 @@ module.exports = function getTemplatePath(template) {
   // eslint-disable-next-line no-param-reassign
   template = template || 'default';
 
-  const path = (() => {
+  const templateFilename = (() => {
     switch (true) {
       case template === 'default':
-        return `${__dirname}/../templates/default.ejs`;
+        return 'default.ejs';
       case /ink-docstrap\/template/.test(template):
-        return `${__dirname}/../templates/docstrap.ejs`;
+        return 'docstrap.ejs';
       case /minami/.test(template):
-        return `${__dirname}/../templates/minami.ejs`;
+        return 'minami.ejs';
       case /tui-jsdoc-template/.test(template):
-        return `${__dirname}/../templates/tui.ejs`;
+        return 'tui.ejs';
       default:
         // eslint-disable-next-line no-console
         console.warn(`The template "${template}" is not recognized by jsdoc-vuejs. Using default template as fallback.`);
-        return `${__dirname}/../templates/default.ejs`;
+        return 'default.ejs';
     }
   })();
 
+  const path = resolve(__dirname, '../templates', templateFilename);
+
   return resolve(path);
 };