Babel! 🙌

cc @jfirebaugh for the review

This was easier than expected.

Author: tmcw

lib/is_jsdoc_comment.js

@@ -14,5 +14,7 @@
  */
 module.exports = function isJSDocComment(comment) {
   var asterisks = comment.value.match(/^(\*+)/);
-  return comment.type === 'Block' && asterisks && asterisks[ 1 ].length === 1;
+  return (comment.type === 'CommentBlock' || // estree
+    comment.type === 'Block') // get-comments / traditional
+    && asterisks && asterisks[ 1 ].length === 1;
 };

lib/parsers/javascript.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var espree = require('espree'),
+var babel = require('babel'),
   types = require('ast-types'),
   extend = require('extend'),
   isJSDocComment = require('../../lib/is_jsdoc_comment'),
@@ -19,58 +19,6 @@ function commentShebang(code) {
   return (code[0] === '#' && code[1] === '!') ? '//' + code : code;
 }
 
-var espreeConfig = {
-  loc: true,
-  attachComment: true,
-  // specify parsing features (default only has blockBindings: true)
-  ecmaFeatures: {
-    // enable parsing of arrow functions
-    arrowFunctions: true,
-    // enable parsing of let/const
-    blockBindings: true,
-    // enable parsing of destructured arrays and objects
-    destructuring: true,
-    // enable parsing of regular expression y flag
-    regexYFlag: true,
-    // enable parsing of regular expression u flag
-    regexUFlag: true,
-    // enable parsing of template strings
-    templateStrings: true,
-    // enable parsing of binary literals
-    binaryLiterals: true,
-    // enable parsing of ES6 octal literals
-    octalLiterals: true,
-    // enable parsing unicode code point escape sequences
-    unicodeCodePointEscapes: true,
-    // enable parsing of default parameters
-    defaultParams: true,
-    // enable parsing of rest parameters
-    restParams: true,
-    // enable parsing of for-of statement
-    forOf: true,
-    // enable parsing computed object literal properties
-    objectLiteralComputedProperties: true,
-    // enable parsing of shorthand object literal methods
-    objectLiteralShorthandMethods: true,
-    // enable parsing of shorthand object literal properties
-    objectLiteralShorthandProperties: true,
-    // Allow duplicate object literal properties (except '__proto__')
-    objectLiteralDuplicateProperties: true,
-    // enable parsing of generators/yield
-    generators: true,
-    // enable parsing spread operator
-    spread: true,
-    // enable parsing classes
-    classes: true,
-    // enable parsing of modules
-    modules: true,
-    // enable React JSX parsing
-    jsx: true,
-    // enable return in global scope
-    globalReturn: true
-  }
-};
-
 /**
  * Receives a module-dep item,
  * reads the file, parses the JavaScript, and parses the JSDoc.
@@ -82,7 +30,7 @@ var espreeConfig = {
 module.exports = function (data) {
   var results = [];
   var code = commentShebang(data.source),
-    ast = espree.parse(code, espreeConfig);
+    ast = babel.parse(code);
 
   var visited = {};
 
@@ -139,6 +87,7 @@ module.exports = function (data) {
   }
 
   walkComments(ast, 'leadingComments', true);
+  walkComments(ast, 'innerComments', false);
   walkComments(ast, 'trailingComments', false);
 
   return results;

package.json

@@ -16,11 +16,11 @@
   },
   "dependencies": {
     "ast-types": "^0.8.12",
+    "babel": "^5.8.23",
     "brfs": "^1.4.0",
     "concat-stream": "^1.5.0",
     "doctrine": "^0.6.4",
     "documentation-theme-default": "^1.0.0-alpha2",
-    "espree": "^2.0.3",
     "extend": "^3.0.0",
     "get-comments": "^1.0.1",
     "github-url-from-git": "^1.4.0",

test/fixture/_external-deps-included.json

@@ -33,7 +33,7 @@
           "column": 2
         }
       },
-      "code": "module.exports = function () {\n  // this returns 1\n  return 1;\n};"
+      "code": "/**\n * This function returns the number one.\n * @return {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
     },
     "errors": [
       "memberof reference to module not found"
@@ -96,7 +96,7 @@
           "column": 2
         }
       },
-      "code": "'use strict';\n\nvar otherDep = require('external2');\n\n/**\n * This function returns the number one.\n * @return {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return otherDep() - 1;\n};"
+      "code": "'use strict';\n\nvar otherDep = require('external2');\n\n/**\n * This function returns the number one.\n * @return {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return otherDep() - 1;\n};\n"
     },
     "errors": [
       "memberof reference to module not found"
@@ -149,7 +149,7 @@
           "column": 1
         }
       },
-      "code": "require('external');\nrequire('external2');\nrequire('module-not-found');\n\n/**\n * I am in `external.input.js`.\n */\nfunction foo() {\n  'use strict';\n  return 'bar';\n}\n\nmodule.exports = foo;"
+      "code": "require('external');\nrequire('external2');\nrequire('module-not-found');\n\n/**\n * I am in `external.input.js`.\n */\nfunction foo() {\n  'use strict';\n  return 'bar';\n}\n\nmodule.exports = foo;\n"
     },
     "errors": [],
     "name": "foo",

test/fixture/_multi-file-input.json

@@ -33,7 +33,7 @@
           "column": 2
         }
       },
-      "code": "module.exports = function () {\n  // this returns 1\n  return 1;\n};"
+      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
     },
     "errors": [
       "memberof reference to module not found"
@@ -111,7 +111,7 @@
           "column": 1
         }
       },
