Added Vue support, waiting for a test and dependencies

batje · batje · commit 9f1abb64d98d · 2018-04-20T16:39:42.000+02:00
diff --git a/__tests__/fixture/simple.input.vue b/__tests__/fixture/simple.input.vue
@@ -0,0 +1,30 @@
+<template>
+  <div>not relevant</div>
+</template>
+
+<script>
+
+/**
+ * This Vue Component is a test
+ * @returns {vue-tested} vue-tested component
+ */
+export default {
+
+props: {
+
+  /**
+   * This is a number
+   *
+   *  @property
+   */
+  myNumber: {
+    default: 42,
+    type: Number
+  }
+}
+}
+</script>
+
+<style>
+
+</style>
diff --git a/src/index.js b/src/index.js
@@ -6,6 +6,7 @@ const filterAccess = require('./filter_access');
 const dependency = require('./input/dependency');
 const shallow = require('./input/shallow');
 const parseJavaScript = require('./parsers/javascript');
+const parseVueScript = require('./parsers/vue');
 const github = require('./github');
 const hierarchy = require('./hierarchy');
 const inferName = require('./infer/name');
@@ -102,8 +103,13 @@ function buildInternal(inputsAndConfig) {
     if (!sourceFile.source) {
       sourceFile.source = fs.readFileSync(sourceFile.file, 'utf8');
     }
+    var extension = sourceFile.file.substr(sourceFile.file.length - 4);
 
-    return parseJavaScript(sourceFile, config).map(buildPipeline);
+    if (extension === '.vue') {
+      return parseVueScript(sourceFile, config).map(buildPipeline);
+    } else {
+      return parseJavaScript(sourceFile, config).map(buildPipeline);
+    }
   }).filter(Boolean);
 
   return filterAccess(
diff --git a/src/merge_config.js b/src/merge_config.js
@@ -88,7 +88,8 @@ function mergeConfig(config: Object): Promise<DocumentationConfig> {
     'js',
     'jsx',
     'es5',
-    'es6'
+    'es6',
+    'vue'
   ]);
 
   return mergeConfigFile(config).then(mergePackage);
diff --git a/src/parsers/vue.js b/src/parsers/vue.js
@@ -0,0 +1,135 @@
+/* @flow */
+
+const _ = require('lodash');
+const t = require('babel-types');
+const parse = require('../parse');
+const walkComments = require('../extractors/comments');
+const walkExported = require('../extractors/exported');
+const util = require('util');
+const debuglog = util.debuglog('documentation');
+const findTarget = require('../infer/finders').findTarget;
+const vuecompiler = require('vue-template-compiler');
+
+import { parseToAst } from './parse_to_ast';
+
+/**
+ * Left-pad a string so that it can be sorted lexicographically. We sort
+ * comments to keep them in order.
+ * @param {string} str the string
+ * @param {number} width the width to pad to
+ * @returns {string} a padded string with the correct width
+ * @private
+ */
+function leftPad(str, width) {
+  str = str.toString();
+  while (str.length < width) {
+    str = '0' + str;
+  }
+  return str;
+}
+
+/**
+ * Receives a module-dep item,
+ * reads the file, parses the JavaScript, and parses the JSDoc.
+ *
+ * @param {Object} data a chunk of data provided by module-deps
+ * @param {Object} config config
+ * @returns {Array<Object>} an array of parsed comments
+ */
+function parseJavaScript(data: Object, config: DocumentationConfig) {
+  const visited = new Set();
+  const commentsByNode = new Map();
+
+  const component = vuecompiler.parseComponent(data.source);
+
+  const ast = parseToAst(component.script.content);
+  const addComment = _addComment.bind(null, visited, commentsByNode);
+
+  return _.flatMap(
+    config.documentExported
+      ? [walkExported]
+      : [
+          walkComments.bind(null, 'leadingComments', true),
+          walkComments.bind(null, 'innerComments', false),
+          walkComments.bind(null, 'trailingComments', false)
+        ],
+    fn => fn(ast, data, addComment)
+  ).filter(comment => comment && !comment.lends);
+}
+
+function _addComment(
+  visited,
+  commentsByNode,
+  data,
+  commentValue,
+  commentLoc,
+  path,
+  nodeLoc,
+  includeContext
+) {
+  // Avoid visiting the same comment twice as a leading
+  // and trailing node
+  const key =
+    data.file + ':' + commentLoc.start.line + ':' + commentLoc.start.column;
+  if (!visited.has(key)) {
+    visited.add(key);
+
+    const context /* : {
+      loc: Object,
+      file: string,
+      sortKey: string,
+      ast?: Object,
+      code?: string
+    }*/ = {
+      loc: nodeLoc,
+      file: data.file,
+      sortKey: data.sortKey + ' ' + leftPad(nodeLoc.start.line, 8)
+    };
+
+    if (includeContext) {
+      // This is non-enumerable so that it doesn't get stringified in
+      // output; e.g. by the documentation binary.
+      Object.defineProperty(context, 'ast', {
+        configurable: true,
+        enumerable: false,
+        value: path
+      });
+
+      if (path.parentPath && path.parentPath.node) {
+        const parentNode = path.parentPath.node;
+        context.code = data.source.substring(parentNode.start, parentNode.end);
+      }
+    }
+    const comment = parse(commentValue, commentLoc, context);
+    if (includeContext) {
+      commentsByNode.set((findTarget(path) || path).node, comment);
+
+      if (t.isClassMethod(path) && path.node.kind === 'constructor') {
+        // #689
+        if (
+          comment.tags.some(
+            tag => tag.title !== 'param' && tag.title !== 'hideconstructor'
+          )
+        ) {
+          debuglog(
+            'A constructor was documented explicitly: document along with the class instead'
+          );
+        }
+
+        const parentComment = commentsByNode.get(
+          path.parentPath.parentPath.node
+        );
+        if (parentComment) {
+          parentComment.constructorComment = comment;
+          return;
+        }
+        if (comment.hideconstructor) {
+          return;
+        }
+      }
+    }
+    return comment;
+  }
+}
+
+module.exports = parseJavaScript;

-Original file line number
+Diff line change
     'js',
     'jsx',
     'es5',
 -    'es6'
 +    'es6',
 +    'vue'
   ]);
   return mergeConfigFile(config).then(mergePackage);