Infer class kind from es6 class

Author: tmcw

lib/hierarchy.js

@@ -44,7 +44,7 @@ module.exports = function (comments) {
         scope = segment[0],
         name = segment[1];
 
-      if (!node.members[scope][name]) {
+      if (!node.members[scope].hasOwnProperty(name)) {
         node.members[scope][name] = {
           comments: [],
           members: {

lib/infer/kind.js

@@ -28,6 +28,10 @@ module.exports = function () {
     }
 
     types.visit(comment.context.ast, {
+      visitClassDeclaration: function () {
+        comment.kind = 'class';
+        this.abort();
+      },
       visitFunction: function (path) {
         if (path.value && path.value.id && path.value.id.name && !!/^[A-Z]/.exec(path.value.id.name)) {
           comment.kind = 'class';

lib/infer/membership.js

@@ -99,10 +99,12 @@ module.exports = function () {
    *
    * @param {Object} comment comment for which to infer memberships
    * @param {Array<string>} identifiers array of identifier names
+   * @param {string} explicitScope if derived from an es6 class, whether or
+   * not this method had the static keyword
    * @returns {undefined} mutates `comment`
    * @private
    */
-  function inferMembershipFromIdentifiers(comment, identifiers) {
+  function inferMembershipFromIdentifiers(comment, identifiers, explicitScope) {
     if (identifiers.length === 1 && identifiers[0] === 'module' && comment.name === 'exports') {
       comment.name = inferModuleName(currentModule || comment);
       return;
@@ -123,7 +125,11 @@ module.exports = function () {
       comment.scope = 'instance';
     } else {
       comment.memberof = identifiers.join('.');
-      comment.scope = 'static';
+      if (explicitScope !== undefined) {
+        comment.scope = explicitScope;
+      } else {
+        comment.scope = 'static';
+      }
     }
   }
 
@@ -206,6 +212,18 @@ module.exports = function () {
       inferMembershipFromIdentifiers(comment, identifiers);
     }
 
+    // class Foo { bar() { } }
+    if (n.MethodDefinition.check(path.node) &&
+        n.ClassBody.check(path.parent.node) &&
+        n.ClassDeclaration.check(path.parent.parent.node)) {
+      identifiers = [path.parent.parent.node.id.name];
+      var scope = 'instance';
+      if (path.node.static == true) {
+        scope = 'static';
+      }
+      inferMembershipFromIdentifiers(comment, identifiers, scope);
+    }
+
     return comment;
   };
 }

test/fixture/bad/syntax.output.json

@@ -6,4 +6,4 @@
   },
   "_babel": true,
   "codeFrame": "> 1 | *\n    | ^\n  2 | "
-}
+}

test/fixture/es6-import.output.custom.md

@@ -1,3 +1,37 @@
+# Sink
+
+This is a sink
+
+
+## constructor
+
+
+
+
+**Parameters**
+
+-   `height` **number** the height of the thing
+
+-   `width` **number** the width of the thing
+
+
+
+
+## empty
+
+Is it empty
+
+
+
+
+## hello
+
+This method says hello
+
+
+
+
+
 # multiply
 
 This function returns the number one.

test/fixture/es6-import.output.json

@@ -1,4 +1,206 @@
 [
+  {
+    "description": "This is a sink",
+    "tags": [],
+    "loc": {
+      "start": {
+        "line": 7,
+        "column": 0
+      },
+      "end": {
+        "line": 9,
+        "column": 3
+      }
+    },
+    "context": {
+      "loc": {
+        "start": {
+          "line": 10,
+          "column": 0
+        },
+        "end": {
+          "line": 33,
+          "column": 1
+        }
+      },
+      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nvar multiply = (a, b) => a * b;\n\n/**\n * This is a sink\n */\nclass Sink {\n  /**\n   * Is it empty\n   */\n  empty() {\n    return 1;\n  }\n\n  /**\n   * This method says hello\n   */\n  static hello() {\n    return 'hello';\n  }\n\n  /**\n   * @param {number} height the height of the thing\n   * @param {number} width the width of the thing\n   */\n  constructor(height, width) {\n    this.height = height;\n    this.width = width;\n  }\n}\n\nexport default multiply;\n"
+    },
+    "errors": [],
+    "name": "Sink",
+    "kind": "class",
+    "members": {
+      "instance": [
+        {
+          "description": "",
+          "tags": [
+            {
+              "title": "param",
+              "description": "the height of the thing",
+              "lineNumber": 1,
+              "type": {
+                "type": "NameExpression",
+                "name": "number"
+              },
+              "name": "height"
+            },
+            {
+              "title": "param",
+              "description": "the width of the thing",
+              "lineNumber": 2,
+              "type": {
+                "type": "NameExpression",
+                "name": "number"
+              },
+              "name": "width"
+            }
+          ],
+          "loc": {
+            "start": {
+              "line": 25,
+              "column": 2
+            },
+            "end": {
+              "line": 28,
+              "column": 5
+            }
+          },
+          "context": {
+            "loc": {
+              "start": {
+                "line": 29,
+                "column": 2
+              },
+              "end": {
+                "line": 32,
+                "column": 3
+              }
+            },
+            "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nvar multiply = (a, b) => a * b;\n\n/**\n * This is a sink\n */\nclass Sink {\n  /**\n   * Is it empty\n   */\n  empty() {\n    return 1;\n  }\n\n  /**\n   * This method says hello\n   */\n  static hello() {\n    return 'hello';\n  }\n\n  /**\n   * @param {number} height the height of the thing\n   * @param {number} width the width of the thing\n   */\n  constructor(height, width) {\n    this.height = height;\n    this.width = width;\n  }\n}\n\nexport default multiply;\n"
+          },
+          "errors": [],
+          "params": [
+            {
+              "title": "param",
+              "description": "the height of the thing",
+              "lineNumber": 1,
+              "type": {
+                "type": "NameExpression",
+                "name": "number"
+              },
+              "name": "height"
+            },
+            {
+              "title": "param",
+              "description": "the width of the thing",
+              "lineNumber": 2,
+              "type": {
+                "type": "NameExpression",
+                "name": "number"
+              },
+              "name": "width"
+            }
+          ],
+          "name": "constructor",
+          "kind": "function",
+          "memberof": "Sink",
+          "scope": "instance",
+          "members": {
+            "instance": [],
+            "static": []
+          },
+          "path": [
+            "Sink",
+            "constructor"
+          ]
+        },
+        {
+          "description": "Is it empty",
+          "tags": [],
+          "loc": {
+            "start": {
+              "line": 11,
+              "column": 2
+            },
+            "end": {
+              "line": 13,
+              "column": 5
+            }
+          },
+          "context": {
+            "loc": {
+              "start": {
+                "line": 14,
+                "column": 2
+              },
+              "end": {
+                "line": 16,
+                "column": 3
+              }
+            },
+            "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nvar multiply = (a, b) => a * b;\n\n/**\n * This is a sink\n */\nclass Sink {\n  /**\n   * Is it empty\n   */\n  empty() {\n    return 1;\n  }\n\n  /**\n   * This method says hello\n   */\n  static hello() {\n    return 'hello';\n  }\n\n  /**\n   * @param {number} height the height of the thing\n   * @param {number} width the width of the thing\n   */\n  constructor(height, width) {\n    this.height = height;\n    this.width = width;\n  }\n}\n\nexport default multiply;\n"
+          },
+          "errors": [],
+          "name": "empty",
+          "kind": "function",
+          "memberof": "Sink",
+          "scope": "instance",
+          "members": {
+            "instance": [],
+            "static": []
+          },
+          "path": [
+            "Sink",
+            "empty"
+          ]
+        }
+      ],
+      "static": [
+        {
+          "description": "This method says hello",
+          "tags": [],
+          "loc": {
+            "start": {
+              "line": 18,
+              "column": 2
+            },
+            "end": {
+              "line": 20,
+              "column": 5
+            }
+          },
+          "context": {
+            "loc": {
+              "start": {
+                "line": 21,
+                "column": 2
+              },
+              "end": {
+                "line": 23,
+                "column": 3
+              }
+            },
+            "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nvar multiply = (a, b) => a * b;\n\n/**\n * This is a sink\n */\nclass Sink {\n  /**\n   * Is it empty\n   */\n  empty() {\n    return 1;\n  }\n\n  /**\n   * This method says hello\n   */\n  static hello() {\n    return 'hello';\n  }\n\n  /**\n   * @param {number} height the height of the thing\n   * @param {number} width the width of the thing\n   */\n  constructor(height, width) {\n    this.height = height;\n    this.width = width;\n  }\n}\n\nexport default multiply;\n"
+          },
+          "errors": [],
+          "name": "hello",
+          "kind": "function",
+          "memberof": "Sink",
+          "scope": "static",
+          "members": {
+            "instance": [],
+            "static": []
+          },
+          "path": [
+            "Sink",
+            "hello"
+          ]
+        }
+      ]
+    },
+    "path": [
+      "Sink"
+    ]
+  },
   {
     "description": "This function returns the number one.",
     "tags": [
@@ -33,7 +235,7 @@
           "column": 31
         }
       },
-      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nvar multiply = (a, b) => a * b;\n\nexport default multiply;\n"
+      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nvar multiply = (a, b) => a * b;\n\n/**\n * This is a sink\n */\nclass Sink {\n  /**\n   * Is it empty\n   */\n  empty() {\n    return 1;\n  }\n\n  /**\n   * This method says hello\n   */\n  static hello() {\n    return 'hello';\n  }\n\n  /**\n   * @param {number} height the height of the thing\n   * @param {number} width the width of the thing\n   */\n  constructor(height, width) {\n    this.height = height;\n    this.width = width;\n  }\n}\n\nexport default multiply;\n"
     },
     "errors": [],
     "returns": [

test/fixture/es6-import.output.md

@@ -1,3 +1,37 @@
+# Sink
+
+This is a sink
+
+
+## constructor
+
+
+
+
+**Parameters**
+
+-   `height` **number** the height of the thing
+
+-   `width` **number** the width of the thing
+
+
+
+
+## empty
+
+Is it empty
+
+
+
+
+## hello
+
+This method says hello
+
+
+
+
+
 # multiply
 
 This function returns the number one.