fix(export): Handle NamedExports of Imports, export * from and export as

Close esdoc#442 Part of esdoc#361
DeltaEvo · May 20, 2018 · 51ce892 · 51ce892
1 parent 38ad523
commit 51ce892
Show file tree

Hide file tree

Showing 15 changed files with 225 additions and 92 deletions.
diff --git a/src/Doc/AbstractDoc.js b/src/Doc/AbstractDoc.js
@@ -4,6 +4,7 @@ import ASTUtil from '../Util/ASTUtil.js';
 import InvalidCodeLogger from '../Util/InvalidCodeLogger.js';
 import ASTNodeContainer from '../Util/ASTNodeContainer.js';
 import babelGenerator from 'babel-generator';
+import {name} from '../Factory/DocFactory';
 
 /**
  * Abstract Doc Class.
@@ -97,9 +98,12 @@ export default class AbstractDoc {
 
   /**
    * decide `name`
-   * @abstract
    */
-  _$name() {}
+  _$name() {
+    if (this._node[name]) {
+      this._value.name = this._node[name]
+    }
+  }
 
   /**
    * decide `memberof`.

diff --git a/src/Doc/AssignmentDoc.js b/src/Doc/AssignmentDoc.js
@@ -17,8 +17,10 @@ export default class AssignmentDoc extends AbstractDoc {
    */
   _$name() {
     super._$name();
-    const name = this._flattenMemberExpression(this._node.left).replace(/^this\./, '');
-    this._value.name = name;
+    if (!this._value.name) {
+      const name = this._flattenMemberExpression(this._node.left).replace(/^this\./, '');
+      this._value.name = name;
+    }
   }
 
   /**

diff --git a/src/Doc/ClassDoc.js b/src/Doc/ClassDoc.js
@@ -28,11 +28,12 @@ export default class ClassDoc extends AbstractDoc {
   /** take out self name from self node */
   _$name() {
     super._$name();
-
-    if (this._node.id) {
-      this._value.name = this._node.id.name;
-    } else {
-      this._value.name = NamingUtil.filePathToName(this._pathResolver.filePath);
+    if (!this._value.name) {
+      if (this._node.id) {
+        this._value.name = this._node.id.name;
+      } else {
+        this._value.name = NamingUtil.filePathToName(this._pathResolver.filePath);
+      }
     }
   }
 

diff --git a/src/Doc/ClassPropertyDoc.js b/src/Doc/ClassPropertyDoc.js
@@ -26,7 +26,9 @@ export default class ClassPropertyDoc extends AbstractDoc {
   /** take out self name from self node */
   _$name() {
     super._$name();
-    this._value.name = this._node.key.name;
+    if (!this._value.name) {
+      this._value.name = this._node.key.name;
+    }
   }
 
   /** borrow {@link MethodDoc#@_memberof} */

diff --git a/src/Doc/ExternalDoc.js b/src/Doc/ExternalDoc.js
@@ -26,27 +26,30 @@ export default class ExternalDoc extends AbstractDoc {
 
   /** take out self name from tag */
   _$name() {
-    const value = this._findTagValue(['@external']);
-    if (!value) {
-      logger.w('can not resolve name.');
-    }
+    super._$name();
+    if (!this._value.name) {
+      const value = this._findTagValue(['@external']);
+      if (!value) {
+        logger.w('can not resolve name.');
+      }
 
-    this._value.name = value;
+      this._value.name = value;
 
-    const tags = this._findAll(['@external']);
-    if (!tags) {
-      logger.w('can not resolve name.');
-      return;
-    }
+      const tags = this._findAll(['@external']);
+      if (!tags) {
+        logger.w('can not resolve name.');
+        return;
+      }
 
-    let name;
-    for (const tag of tags) {
-      const {typeText, paramDesc} = ParamParser.parseParamValue(tag.tagValue, true, false, true);
-      name = typeText;
-      this._value.externalLink = paramDesc;
-    }
+      let name;
+      for (const tag of tags) {
+        const {typeText, paramDesc} = ParamParser.parseParamValue(tag.tagValue, true, false, true);
+        name = typeText;
+        this._value.externalLink = paramDesc;
+      }
 
-    this._value.name = name;
+      this._value.name = name;
+    }
   }
 
   /** take out self memberof from file path. */

diff --git a/src/Doc/FileDoc.js b/src/Doc/FileDoc.js
@@ -26,7 +26,9 @@ export default class FileDoc extends AbstractDoc {
   /** take out self name from file path */
   _$name() {
     super._$name();
-    this._value.name = this._pathResolver.filePath;
+    if (!this._value.name) {
+      this._value.name = this._pathResolver.filePath;
+    }
   }
 
   /** specify name to longname */

diff --git a/src/Doc/FunctionDoc.js b/src/Doc/FunctionDoc.js
@@ -15,17 +15,18 @@ export default class FunctionDoc extends AbstractDoc {
   /** take out self name from self node */
   _$name() {
     super._$name();
-
-    if (this._node.id) {
-      if (this._node.id.type === 'MemberExpression') {
-        // e.g. foo[bar.baz] = function bal(){}
-        const expression = babelGenerator(this._node.id).code;
-        this._value.name = `[${expression}]`;
+    if (!this._value.name) {
+      if (this._node.id) {
+        if (this._node.id.type === 'MemberExpression') {
+          // e.g. foo[bar.baz] = function bal(){}
+          const expression = babelGenerator(this._node.id).code;
+          this._value.name = `[${expression}]`;
+        } else {
+          this._value.name = this._node.id.name;
+        }
       } else {
-        this._value.name = this._node.id.name;
+        this._value.name = NamingUtil.filePathToName(this._pathResolver.filePath);
       }
-    } else {
-      this._value.name = NamingUtil.filePathToName(this._pathResolver.filePath);
     }
   }
 

diff --git a/src/Doc/MemberDoc.js b/src/Doc/MemberDoc.js
@@ -38,14 +38,17 @@ export default class MemberDoc extends AbstractDoc {
 
   /** take out self name from self node */
   _$name() {
-    let name;
-    if (this._node.left.computed) {
-      const expression = babelGenerator(this._node.left.property).code.replace(/^this/, '');
-      name = `[${expression}]`;
-    } else {
-      name = this._flattenMemberExpression(this._node.left).replace(/^this\./, '');
+    super._$name();
+    if (!this._value.name) {
+      let name;
+      if (this._node.left.computed) {
+        const expression = babelGenerator(this._node.left.property).code.replace(/^this/, '');
+        name = `[${expression}]`;
+      } else {
+        name = this._flattenMemberExpression(this._node.left).replace(/^this\./, '');
+      }
+      this._value.name = name;
     }
-    this._value.name = name;
   }
 
   /** borrow {@link MethodDoc#@_memberof} */

diff --git a/src/Doc/MethodDoc.js b/src/Doc/MethodDoc.js
@@ -26,12 +26,13 @@ export default class MethodDoc extends AbstractDoc {
   /** take out self name from self node */
   _$name() {
     super._$name();
-
-    if (this._node.computed) {
-      const expression = babelGenerator(this._node.key).code;
-      this._value.name = `[${expression}]`;
-    } else {
-      this._value.name = this._node.key.name;
+    if (!this._value.name) {
+      if (this._node.computed) {
+        const expression = babelGenerator(this._node.key).code;
+        this._value.name = `[${expression}]`;
+      } else {
+        this._value.name = this._node.key.name;
+      }
     }
   }
 

diff --git a/src/Doc/TypedefDoc.js b/src/Doc/TypedefDoc.js
@@ -28,19 +28,22 @@ export default class TypedefDoc extends AbstractDoc {
 
   /** set name by using tag. */
   _$name() {
-    const tags = this._findAll(['@typedef']);
-    if (!tags) {
-      logger.w('can not resolve name.');
-      return;
-    }
+    super._$name();
+    if (!this._value.name) {
+      const tags = this._findAll(['@typedef']);
+      if (!tags) {
+        logger.w('can not resolve name.');
+        return;
+      }
 
-    let name;
-    for (const tag of tags) {
-      const {paramName} = ParamParser.parseParamValue(tag.tagValue, true, true, false);
-      name = paramName;
-    }
+      let name;
+      for (const tag of tags) {
+        const {paramName} = ParamParser.parseParamValue(tag.tagValue, true, true, false);
+        name = paramName;
+      }
 
-    this._value.name = name;
+      this._value.name = name;
+    }
   }
 
   /** set memberof by using file path. */

diff --git a/src/Doc/VariableDoc.js b/src/Doc/VariableDoc.js
@@ -13,24 +13,25 @@ export default class VariableDoc extends AbstractDoc {
   /** set name by using self node. */
   _$name() {
     super._$name();
-
-    const type = this._node.declarations[0].id.type;
-    switch (type) {
-      case 'Identifier':
-        this._value.name = this._node.declarations[0].id.name;
-        break;
-      case 'ObjectPattern':
-        // TODO: optimize for multi variables.
-        // e.g. export const {a, b} = obj
-        this._value.name = this._node.declarations[0].id.properties[0].key.name;
-        break;
-      case 'ArrayPattern':
-        // TODO: optimize for multi variables.
-        // e.g. export cont [a, b] = arr
-        this._value.name = this._node.declarations[0].id.elements.find(v => v).name;
-        break;
-      default:
-        throw new Error(`unknown declarations type: ${type}`);
+    if (!this._value.name) {
+      const type = this._node.declarations[0].id.type;
+      switch (type) {
+        case 'Identifier':
+          this._value.name = this._node.declarations[0].id.name;
+          break;
+        case 'ObjectPattern':
+          // TODO: optimize for multi variables.
+          // e.g. export const {a, b} = obj
+          this._value.name = this._node.declarations[0].id.properties[0].key.name;
+          break;
+        case 'ArrayPattern':
+          // TODO: optimize for multi variables.
+          // e.g. export cont [a, b] = arr
+          this._value.name = this._node.declarations[0].id.elements.find(v => v).name;
+          break;
+        default:
+          throw new Error(`unknown declarations type: ${type}`);
+      }
     }
   }
 

diff --git a/src/ESDoc.js b/src/ESDoc.js
@@ -187,7 +187,7 @@ export default class ESDoc {
   }
 
   /**
-   * traverse doc comment in JavaScript file.
+   * Get DocFactory for Javascript File.
    * @param {string} inDirPath - root directory path.
    * @param {string} filePath - target JavaScript file path.
    * @param {string} [packageName] - npm package name of target.
@@ -197,7 +197,7 @@ export default class ESDoc {
    * @property {AST} ast - this is AST of JavaScript file.
    * @private
    */
-  static _traverse(inDirPath, filePath, packageName, mainFilePath) {
+  static _getFactory(inDirPath, filePath, packageName, mainFilePath) {
     logger.i(`parsing: ${filePath}`);
     let ast;
     try {
@@ -208,7 +208,25 @@ export default class ESDoc {
     }
 
     const pathResolver = new PathResolver(inDirPath, filePath, packageName, mainFilePath);
-    const factory = new DocFactory(ast, pathResolver);
+    return {
+      factory: new DocFactory(ast, pathResolver, (filePath) => this._getFactory(inDirPath, filePath, packageName, mainFilePath)),
+      ast: ast
+    };
+  }
+
+  /**
+   * traverse doc comment in JavaScript file.
+   * @param {string} inDirPath - root directory path.
+   * @param {string} filePath - target JavaScript file path.
+   * @param {string} [packageName] - npm package name of target.
+   * @param {string} [mainFilePath] - npm main file path of target.
+   * @returns {Object} - return document that is traversed.
+   * @property {DocObject[]} results - this is contained JavaScript file.
+   * @property {AST} ast - this is AST of JavaScript file.
+   * @private
+   */
+  static _traverse(inDirPath, filePath, packageName, mainFilePath) {
+    const {factory, ast} = this._getFactory(inDirPath, filePath, packageName, mainFilePath);
 
     ASTUtil.traverse(ast, (node, parent)=>{
       try {