merge in upstream

Author: 75lb

.eslintrc

@@ -52,7 +52,7 @@
         "no-eval": 2,
         "no-extra-bind": 2,
         "no-extend-native": 2,
-        "no-fallthrough": 2,
+        "no-fallthrough": 0, // disabled due to ESLint bug
         "no-floating-decimal": 2,
         "no-implied-eval": 2,
         "no-iterator": 2,

.travis.yml

@@ -1,7 +1,8 @@
 language: node_js
 
 node_js:
-  - "0.10"
-  - "0.12"
+  - "6"
+  - "5"
+  - "4"
 
 install: npm install -g gulp; npm install

CHANGES.md

@@ -3,6 +3,33 @@
 This file describes notable changes in each version of JSDoc 3. To download a specific version of JSDoc 3, see [GitHub's tags page](https://github.com/jsdoc3/jsdoc/tags).
 
 
+## 3.4.2 (October 2016)
+
++ Classes exported from an ES2015 module are now documented correctly. (#1137)
++ Fixed an issue that prevented plugins and templates from being loaded correctly. (#1259)
++ Fixed a crash when using the experimental object spread operator in assignments. (#1258)
+
+
+## 3.4.1 (September 2016)
+
+### Enhancements
++ When installing JSDoc from NPM, all dependencies are now pulled from NPM. (#961)
++ The configuration setting `tags.allowUnknownTags` may now contain an array of tag names that should be allowed. (#1159)
+
+### Bug fixes
++ When an ES2015 module's default export is a class, JSDoc now documents the class correctly. (#1113, #1120)
++ JSDoc no longer crashes when an ES2015 module exports an anonymous class. (#1113)
++ JSDoc no longer crashes when the experimental object spread operator is used. (#1141)
++ In ES2015 methods, JSDoc now autodetects whether a parameter is a default or repeatable parameter. (#1144)
++ The Markdown plugin now works correctly with inline tags that contain special characters, such as `{@link chat."#channel"}`. (#1035)
++ When JSDoc is run in a directory that has a `plugins/` or `templates/` directory, JSDoc can now discover plugins and templates in other directories. (#1081)
+
+### Templates
++ The default template now uses appropriate styles for displaying tables. (#1064)
++ The default template's CSS file no longer uses the same style for both `<h2>` and `<h3>` elements. (#1108)
++ JSDoc now includes a `silent` template that generates no output. This template makes it easier to use JSDoc as a linter to check for syntax errors and unrecognized tags in documentation comments. (#1160)
+
+
 ## 3.4.0 (November 2015)
 
 ### Major changes

cli.js

@@ -404,7 +404,7 @@ cli.resolveTutorials = function() {
 cli.generateDocs = function() {
     var path = require('jsdoc/path');
     var resolver = require('jsdoc/tutorial/resolver');
-    var taffy = require('taffydb-75lb').taffy;
+    var taffy = require('taffydb').taffy;
 
     var template;
 

lib/jsdoc/fs.js

@@ -7,7 +7,7 @@
 var fs = require('fs');
 var path = require('path');
 var stream = require('stream');
-var fse = require('fs-extra');
+var mkdirp = require('mkdirp');
 
 var ls = exports.ls = function(dir, recurse, _allFiles, _path) {
     var file;
@@ -91,7 +91,7 @@ exports.mkPath = function(_path) {
         _path = _path.join('');
     }
 
-    fse.mkdirsSync(_path);
+    mkdirp.sync(_path);
 };
 
 // adapted from http://procbits.com/2011/11/15/synchronous-file-copy-in-node-js
@@ -106,7 +106,7 @@ exports.copyFileSync = function(inFile, outDir, fileName) {
     var outFile = path.join( outDir, fileName || path.basename(inFile) );
     var pos = 0;
 
-    fse.mkdirsSync(outDir);
+    mkdirp.sync(outDir);
     read = fs.openSync(inFile, 'r');
     write = fs.openSync(outFile, 'w');
 

lib/jsdoc/src/astbuilder.js

@@ -75,36 +75,17 @@ var acceptsLeadingComments = (function() {
 // exported so we can use them in tests
 var parserOptions = exports.parserOptions = {
     comment: true,
-    loc: true,
-    range: true,
-    tokens: true,
     ecmaFeatures: {
-        arrowFunctions: true,
-        binaryLiterals: true,
-        blockBindings: true,
-        classes: true,
-        defaultParams: true,
-        destructuring: true,
         experimentalObjectRestSpread: true,
-        forOf: true,
-        generators: true,
         globalReturn: true,
-        jsx: true,
-        modules: true,
-        newTarget: true,
-        objectLiteralComputedProperties: true,
-        objectLiteralDuplicateProperties: true,
-        objectLiteralShorthandMethods: true,
-        objectLiteralShorthandProperties: true,
-        octalLiterals: true,
-        regexUFlag: true,
-        regexYFlag: true,
-        restParams: true,
-        spread: true,
-        superInFunctions: true,
-        templateStrings: true,
-        unicodeCodePointEscapes: true
-    }
+        impliedStrict: true,
+        jsx: true
+    },
+    ecmaVersion: 7,
+    loc: true,
+    range: true,
+    sourceType: 'module',
+    tokens: true
 };
 
 // TODO: docs

lib/jsdoc/src/astnode.js

@@ -134,6 +134,10 @@ var nodeToValue = exports.nodeToValue = function(node) {
             str = nodeToValue(node.left);
             break;
 
+        case Syntax.ClassDeclaration:
+            str = nodeToValue(node.id);
+            break;
+
         case Syntax.ExportAllDeclaration:
             // falls through
 

lib/jsdoc/src/handlers.js

@@ -20,7 +20,6 @@ var currentModule = null;
 var SCOPE_NAMES = jsdoc.name.SCOPE.NAMES;
 var SCOPE_PUNC = jsdoc.name.SCOPE.PUNC;
 var Syntax = jsdoc.src.syntax.Syntax;
-var unresolvedName = /^((?:module.)?exports|this)(\.|$)/;
 
 function CurrentModule(doclet) {
     this.doclet = doclet;

package.json

@@ -13,24 +13,24 @@
     "url": "https://github.com/jsdoc2md/jsdoc"
   },
   "dependencies": {
-    "async": "~1.5.2",
-    "bluebird": "~3.3.4",
+    "bluebird": "~3.4.6",
     "catharsis": "~0.8.8",
     "escape-string-regexp": "~1.0.5",
-    "espree": "~2.2.5",
+    "espree": "~3.1.7",
     "js2xmlparser": "~1.0.0",
-    "marked": "~0.3.5",
+    "klaw": "~1.3.0",
+    "marked": "~0.3.6",
+    "mkdirp": "~0.5.1",
     "requizzle": "~0.2.1",
     "strip-json-comments": "~2.0.1",
-    "taffydb-75lb": "^2.6.2",
-    "underscore": "~1.8.3",
-    "fs-extra": "~0.26.7"
+    "taffydb": "2.6.2",
+    "underscore": "~1.8.3"
   },
   "devDependencies": {
     "gulp": "~3.9.1",
-    "gulp-eslint": "~2.0.0",
+    "gulp-eslint": "~3.0.1",
     "gulp-json-editor": "~2.2.1",
-    "istanbul": "~0.4.2",
+    "istanbul": "~0.4.5",
     "tv4": "https://github.com/hegemonic/tv4/tarball/own-properties"
   },
   "engines": {

templates/default/README.md

@@ -1,4 +1,4 @@
-The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://documentcloud.github.com/underscore/#template).
+The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://underscorejs.org/).
 
 
 ## Generating Typeface Fonts

templates/default/publish.js

@@ -6,7 +6,7 @@ var fs = require('jsdoc/fs');
 var helper = require('jsdoc/util/templateHelper');
 var logger = require('jsdoc/util/logger');
 var path = require('jsdoc/path');
-var taffy = require('taffydb-75lb').taffy;
+var taffy = require('taffydb').taffy;
 var template = require('jsdoc/template');
 var util = require('util');
 

test/fixtures/exportclass.js

@@ -0,0 +1,8 @@
+/**
+ * Foo module
+ * @module foo
+ */
+
+/** Class description */
+export class Bar {
+}

test/spec-collection.js

@@ -3,7 +3,7 @@
 var fs = require('jsdoc/fs');
 var path = require('jsdoc/path');
 var runtime = require('jsdoc/util/runtime');
-var fse = require('fs-extra');
+var klaw = require('klaw');
 
 var specs = [];
 var finalSpecs = [];
@@ -81,7 +81,7 @@ exports.load = function(loadpath, matcher, clear, callback) {
     }
 
     var wannaBeSpecs = [];
-    fse.walk(loadpath)
+    klaw(loadpath)
       .on('data', function(spec) {
         wannaBeSpecs.push(spec.path);
       })

test/specs/documentation/exportclass.js

@@ -0,0 +1,15 @@
+'use strict';
+
+describe('export class', function() {
+    var docSet = jasmine.getDocSetFromFile('test/fixtures/exportclass.js');
+    var bar = docSet.getByLongname('module:foo.Bar')[0];
+
+    it('should name exported classes correctly', function() {
+        expect(bar).toBeDefined();
+        expect(bar.name).toBe('Bar');
+    });
+
+    it('should merge the class description with the doclet for the class', function() {
+        expect(bar.classdesc).toBe('Class description');
+    });
+});

test/specs/jsdoc/util/templateHelper.js

@@ -12,7 +12,7 @@ describe("jsdoc/util/templateHelper", function() {
     var helper = require('jsdoc/util/templateHelper');
     var logger = require('jsdoc/util/logger');
     var resolver = require('jsdoc/tutorial/resolver');
-    var taffy = require('taffydb-75lb').taffy;
+    var taffy = require('taffydb').taffy;
 
     helper.registerLink('test', 'path/to/test.html');