-      "code": "function returnTwo(a) {\n  // this returns a + 2\n  return a + 2;\n}"
+      "code": "/**\n * This function returns the number plus two.\n *\n * @param {Number} a the number\n * @returns {Number} numbertwo\n * @example\n * var result = returnTwo(4);\n * // result is 6\n */\nfunction returnTwo(a) {\n  // this returns a + 2\n  return a + 2;\n}\n"
     },
     "errors": [
       "type Number found, number is standard"

test/fixture/bad/syntax.output.json

@@ -1,6 +1,7 @@
 {
-  "index": 0,
-  "lineNumber": 1,
-  "column": 1,
-  "description": "Unexpected token *"
+  "pos": 0,
+  "loc": {
+    "line": 1,
+    "column": 0
+  }
 }

test/fixture/class.output.json

@@ -41,7 +41,7 @@
           "column": 1
         }
       },
-      "code": "function MyClass() {\n  this.howMany = 2;\n}\n\n/**\n * Get the number 42\n * @param {boolean} getIt whether to get the number\n * @returns {number} forty-two\n */\nMyClass.prototype.getFoo = function (getIt) {\n  return getIt ? 42 : 0;\n};\n\n/**\n * Get undefined\n * @returns {undefined} does not return anything.\n */\nMyClass.prototype.getUndefined = function () { };"
+      "code": "/**\n * This is my class, a demo thing.\n * @class MyClass\n * @property {number} howMany how many things it contains\n */\nfunction MyClass() {\n  this.howMany = 2;\n}\n\n/**\n * Get the number 42\n * @param {boolean} getIt whether to get the number\n * @returns {number} forty-two\n */\nMyClass.prototype.getFoo = function (getIt) {\n  return getIt ? 42 : 0;\n};\n\n/**\n * Get undefined\n * @returns {undefined} does not return anything.\n */\nMyClass.prototype.getUndefined = function () { };\n"
     },
     "errors": [],
     "class": {
@@ -107,7 +107,7 @@
                 "column": 2
               }
             },
-            "code": "function MyClass() {\n  this.howMany = 2;\n}\n\n/**\n * Get the number 42\n * @param {boolean} getIt whether to get the number\n * @returns {number} forty-two\n */\nMyClass.prototype.getFoo = function (getIt) {\n  return getIt ? 42 : 0;\n};\n\n/**\n * Get undefined\n * @returns {undefined} does not return anything.\n */\nMyClass.prototype.getUndefined = function () { };"
+            "code": "/**\n * This is my class, a demo thing.\n * @class MyClass\n * @property {number} howMany how many things it contains\n */\nfunction MyClass() {\n  this.howMany = 2;\n}\n\n/**\n * Get the number 42\n * @param {boolean} getIt whether to get the number\n * @returns {number} forty-two\n */\nMyClass.prototype.getFoo = function (getIt) {\n  return getIt ? 42 : 0;\n};\n\n/**\n * Get undefined\n * @returns {undefined} does not return anything.\n */\nMyClass.prototype.getUndefined = function () { };\n"
           },
           "errors": [],
           "params": [
@@ -180,7 +180,7 @@
                 "column": 49
               }
             },
-            "code": "function MyClass() {\n  this.howMany = 2;\n}\n\n/**\n * Get the number 42\n * @param {boolean} getIt whether to get the number\n * @returns {number} forty-two\n */\nMyClass.prototype.getFoo = function (getIt) {\n  return getIt ? 42 : 0;\n};\n\n/**\n * Get undefined\n * @returns {undefined} does not return anything.\n */\nMyClass.prototype.getUndefined = function () { };"
+            "code": "/**\n * This is my class, a demo thing.\n * @class MyClass\n * @property {number} howMany how many things it contains\n */\nfunction MyClass() {\n  this.howMany = 2;\n}\n\n/**\n * Get the number 42\n * @param {boolean} getIt whether to get the number\n * @returns {number} forty-two\n */\nMyClass.prototype.getFoo = function (getIt) {\n  return getIt ? 42 : 0;\n};\n\n/**\n * Get undefined\n * @returns {undefined} does not return anything.\n */\nMyClass.prototype.getUndefined = function () { };\n"
           },
           "errors": [],
           "returns": [

test/fixture/es6.output.json

@@ -33,7 +33,7 @@
           "column": 31
         }
       },
-      "code": "var multiply = (a, b) => a * b;\n\nexport default multiply;"
+      "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nvar multiply = (a, b) => a * b;\n\nexport default multiply;\n"
     },
     "errors": [],
     "returns": [

test/fixture/event.output.json

@@ -50,7 +50,7 @@
     "context": {
       "loc": {
         "start": {
-          "line": 9,
+          "line": 1,
           "column": 0
         },
         "end": {

test/fixture/external.output.json

@@ -23,7 +23,7 @@
           "column": 1
         }
       },
-      "code": "require('external');\nrequire('external2');\nrequire('module-not-found');\n\n/**\n * I am in `external.input.js`.\n */\nfunction foo() {\n  'use strict';\n  return 'bar';\n}\n\nmodule.exports = foo;"
+      "code": "require('external');\nrequire('external2');\nrequire('module-not-found');\n\n/**\n * I am in `external.input.js`.\n */\nfunction foo() {\n  'use strict';\n  return 'bar';\n}\n\nmodule.exports = foo;\n"
     },
     "errors": [],
     "name": "foo",