Merge branch 'edge'

Author: neogeek

.gitignore

@@ -1 +1,2 @@
 node_modules/
+templates/bootstrap.min.js

CHANGELOG.md

@@ -1,5 +1,12 @@
 #Changelog
 
+##0.0.5 (August 17, 2014)
+
+- Added support for crawling directories.
+- Added support for pulling title and description from package.json files.
+- Added "Back to Top" link.
+- Minor visual changes.
+
 ##0.0.4 (August 10, 2014)
 
 - Improved Node.js support with the addition of a new method: parseFile.

README.md

@@ -15,23 +15,26 @@ $ npm install doxdox -g
 ##Usage
 
 ```bash
- Usage: doxdox <file> [options]
+ Usage: doxdox <path> [options]
 
  Options:
 
- -h, --help     Display this help message.
- -v, --version      Display the current installed version.
- -t, --title        Sets title.
- -d, --description  Sets description.
- -l, --layout       Template to render the documentation with.
- -o, --output       File to save documentation to. Default to stdout.
+  -h, --help        Display this help message.
+  -v, --version     Display the current installed version.
+  -t, --title       Sets title.
+  -d, --description Sets description.
+  -l, --layout      Template to render the documentation with.
+  -p, --package Sets location of package.json file.
+  -o, --output      File to save documentation to. Defaults to stdout.
 
  Available Layouts:
 
- - Bootstrap (default)      (http://getbootstrap.com/)
- - Markdown         (http://daringfireball.net/projects/markdown/)
+  - Bootstrap (default)   (http://getbootstrap.com/)
+  - Markdown          (http://daringfireball.net/projects/markdown/)
 ```
 
 ##Examples:
 
