Support new node versions, including v4 and v5

* Compare strings as lowercase, to permit for v4+ compatibility
* Fix bad reference to loc.name
* Update README badge and fixture
* Remove brfs dependency
* Remove traverse
* Remove browser transform support

Author: tmcw

README.md

@@ -1,6 +1,7 @@
 # documentation
 
-[![Build Status](https://circleci.com/gh/documentationjs/documentation.svg?style=svg)](https://circleci.com/gh/documentationjs/documentation) [![Coverage Status](https://coveralls.io/repos/documentationjs/documentation/badge.svg?branch=master)](https://coveralls.io/r/documentationjs/documentation?branch=master)
+[![Circle CI](https://circleci.com/gh/documentationjs/documentation/tree/master.svg?style=svg)](https://circleci.com/gh/documentationjs/documentation/tree/master)
+[![Coverage Status](https://coveralls.io/repos/documentationjs/documentation/badge.svg?branch=master)](https://coveralls.io/r/documentationjs/documentation?branch=master)
 [![npm version](https://badge.fury.io/js/documentation.svg)](http://badge.fury.io/js/documentation)
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/documentationjs/documentation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 

circle.yml

@@ -0,0 +1,13 @@
+machine:
+  node:
+    version: 0.10.33
+
+dependencies:
+  override:
+    - 'nvm install 5 && nvm use 5 && npm update -g npm'
+    - 'nvm install 0.10 && nvm use 0.10 && npm update -g npm'
+
+test:
+  override:
+    - 'nvm use 5 && rm -rf node_modules && npm install && npm test'
+    - 'nvm use 0.10 && rm -rf node_modules && npm install && npm test'

docs/NODE_API.md

@@ -93,10 +93,6 @@ comments, given a root file as a path.
     -   `options.external` **Array<string>** a string regex / glob match pattern
         that defines what external modules will be whitelisted and included in the
         generated documentation.
-
-    -   `options.transform` **Array<string>** source transforms given as strings
-        passed to [the module-deps transform option](https://github.com/substack/module-deps)
-
     -   `options.polyglot` **[boolean]** parse comments with a regex rather than
         a proper parser. This enables support of non-JavaScript languages but
         reduces documentation's ability to infer structure of code.

index.js

@@ -62,8 +62,6 @@ function expandInputs(indexes, options, callback) {
  * @param {Array<string>} options.external a string regex / glob match pattern
  * that defines what external modules will be whitelisted and included in the
  * generated documentation.
- * @param {Array<string>} options.transform source transforms given as strings
- * passed to [the module-deps transform option](https://github.com/substack/module-deps)
  * @param {boolean} [options.polyglot=false] parse comments with a regex rather than
  * a proper parser. This enables support of non-JavaScript languages but
  * reduces documentation's ability to infer structure of code.
@@ -130,8 +128,6 @@ module.exports = function (indexes, options, callback) {
  * @param {Array<string>} options.external a string regex / glob match pattern
  * that defines what external modules will be whitelisted and included in the
  * generated documentation.
- * @param {Array<string>} options.transform source transforms given as strings
- * passed to [the module-deps transform option](https://github.com/substack/module-deps)
  * @param {boolean} [options.polyglot=false] parse comments with a regex rather than
  * a proper parser. This enables support of non-JavaScript languages but
  * reduces documentation's ability to infer structure of code.

lib/args.js

@@ -117,18 +117,14 @@ module.exports = function (args) {
     command = argv._[0],
     inputs = argv._.slice(1),
     name = argv.name,
-    version = argv['project-version'],
-    transform;
+    version = argv['project-version'];
 
   if (inputs.length == 0) {
     try {
       var p = require(path.resolve('package.json'));
       inputs = [p.main || 'index.js'];
       name = name || p.name;
       version = version || p.version;
-      if (p.browserify && p.browserify.transform) {
-        transform = p.browserify.transform;
-      }
     } catch (e) {
       yargs.showHelp();
       throw new Error('documentation was given no files and was not run in a module directory');
@@ -155,7 +151,6 @@ module.exports = function (args) {
     command: command,
     options: {
       private: argv.private,
-      transform: transform,
       github: argv.github,
       polyglot: argv.polyglot,
       order: config.order || [],

lib/infer/params.js

@@ -63,7 +63,7 @@ module.exports = function () {
       var newParam = {
         title: 'param',
         name: param.argument.name,
-        lineNumber: param.loc.start.name,
+        lineNumber: param.loc.start.line,
         type: {
           type: 'RestType'
         }

lib/sort.js

@@ -45,5 +45,5 @@ module.exports = function sortDocs(order, a, b) {
     return 1;
   }
 
-  return a.localeCompare(b);
+  return a.toLowerCase().localeCompare(b.toLowerCase());
 };

package.json

@@ -6,20 +6,11 @@
   "bin": {
     "documentation": "./bin/documentation.js"
   },
-  "browserify": {
-    "transform": [
-      "brfs"
-    ]
-  },
-  "browser": {
-    "vinyl-fs": false
-  },
   "dependencies": {
     "ansi-html": "0.0.5",
     "ast-types": "^0.8.12",
     "babel-core": "^5.0.0",
     "babelify": "^6.3.0",
-    "brfs": "^1.4.0",
     "chokidar": "^1.2.0",
     "concat-stream": "^1.5.0",
     "debounce": "^1.0.0",
@@ -47,7 +38,6 @@
     "stream-array": "^1.1.0",
     "strip-json-comments": "^1.0.2",
     "tiny-lr": "^0.2.1",
-    "traverse": "^0.6.6",
     "unist-builder": "^1.0.0",
     "vfile": "^1.1.2",
     "vfile-reporter": "^1.4.1",
@@ -61,7 +51,7 @@
     "eslint": "^1.5.1",
     "glob": "^5.0.2",
     "lodash": "^3.10.1",
-    "mock-fs": "^3.2.0",
+    "mock-fs": "^3.5.0",
     "tap": "^2.2.0"
   },
   "keywords": [

test/fixture/es6-import.output.json

@@ -329,6 +329,7 @@
       {
         "title": "param",
         "name": "someParams",
+        "lineNumber": 43,
         "type": {
           "type": "RestType"
         }
@@ -375,6 +376,7 @@
       {
         "title": "param",
         "name": "someParams",
+        "lineNumber": 49,
         "type": {
           "type": "RestType",
           "expression": {

test/fixture/es6.output.json

@@ -329,6 +329,7 @@
       {
         "title": "param",
         "name": "someParams",
+        "lineNumber": 43,
         "type": {
           "type": "RestType"
         }
@@ -375,6 +376,7 @@
       {
         "title": "param",
         "name": "someParams",
+        "lineNumber": 49,
         "type": {
           "type": "RestType",
           "expression": {

test/fixture/flow-types.output.custom.md

@@ -1,3 +1,18 @@
+# addThem
+
+This function returns the number one.
+
+**Parameters**
+
+-   `a` **Point** 
+-   `b` **string** 
+-   `c` **[boolean]** 
+-   `d` **Array<number>** 
+-   `e` **Object** 
+-   `f` **Named** 
+
+Returns **number** 
+
 # Point
 
 A 2D point.
@@ -25,21 +40,6 @@ A type with entirely derived properties
 -   `x` **number** 
 -   `y` **number** 
 
-# addThem
-
-This function returns the number one.
-
-**Parameters**
-
--   `a` **Point** 
--   `b` **string** 
--   `c` **[boolean]** 
--   `d` **Array<number>** 
--   `e` **Object** 
--   `f` **Named** 
-
-Returns **number** 
-
 # veryImportantTransform
 
 Very Important Transform