docdown - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

index.js

 /*!
- * docdown v0.2.1
+ * docdown v0.3.0
  * Copyright 2011-2015 John-David Dalton <http://allyoucanleet.com/>
@@ -24,2 +24,3 @@ * Available under MIT license <http://mths.be/mit>
     'lang': 'js',
+    'sort': true,
     'title': path.basename(options.path) + ' API documentation',
@@ -26,0 +27,0 @@ 'toc': 'properties'

lib/entry.js

@@ -94,5 +94,5 @@ 'use strict';
 
-      result = _.map(result, function(value) {
+      result = _.map(result, _.bind(function(value) {
         return new Alias(value, this);
-      }, this);
+      }, this));
     }
@@ -364,3 +364,3 @@ this._aliases = result;
     var match,
-        re = /@param\s+\{\(?([^})]+)\)?\}\s+(\[.+\]|[\w]+(?:\[.+\])?)\s+([\s\S]*?)(?=\@)/gim,
+        re = /@param\s+\{\(?([^})]+)\)?\}\s+(\[.+\]|[\w]+(?:\[.+\])?)\s+([\s\S]*?)(?=\@|\*\/)/gim,
         result = [];
@@ -367,0 +367,0 @@

lib/generator.js

@@ -130,2 +130,3 @@ 'use strict';
       organized = {},
+      sortEntries = options.sort,
       url = options.url;
@@ -264,8 +265,11 @@
   if (byCategories) {
-    // Remove special categories.
-    _.pull.apply(_, [tocGroups].concat(specialCategories));
+    // Remove special categories before sorting.
+    var catogoriesUsed = _.intersection(tocGroups, specialCategories);
+    _.pull.apply(_, [tocGroups].concat(catogoriesUsed));
 
-    // Sort categories and append special categories.
-    tocGroups.sort(util.compareNatural);
-    push.apply(tocGroups, specialCategories);
+    // Sort categories and add special categories back.
+    if (sortEntries) {
+      tocGroups.sort(util.compareNatural);
+    }
+    push.apply(tocGroups, catogoriesUsed);
   }
@@ -283,3 +287,3 @@ else {
 
-    if (organized[group]) {
+    if (sortEntries && organized[group]) {
       // Sort the TOC groups.
@@ -286,0 +290,0 @@ organized[group].sort(function(value, other) {

package.json

 {
   "name": "docdown",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "A simple JSDoc to Markdown documentation generator.",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -1,2 +0,2 @@
-# docdown v0.2.1
+# docdown v0.3.0
 
@@ -3,0 +3,0 @@ A simple JSDoc to Markdown documentation generator.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34059

increased by0.57%

Lines of code

1025

increased by0.49%

No dependency changes