doxstrap - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

lib/options.js

@@ -21,3 +21,3 @@ var optimist = require('optimist'),
 optimist.default('s', 'src/**/*.js');
-optimist.describe('s', 'Source files');
+optimist.describe('s', 'Source files, accepts multiple patterns with the OS path separator');
 
@@ -31,2 +31,11 @@ optimist.alias('o', 'output');
 
+optimist.default('sort', 'title');
+optimist.describe('sort', 'Sort order (default: "title")');
+
+optimist.describe('no-sort', 'Do not sort output');
+
+optimist.alias('l', 'layout');
+optimist.default('l', 'default.html');
+optimist.describe('l', 'Template layout');
+
 module.exports = {
@@ -33,0 +42,0 @@ version: function() {

lib/render.js

@@ -1,2 +0,2 @@
-var gs = require('glob-stream');
+var gs = require('glob-stream'),
     path = require('path'),
@@ -19,11 +19,13 @@ _ = require('lodash'),
 
-var templatePath = path.resolve(__dirname, '..', 'template', 'default.html'),
-    template = fs.readFileSync(templatePath, {encoding: 'utf8'}),
-    tpl = Handlebars.compile(template);
-
 module.exports = function(options) {
 
-    var stream = gs.create([options.source]),
+    var templatePath = path.resolve(__dirname, '..', 'template', options.layout),
+        template = fs.readFileSync(templatePath, {encoding: 'utf8'}),
+        tpl = Handlebars.compile(template);
+
+    var sources = options.source.split(path.delimiter),
+        stream = gs.create(sources),
         files = [],
-        docs = {};
+        docs = {},
+        sortKey = options['no-sort'] ? false : options.sort;
 
@@ -99,3 +101,3 @@ return new Promise(function(resolve, reject) {
                     title: options.title,
-                    docs: _.sortBy(filteredDocs, 'title')
+                    docs: sortKey ? _.sortBy(filteredDocs, sortKey) : filteredDocs
                 }));
@@ -102,0 +104,0 @@

package.json

 {
   "name": "doxstrap",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "JavaScript documentation generator based on JSDoc syntax, Dox parser, Twitter Bootstrap CSS, and Prism syntax highlighter",
@@ -23,3 +23,2 @@ "keywords": [],
     "glob-stream": "~3.1.9",
-    "chalk": "~0.4.0",
     "mkdirp": "~0.3.5",
@@ -26,0 +25,0 @@ "cpr": "~0.1.1",

No alert changes

Improved metrics

Total package byte prevSize

149718

increased by8.56%

Dependency count

9

decreased by-10%

Number of package files

14

increased by7.69%

Lines of code

370

increased by2.21%

Dependency changes

• - Removedchalk@~0.4.0

• - Removedansi-styles@1.0.0(transitive)

• - Removedchalk@0.4.0(transitive)

• - Removedstrip-ansi@0.1.1(transitive)