-- [Facade.js Documentation](http://docs.facadejs.com/)
+- [Facade.js](http://facadejs.com/) - [Documentation](http://docs.facadejs.com/)
+- [plastick.js](https://github.com/syntaxtsb/plastick.js) - [Documentation](http://doxdox.org/syntaxtsb/plastick.js)
+- [CanvasToVideo](https://github.com/neogeek/CanvasToVideo) - [Documentation](http://doxdox.org/neogeek/CanvasToVideo)

bin/doxdox

@@ -1,32 +1,31 @@
 #!/usr/bin/env node
 
-var pkg = require('../package'),
+var fs = require('fs'),
+    path = require('path'),
     chalk = require('chalk'),
     doxdox = require('..');
 
 var config = {
-    title: 'Untitled Project',
+    title: '',
     description: '',
     layout: 'bootstrap'
 };
 
-var file = '',
-    output = '';
+var input = process.cwd(),
+    output,
+    pkg;
 
-var args = process.argv.slice(2),
-    value;
+var args = process.argv.slice(2);
 
 if (args.length && !args[0].match(/^\-/)) {
 
-    file = args.shift();
+    input = args.shift();
 
 }
 
 while (args.length) {
 
-    value = args.shift();
-
-    switch (value) {
+    switch (args.shift()) {
 
     case '-t':
     case '--title':
@@ -43,27 +42,33 @@ while (args.length) {
         config.layout = args.shift();
         break;
 
+    case '-p':
+    case '--package':
+        pkg = args.shift();
+        break;
+
     case '-o':
     case '--output':
         output = args.shift();
         break;
 
     case '-v':
     case '--version':
-        process.stdout.write(pkg.version + '\n');
+        process.stdout.write(require('../package').version + '\n');
         process.kill();
         break;
 
     default:
         process.stdout.write('\n');
-        process.stdout.write(chalk.blue(' Usage:') + ' doxdox <file> [options]' + '\n\n');
+        process.stdout.write(chalk.blue(' Usage:') + ' doxdox <path> [options]' + '\n\n');
         process.stdout.write(' Options:' + '\n\n');
         process.stdout.write(chalk.yellow('  -h, --help') + '\t\tDisplay this help message.' + '\n');
         process.stdout.write(chalk.yellow('  -v, --version') + '\t\tDisplay the current installed version.' + '\n');
         process.stdout.write(chalk.yellow('  -t, --title') + '\t\tSets title.' + '\n');
         process.stdout.write(chalk.yellow('  -d, --description') + '\tSets description.' + '\n');
         process.stdout.write(chalk.yellow('  -l, --layout') + '\t\tTemplate to render the documentation with.' + '\n');
-        process.stdout.write(chalk.yellow('  -o, --output') + '\t\tFile to save documentation to. Default to stdout.' + '\n');
+        process.stdout.write(chalk.yellow('  -p, --package') + '\tSets location of package.json file.' + '\n');
+        process.stdout.write(chalk.yellow('  -o, --output') + '\t\tFile to save documentation to. Defaults to stdout.' + '\n');
         process.stdout.write('\n');
         process.stdout.write(' Available Layouts:' + '\n\n');
         process.stdout.write('  - Bootstrap (default)\t  (http://getbootstrap.com/)' + '\n');
@@ -76,4 +81,46 @@ while (args.length) {
 
 }
 
-doxdox.parseFile(file, output, config);
+var stat;
+
+if (!pkg && fs.existsSync(input)) {
+
+    stat = fs.statSync(input);
+
+    if (stat.isDirectory()) {
+
+        pkg = path.normalize(input + '/package.json');
+
+    } else if (stat.isFile()) {
+
+        pkg = path.normalize(path.dirname(input) + '/package.json');
+
+    }
+
+}
+
+if (fs.existsSync(pkg)) {
+
+    pkg = require(pkg);
+
+    if (pkg.name && !config.title) {
+
+        config.title = pkg.name;
+
+    }
+
+    if (pkg.description && !config.description) {
+
+        config.description = pkg.description;
+
+    }
+
+}
+
+if (!config.title) {
+
+    config.title = 'Untitled Project';
+
+}
+
+doxdox.parseInput(input, output, config);

lib/doxdox.js

@@ -1,4 +1,5 @@
 var fs = require('fs'),
+    path = require('path'),
     dox = require('dox'),
     hbs = require('handlebars'),
     helpers = require('../lib/helpers')(hbs),
@@ -9,31 +10,72 @@ var templates = {
     markdown: require('../templates/markdown.hbs')
 };
 
-exports.parseFile = function (file, output, config) {
+exports.parseInput = function (input, output, config) {
 
-    if (fs.existsSync(file)) {
+    var files = [],
+        stat;
 
-        return exports.parseScript(fs.readFileSync(file, 'utf8'), output, config);
+    if (fs.existsSync(input)) {
+
+        stat = fs.statSync(input);
+
+        if (stat.isDirectory()) {
+
+            utils.walk(input).forEach(function (file) {
+
+                files.push({
+                    name: file.replace(input, '').replace(/^\//, ''),
+                    contents: fs.readFileSync(file, 'utf8')
+                });
+
+            });
+
+        } else if (stat.isFile()) {
+
+            files.push({
+                name: path.basename(input),
+                contents: fs.readFileSync(input, 'utf8')
+            });
+
+        }
 
     } else {
 
-        process.stdout.write('File not found.' + '\n');
+        process.stdout.write('File or directory not found.' + '\n');
+        process.kill();
 
     }
 
-}
+    return exports.parseScripts(files, output, config);
 
-exports.parseScript = function (script, output, config) {
+};
 
-    var content,
-        data = dox.parseComments(script);
+exports.parseScripts = function (scripts, output, config) {
+
+    var files = [],
+        content;
+
+    scripts.forEach(function (script) {
+
+        var methods = dox.parseComments(script.contents);
+
+        if (methods) {
+
+            files.push({
+                name: script.name,
+                methods: utils.parseData(methods, script.name)
+            });
+
+        }
+
+    });
 
     if (templates[config.layout]) {
 
         content = templates[config.layout]({
             title: config.title,
             description: config.description,
-            methods: utils.parseData(data)
+            files: files
         });
 
         if (output) {
@@ -44,10 +86,10 @@ exports.parseScript = function (script, output, config) {
 
             process.stdout.write(content);
 
-            return content;
-
         }
 
+        return content;
+
     } else {
 
         process.stdout.write('Invalid layout specified.' + '\n');

lib/helpers.js

@@ -6,10 +6,6 @@ module.exports = function (hbs) {
         return a === b ? options.fn(this) : options.inverse(this);
     });
 
-    hbs.registerHelper('formatId', function (name) {
-        return String(name).toLowerCase().replace(/[^\w\.]+/g, '');
-    });
-
     hbs.registerHelper('formatName', function (name) {
         return String(name).replace(/\.prototype/g, '');
     });

lib/utils.js

@@ -1,7 +1,27 @@
-module.exports.parseData = function (data) {
+var fs = require('fs'),
+    path = require('path');
+
+module.exports.formatStringForUID = function (content) {
+
+    content = String(content).toLowerCase();
+
+    content = content.replace(/[^\w\.]+/g, '-');
+    content = content.replace(/^-|-$/g, '');
+
+    return content;
+
+};
+
+module.exports.parseData = function (data, file) {
 
     data.forEach(function (methods) {
 
+        if (methods.ctx) {
+
+            methods.ctx.uid = file + '-' + module.exports.formatStringForUID(methods.ctx.string);
+
+        }
+
         if (methods.tags) {
 
             methods.tags.forEach(function (tag) {
@@ -30,3 +50,47 @@ module.exports.parseData = function (data) {
     return data;
 
 };
+
+module.exports.walk = function (dir, opts) {
+
+    var files = [];
+
+    if (!opts) {
+        opts = {};
+    }
+
+    if (!opts.match) {
+        opts.match = /\.js$/;
+    }
+
+    if (!opts.exception) {
+        opts.exception = /\.git|\.min|node_modules|test|gruntfile/i;
+    }
+
+    if (fs.existsSync(dir) && fs.statSync(dir).isDirectory()) {
+
+        fs.readdirSync(dir).forEach(function (file) {
+
+            var stat;
+
+            file = path.normalize(dir + '/' + file);
+
+            stat = fs.statSync(file);
+
+            if (stat.isDirectory() && !file.match(opts.exception)) {
+
+                files = files.concat(module.exports.walk(file, opts));
+
+            } else if (stat.isFile() && file.match(opts.match) && !file.match(opts.exception)) {
+
+                files.push(file);
+
+            }
+
+        });
+
+    }
+
+    return files;
+
+};

package.json

@@ -1,7 +1,7 @@
 {
     "name": "doxdox",
     "description": "HTML and Markdown documentation generator.",
-    "version": "0.0.4",
+    "version": "0.0.5",
     "bin": "./bin/doxdox",
     "license": "MIT",
     "dependencies": {