sassdoc - npm Package Compare versions

Comparing version 1.5.0-rc.1 to 1.5.0

CHANGELOG.md

 # Changelog
 
+## 1.5.0
+
+* Added `@prop` to allow deeper documentation for maps ([#25](https://github.com/SassDoc/sassdoc/issues/25))
+* Fixed circular JSON dependencies when using raw data ([#181](https://github.com/SassDoc/sassdoc/issues/181))
+* Added an option to provide a custom shortcut icon to the view ([#178](https://github.com/SassDoc/sassdoc/issues/178))
+
 ## 1.4.1
@@ -4,0 +10,0 @@

package.json

@@ -20,3 +20,3 @@ {
   ],
-  "version": "1.5.0-rc.1",
+  "version": "1.5.0",
   "license": {
@@ -45,3 +45,3 @@ "type": "MIT",
   "dependencies": {
-    "sassdoc-theme-default": "1.4.0-rc.1",
+    "sassdoc-theme-default": "^1.4.0",
     "q": "^1.0.1",
@@ -48,0 +48,0 @@ "rimraf": "~2.2.8",

src/annotation/annotations/requires.js

@@ -52,2 +52,8 @@ 'use strict';
               reqItem.usedBy = [];
+              reqItem.usedBy.toJSON = utils.mapArray.bind(null, reqItem.usedBy, function(item){
+                return {
+                  description : item.description,
+                  context : item.context
+                };
+              });
             }
@@ -65,2 +71,17 @@ reqItem.usedBy.push(item);
         });
+
+        item.requires.toJSON = utils.mapArray.bind(null, item.requires, function(item){
+          var obj = {
+            type : item.type,
+            name : item.name,
+            external : item.external,
+          };
+          if ( item.external ){
+            obj.url  = item.url;
+          } else {
+            obj.description = item.description;
+            obj.context = item.context;
+          }
+          return obj;
+        });
       }
@@ -67,0 +88,0 @@ });

src/annotation/annotations/see.js

@@ -33,2 +33,9 @@ 'use strict';
         });
+
+        item.see.toJSON = utils.mapArray.bind(null, item.see, function(item){
+          return {
+            description : item.description,
+            context : item.context
+          };
+        });
       }
@@ -35,0 +42,0 @@ });

src/api.js

@@ -48,4 +48,3 @@ 'use strict';
         logger.log('Process over. Everything okay!');
-      })
-      .fail(function (err) {
+      }, function (err) {
         logger.error('stack' in err ? err.stack : err);
@@ -52,0 +51,0 @@ throw err;

src/utils.js

@@ -11,2 +11,7 @@ 'use strict';
 
+  mapArray : function(array, callback){
+    var copy = array.slice();
+    return copy.map(callback);
+  },
+
   eachItem: function (byTypeAndName, callback) {
@@ -13,0 +18,0 @@ _.each(byTypeAndName, function (typeObj) {

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

654912

increased by0.32%

Lines of code

2102

increased by1.4%

Number of low quality alerts

0

decreased by-100%

Dependency changes

• + Addedsassdoc-extras@1.0.3(transitive)

• + Addedsassdoc-theme-default@1.7.4(transitive)

• + Addedthemeleon@1.0.4(transitive)

• - Removedsassdoc-filter@1.2.0-rc.1(transitive)

• - Removedsassdoc-indexer@0.0.21.1.1(transitive)

• - Removedsassdoc-theme-default@1.4.0-rc.1(transitive)

• - Removedsassdoc-theme-light@1.4.0-rc.1(transitive)

• Updatedsassdoc-theme-default@^1.4.0